Complete the application

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

Add application details

After saving the applicant’s personal information, call the following endpoints in any order:

• Address
• Financial information
• Vehicle information (optional)

Address

Save the applicant’s address. Use the postal code catalog to retrieve valid neighborhoods.

Request information

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

Request body

Field	Type	Description
zipCode	String	The applicant’s postal code. Ex: “09440”
neighborhood	String	The applicant’s neighborhood. Ex: “El Retoño”
street	String	The applicant’s street. Ex: “Margarita Maza de Juárez”
number	String	The exterior number of the applicant’s address. Ex: “45”
interior	String	Optional. The interior number of the applicant’s address. Ex: “A”

Request response status

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

cURL example

curl --location --request PUT '{{auto_equity_base_url}}/api/leads/{{leadId}}/address' \
--header 'Authorization: Bearer  {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "street": "Margarita Maza de Juárez",
    "number": 43,
    "interior": "A",
    "zipCode": "09440",
    "neighborhood": "El Retoño"
}'

Possible errors

Review the possible error responses.

Financial information

This information is used to calculate the applicant’s payment capacity.

Request information

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

Request body

Field	Type	Description
employmentType	String enum [“RETIRED”, “EMPLOYED”, “SELF_EMPLOYED”]	The source of the applicant’s income. Ex: “SELF_EMPLOYED”
income	number	The applicant’s monthly income. Ex: 20000

Request response status

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

cURL example

curl --location --request PUT '{{auto_equity_base_url}}/api/leads/05d3ccd2-26e8-4a85-bde8-509d6888c12b/financial' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "income" : 20000,
    "employmentType" : "SELF_EMPLOYED"
}'

Possible errors

Review the possible error responses.

Vehicle information

Use this endpoint to save the applicant’s vehicle. Select the vehicle identifier from the vehicle catalog.

Request information

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

Request body

Field	Type	Description
id	String	The vehicle version identifier. See the vehicle catalog. Ex: “2020910528260”

Request response status

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

cURL example

curl --location --request PUT '{{auto_equity_base_url}}/api/leads/{{leadId}}/auto' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id" : "2020910528260"
}'

Possible errors

Review the possible error responses.