Create a lead

In the examples, {{auto_equity_base_url}} is the Auto Equity base URL for the selected environment.

Start the integration by calling the create lead endpoint:

Request information

HTTP method	URL	Example
POST	{{auto_equity_base_url}}/api/leads	https://stg-api.creditas.io/mx/b2b/autoequity/api/leads

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
loanAmount	number	The requested amount in MXN. Ex: 120000
term	number	The number of monthly installments. Allowed values: 24, 36, 48, or 60. Ex: 24

To avoid checking real credit history in staging, use one of these test email addresses:

Email	Prequalification outcome
pq-approved@creditas.com	APPROVED
pq-manual-review@creditas.com	MANUAL_REVIEW
pq-direct-rejected@creditas.com	REJECTED

Request response status

The service returns 201 Created with the following response:

Request response body

Field	Type	Description
id	UUID (String)	The lead identifier. Use it in subsequent requests as {{leadId}}. Ex: “2341b2c8-8e84-4a5a-aac6-9dda4410e999”

cURL example

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

Possible errors

Review the possible error responses.

Save personal information

After creating the lead, provide the applicant’s personal information.

Request information

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

Request body

Field	Type	Description
firstName	String	The applicant’s first name. Ex: “Javier”
secondName	String	The applicant’s middle name. Omit this field when it does not apply. Ex: “Jair”
lastName	String	The applicant’s first surname. Ex: “Gonzalez”
secondLastName	String	The applicant’s second surname. Ex: “Gonzales”
birthDate	String	The applicant’s date of birth in yyyy-mm-dd format. Ex: “1993-11-28”
rfc	String	The applicant’s RFC. Ex: “GOGJ931128C83”

Request response status

The service returns 204 No Content with an empty response body.

cURL example

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

Possible errors

Review the possible error responses.