Gestionar leads

En los ejemplos, {{auto_financing_base_url}} representa la URL base de Auto Financing 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_financing_base_url}}/api/leads/{{leadId}}/contact	https://stg-api.creditas.io/mx/b2b/autofin/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_financing_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_financing_base_url}}/api/leads/{{leadId}}	https://stg-api.creditas.io/mx/b2b/autofin/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	term, downPayment y purchaseIntention de la solicitud.
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, monthlyIncome, jobPosition y startDate 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.
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,
        "downPayment": 30000.0,
        "purchaseIntention": null
    },
    "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,
        "price": 300000.0
    },
    "financialInformation": {
        "employmentType": "SELF_EMPLOYED",
        "monthlyIncome": 20000.0,
        "jobPosition": "Carpintero",
        "startDate": {
            "year": 2022,
            "month": 1
        }
    },
    "nipConfirmationDate": null,
    "isComplete": false,
    "isPq": false
}

Ejemplo con cURL

curl --location --request GET '{{auto_financing_base_url}}/api/leads/{{leadId}}' \
--header 'Authorization: Bearer {{access_token}}'

Posibles errores

Consulta los posibles errores aquí.