Manage leads

In the examples, {{auto_equity_base_url}} is the Auto Equity 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_equity_base_url}}/api/leads/{{leadId}}/contact	https://stg-api.creditas.io/mx/b2b/autoequity/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_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"
}'

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_equity_base_url}}/api/leads/{{leadId}}	https://stg-api.creditas.io/mx/b2b/autoequity/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 and `loanAmount`.
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` and `monthlyIncome`. See the financial information endpoint.
nipConfirmationDate	String Nullable.	The date and time when the applicant authorized the credit history check. See request an offer.
status	String	INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
preApprovingResult	String Nullable.	One or more prequalification outcomes: APPROVED, MANUAL_REVIEW, REJECTED
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,
        "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
}

Possible errors

Review the possible error responses.

List leads

Use this endpoint to retrieve your leads.

Request information

HTTP method	URL
GET	{{auto_equity_base_url}}/api/leads

Query parameters

Name	Example	Description
name	username	Search for leads whose name contains this value.
rfc	SOGJ930426EKA	Filter by an exact RFC.
status	COMPLETE	Filter by one or more statuses: INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
preApprovingResult	MANUAL_REVIEW	One or more prequalification outcomes: APPROVED, MANUAL_REVIEW, REJECTED
email	email@gmail.com	Filter by an exact email address.
createdFrom	2023-11-01T09:30:00	Return leads created after this date and time in `yyyy-MM-dd'T'HH:mm:ss` format.
createdTo	2023-11-01T09:30:00	Return leads created before this date and time in `yyyy-MM-dd'T'HH:mm:ss` format.
sort	updatedAt,desc	Sort by `createdAt` or `updatedAt`, followed by the direction and separated by a comma.
page	number	The result page. Default: `1`.
size	number	The page size. Default: `20`.

cURL example

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

Request response status

The service returns 200 OK with the following response body.

Request response body

Field	Type	Description
content.id	String UUID	The lead identifier.
content.fullName	String	The applicant’s full name.
content.rfc	String Nullable.	The applicant’s RFC.
content.status	String	INCOMPLETE, COMPLETE, PQ_PENDING, DOCUMENTS_PENDING, DOCUMENTS_ANALYSIS, CREDIT_APPROVED, CREDIT_SIGNED, REJECTED
content.email	String	The applicant’s email address.
content.phone	String	The applicant’s phone number.
content.loanAmount	Number Nullable.	The requested loan amount.
content.preApprovingResult	String Nullable.	APPROVED, MANUAL_REVIEW, REJECTED
content.createdAt	String	The date and time when the lead was created.
content.updatedAt	String	The date and time when the lead was last updated.
content.isComplete	Boolean	Indicates whether the lead has personal information, an address, a vehicle, and a confirmed PIN.
content.isPq	Boolean	Indicates whether the lead passed prequalification.

Response example

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

Possible errors

Review the possible error responses.