Manage leads

In the examples, {{auto_financing_base_url}} is the Auto Financing base URL for the selected environment.

Update contact information

Update the applicant’s email address or phone number.

Request information

HTTP method	URL	Example
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

Request body

Field	Type	Description
phone	String	The applicant’s 10-digit phone number. Only Mexican numbers are accepted. Ex: “9512138126”
email	String	The applicant’s email address. Ex: pq-approved@creditas.com

cURL example

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"
}'

Request response status

The service returns 204 No Content.

Possible errors

Review the possible error responses.

Get lead information

Use this endpoint to retrieve a specific lead.

Request information

HTTP method	URL	Example
GET	{{auto_financing_base_url}}/api/leads/{{leadId}}	https://stg-api.creditas.io/mx/b2b/autofin/api/leads/2341b2c8-8e84-4a5a-aac6-9dda4410e999

Request response status

The service returns 200 OK with the following response body.

Request response body

Field	Type	Description
id	String UUID	The lead identifier.
contact	Object	The applicant’s email address and phone number.
createdAt	String	The date and time when the lead was created.
updatedAt	String	The date and time when the lead was last updated.
loanInformation	Object	The requested term, downPayment, and purchaseIntention.
personalInformation	Object Nullable.	The applicant’s firstName, secondName, lastName, secondLastName, birthDate, and rfc. See save personal information.
address	Object Nullable.	The applicant’s address, including street, number, interior, zipCode, and neighborhood, plus municipality, city, and state from the postal code catalog.
auto	Object Nullable.	The vehicle’s id, brandName, modelName, year, and price.
financialInformation	Object Nullable.	The applicant’s employmentType, monthlyIncome, jobPosition, and startDate. See the financial information endpoint.
nipConfirmationDate	String Nullable.	The date and time when the applicant authorized the credit history check. See request an offer.
isComplete	Boolean	Indicates whether the lead has personal information, an address, a vehicle, and a confirmed PIN.
isPq	Boolean	Indicates whether the lead passed prequalification.

Response example

{
    "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": "Carpenter",
        "startDate": {
            "year": 2022,
            "month": 1
        }
    },
    "nipConfirmationDate": null,
    "isComplete": false,
    "isPq": false
}

cURL example

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

Possible errors

Review the possible error responses.