Gestionar leads

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

Actualizar información de contacto

Actualiza el correo electrónico o el teléfono del solicitante.

Información de la solicitud

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

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

Ejemplo con cURL

curl --location --request PUT '{{auto_equity_base_url}}/api/leads/{{leadId}}/contact' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone" : 9511001687,
    "email" : "creditas@creditas.com"
}'

Estado de respuesta

El servicio responde con 204 No Content.

Posibles errores

Consulta los posibles errores aquí.

Consultar información de un lead

Utiliza este endpoint para consultar un lead específico.

Información de la solicitud

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

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
id	String UUID	Identificador del lead.
contact	Object	Correo electrónico y teléfono del solicitante.
createdAt	String	Fecha y hora de creación del lead.
updatedAt	String	Fecha y hora de la última actualización del lead.
loanInformation	Object	Plazo y loanAmount solicitados.
personalInformation	Object Admite null.	firstName, secondName, lastName, secondLastName, birthDate y rfc del solicitante. Consulta guardar información personal.
address	Object Admite null.	Domicilio del solicitante, incluidos street, number, interior, zipCode y neighborhood, además de municipality, city y state del catálogo de códigos postales.
auto	Object Admite null.	id, brandName, modelName, year y price del vehículo.
financialInformation	Object Admite null.	employmentType y monthlyIncome del solicitante. Consulta el endpoint de información financiera.
nipConfirmationDate	String Admite null.	Fecha y hora en que el solicitante autorizó la consulta de su historial crediticio. Consulta solicitar una oferta.
status	String	INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
preApprovingResult	String Admite null.	Uno o más resultados de preevaluación: APPROVED, MANUAL_REVIEW, REJECTED
isComplete	Boolean	Indica si el lead tiene información personal, domicilio, vehículo y NIP confirmado.
isPq	Boolean	Indica si el lead aprobó la preevaluación.

Ejemplo de respuesta

{
    "id": "c8a66afe-640d-4492-b327-90e02d2b012d",
    "contact": {
        "email": "pq-approved@creditas.com",
        "phone": "9128463859"
    },
    "createdAt": "2023-10-19T15:08:36.211789",
    "updatedAt": "2023-10-19T15:10:29.797814",
    "loanInformation": {
        "term": 24,
        "loanAmount": 120000
    },
    "personalInformation": {
        "firstName": "Javier",
        "secondName": "",
        "lastName": "Solis",
        "secondLastName": "Guzman",
        "birthDate": "1993-04-26",
        "rfc": "TEUR9010199I4"
    },
    "address": {
        "street": "Margarita Maza de Juárez",
        "number": "43",
        "interior": "A",
        "zipCode": "09440",
        "neighborhood": "El Retoño",
        "municipality": "Iztapalapa",
        "city": "Ciudad de México",
        "state": {
            "id": "CDMX",
            "name": "CIUDAD DE MÉXICO"
        }
    },
    "auto": {
        "id": "2020910528260",
        "brandName": "Acura",
        "modelName": "ILX",
        "year": 2020
    },
    "financialInformation": {
        "employmentType": "RETIRED",
        "monthlyIncome": 5000
    },
    "nipConfirmationDate": null,
    "isComplete": false,
    "isPq": false
}

Posibles errores

Consulta los posibles errores aquí.

Listar leads

Utiliza este endpoint para consultar tus leads.

Información de la solicitud

Método HTTP	URL
GET	{{auto_equity_base_url}}/api/leads

Parámetros de consulta

Nombre	Ejemplo	Descripción
name	username	Busca leads cuyo nombre contenga este valor.
rfc	SOGJ930426EKA	Filtra por un RFC exacto.
status	COMPLETE	Filtra por uno o más estados: INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
preApprovingResult	MANUAL_REVIEW	Uno o más resultados de preevaluación: APPROVED, MANUAL_REVIEW, REJECTED
email	email@gmail.com	Filtra por un correo electrónico exacto.
createdFrom	2023-11-01T09:30:00	Devuelve leads creados después de esta fecha y hora en formato yyyy-MM-dd'T'HH:mm:ss.
createdTo	2023-11-01T09:30:00	Devuelve leads creados antes de esta fecha y hora en formato yyyy-MM-dd'T'HH:mm:ss.
sort	updatedAt,desc	Ordena por createdAt o updatedAt, seguido de la dirección y separado por una coma.
page	number	Página de resultados. Valor predeterminado: 1.
size	number	Tamaño de página. Valor predeterminado: 20.

Ejemplo con cURL

curl --location '{{auto_equity_base_url}}/api/leads?sort=updatedAt%2Cdesc&size=3&page=4' \
--header 'Authorization: Bearer {{access_token}}' \

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
content.id	String UUID	Identificador del lead.
content.fullName	String	Nombre completo del solicitante.
content.rfc	String Admite null.	RFC del solicitante.
content.status	String	INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
content.email	String	Correo electrónico del solicitante.
content.phone	String	Teléfono del solicitante.
content.loanAmount	Number Admite null.	Monto solicitado.
content.preApprovingResult	String Admite null.	APPROVED, MANUAL_REVIEW, REJECTED
content.createdAt	String	Fecha y hora de creación del lead.
content.updatedAt	String	Fecha y hora de la última actualización del lead.
content.isComplete	Boolean	Indica si el lead tiene información personal, domicilio, vehículo y NIP confirmado.
content.isPq	Boolean	Indica si el lead aprobó la preevaluación.

Ejemplo de respuesta

{
  "content": [
    {
      "id": "86b7fd6a-1d6d-4a81-b474-8b0dab435adb",
      "fullName": "Javier Solis Guzman",
      "rfc": "BUWY900905XO5",
      "status": "COMPLETE",
      "email": "pq-approved@creditas.com",
      "phone": "9128463859",
      "loanAmount": 120000.0,
      "preApprovingResult": "APPROVED",
      "createdAt": "2023-12-20T22:04:17.722156",
      "updatedAt": "2023-12-21T18:26:23.601086",
      "isComplete": true,
      "isPq": false
    }
  ],
  "empty": false,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 1,
  "size": 20,
  "sorted": true,
  "totalElements": 1,
  "totalPages": 1
}

Posibles errores

Consulta los posibles errores aquí.