PIN and offer

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

Send a PIN to the applicant

This endpoint sends a six-digit PIN to the applicant by SMS or email.

To change the applicant’s phone number or email address, use the update contact information endpoint.

Non-production environments do not send SMS messages. Use the default PIN 123456 for testing.

Request information

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

Request body

Field	Type	Description
channel	String enum [“SMS”, “EMAIL”]	The channel used to deliver the PIN. Ex: “SMS”

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/05d3ccd2-26e8-4a85-bde8-509d6888c12b/pin' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "EMAIL"
}'

Possible errors

Review the possible error responses.

Request an offer

After receiving the PIN, the applicant can authorize a credit history check and request an offer through this endpoint.

Test email addresses for staging

Use one of these addresses to avoid checking real credit history:

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

An APPROVED prequalification outcome does not guarantee that the applicant will receive an offer.

Request information

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

Request body

Field	Type	Description
pin	String	The PIN received by the applicant. Ex: “123456”
pinConfirmation	String	The same PIN, entered again for confirmation. Ex: “123456”

cURL example

curl --location  --request POST '{{auto_equity_base_url}}/api/leads/7809b67d-4dfb-47ff-a4df-ac033569f6e4/offer' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
    "pin": "123456",
    "pinConfirmation": "123456"
}'

Request response status

The service returns 200 OK with the following response body.

Request response body

Field	Type	Description
prequalification	Boolean	Indicates whether the lead has a pre-approved offer.
result	String Enum [“APPROVED”, “MANUAL_REVIEW”, “REJECTED”]	APPROVED — A pre-approved offer is generated. MANUAL_REVIEW — The operations team reviews the information and sends a counteroffer when available. REJECTED — No offer is available.
offer	Object Nullable.	The pre-approved offer or counteroffer. This value is null when the lead is not automatically prequalified.
offer.id	UUID (String)	The generated offer identifier.
offer.annualInterestRate	Number	The annual interest rate.
offer.monthlyPayment	Number	The monthly payment amount.
offer.term	Integer	The loan term in months.
offer.loanAmount	Number	The loan amount.
offer.auto	Object	Information about the selected vehicle. The vehicle can be changed later.
offer.loanType	String Enum [“REQUESTED”, “PROPOSED”]	REQUESTED when the requested amount is available; PROPOSED when a counteroffer provides the maximum available amount.
offer.amountFinanced	Number	The total financed amount, including the GPS cost and origination fee.

Response example

{
    "prequalification": true,
    "result": "APPROVED",
    "offer": {
        "id": "973f5181-68f1-447b-bf21-326a51e84ab1",
        "annualInterestRate": 31.08,
        "monthlyPayment": 7652.9,
        "term": 24,
        "loanAmount": 120000,
        "auto": {
            "make": "Acura",
            "model": "ILX",
            "year": 2020,
            "price": null,
            "officialPrice": 282100
        },
        "loanType": "REQUESTED",
        "amountFinanced": 123850.26
    }
}

Possible errors

Review the possible error responses.