Crear un lead

En los ejemplos, {{auto_equity_base_url}} representa la URL base de Auto Equity del entorno seleccionado.

El primer paso es llamar al endpoint para crear un lead:

Información de la solicitud

Método HTTP	URL	Ejemplo
POST	{{auto_equity_base_url}}/api/leads	https://stg-api.creditas.io/mx/b2b/autoequity/api/leads

Cuerpo de la solicitud

Campo	Tipo	Descripción
phone	String	Número telefónico de 10 dígitos del solicitante. Solo se aceptan números de México. Ej.: “9512138126”
email	String	Correo electrónico del solicitante. Ej.: pq-approved@creditas.com
loanAmount	number	Monto solicitado en MXN. Ej.: 120000
term	number	Número de mensualidades. Valores permitidos: 24, 36, 48 o 60. Ej.: 24

Correos de prueba para staging

Utiliza uno de estos correos para evitar la consulta de un historial crediticio real:

Correo electrónico	Resultado de la preevaluación
pq-approved@creditas.com	APPROVED
pq-manual-review@creditas.com	MANUAL_REVIEW
pq-direct-rejected@creditas.com	REJECTED

Estado de respuesta

El servicio responde con 201 Created y el siguiente cuerpo:

Cuerpo de la respuesta

Campo	Tipo	Descripción
id	UUID (String)	Identificador del lead. Utilízalo en las solicitudes posteriores como {{leadId}}. Ej.: “2341b2c8-8e84-4a5a-aac6-9dda4410e999”

Ejemplo con cURL

curl --location --request POST '{{auto_equity_base_url}}/api/leads' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone": "9128463859",
    "email" : "pq-approved@creditas.com",
    "loanAmount" : 120000,
    "term" : 24
}'

Posibles errores

Consulta los posibles errores aquí.

Guardar información personal

Después de crear el lead, guarda la información personal del solicitante.

Información de la solicitud

Método HTTP	URL	Ejemplo
POST	{{auto_equity_base_url}}/api/leads/{{leadId}}/person	https://stg-api.creditas.io/mx/b2b/autoequity/api/leads/2341b2c8-8e84-4a5a-aac6-9dda4410e999/person

Cuerpo de la solicitud

Campo	Tipo	Descripción
firstName	String	Primer nombre del solicitante. Ej.: “Javier”
secondName	String	Segundo nombre del solicitante. Omite este campo cuando no corresponda. Ej.: “Jair”
lastName	String	Primer apellido del solicitante. Ej.: “Gonzalez”
secondLastName	String	Segundo apellido del solicitante. Ej.: “Gonzales”
birthDate	String	Fecha de nacimiento del solicitante en formato yyyy-mm-dd. Ej.: “1993-11-28”
rfc	String	RFC del solicitante. Ej.: “GOGJ931128C83”

Estado de respuesta

El servicio responde con 204 No Content y un cuerpo vacío.

Ejemplo con cURL

curl --location --request POST '{{auto_equity_base_url}}/api/leads/{{leadId}}/person' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Javier",
    "secondName": "Jair",
    "lastName": "Gonzalez",
    "secondLastName": "Gonzales",
    "birthDate": "1993-11-28",
    "rfc": "GOGJ931128C83"
}'

Posibles errores

Consulta los posibles errores aquí.