API flow

Index

• How to get access?
• Postman
• Environments
• General information
• Create a lead
• Save personal information
• Add additional info
• Address
• Financial information
• Auto information
• Get an offer
  • Send pin
  • Offer
• Consult lead's information
• All my leads
• Update contact information
• Catalogs
• Zip code information
• Auto catalogs

Diagram

This is the flow that you need to follow in order to create a request for a credit.

Lead status

Postman collection

Environments

Check the development environments section.

General information

Request headers

All the api request that you make, need the next headers.

Create a lead

The first steep is calling the create lead endpoint:

Request information

Request body

In Staging environment, the following emails should be used so as not to actually consult the credit history:

Request response status

Request response body

Curl example

curl --location --request POST '{{api_base_url}}/autoequity/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

Save personal information

Request information

Request body

Request response status

Curl example

curl --location --request POST '{{api_base_url}}/autoequity/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

Add additional info

Now, you have a lead with the personal information loaded, you can use the next endpoints in the order that you prefer.

• Address
• Financial information
• Auto information (optional)

Address

This is the information about the client address. You could complement this with out Zip code service.

Request information

Request body

Request response status

Curl example

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

Possible errors

Financial information

Request information

Request body

Request response status

Curl example

curl --location --request PUT '{{api_base_url}}/autoequity/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

Auto information

We this endpoint you send the auto that is property of the lead. This endpoint works with the auto catalog.

Request information

Request body

Request response status

Curl example

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

Possible errors

Send pin to client

If you need to update the contact client data use the update contact information endpoint.

In environments other than production, SMS are not sent for this cases the default PIN is 123456

Request information

Request body

Request response status

Curl example

curl --location --request POST '{{api_base_url}}/autoequity/api/leads/05d3ccd2-26e8-4a85-bde8-509d6888c12b/pin' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "EMAIL"
}'

Possible errors

Endpoint information, click here.

Request Offer

When the client obtain a PIN, he could call this endpoint. With this action the client authorizes the consult to his credit history and get an offer.

In Staging environment, the following emails should be used so as not to actually consult the credit history:

The fact that the prequalification result is APPROVED does not guarantee that the lead will be able to obtain an offer.

Request information

Request body

Curl example

curl --location  --request POST '{{api_base_url}}/autoequity/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

Request response body

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

Update contact information

Request information

Request body

Curl example

curl --location --request PUT '{{api_base_url}}/autoequity/api/leads/{{leadId}}/contact' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone" : 9511001687,
    "email" : "creaditas@creditas.com"
}'

Request response status

Possible errors

Consult lead's information

Request information

Request response status

Request response body

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 juarez",
        "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

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

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

Catalogs

Zip code information

Request information

{{zip-code}} is an String former by 5 digits. For example "09440".

Request response status

Request response body

Curl example

curl --location --request GET '{{api_base_url}}/autoequity/api/catalogs/zip-code/{{zip-code}}' \
--header 'Authorization: Bearer {{access_token}}'

Response example

{
    "zipCode": "09440",
    "neighborhoods": [
        "El Retoño",
        "San Andrés Tetepilco",
        "Zacahuitzco"
    ],
    "municipality": "Iztapalapa",
    "city": "Ciudad de México",
    "state": {
        "id": "CDMX",
        "name": "Ciudad de México"
    }
}

Possible errors

Auto catalogs

With these 3 endpoints you could select an auto. You just have to follow the next steps:

• Obtain brands by year
• Obtain a model by year and brand
• Obtain the version by year, brand and model.

Obtain brands by year

Request information

{{year}}: Is the year of the auto.

Request response status

Request response body

Curl example

curl --location --request GET '{{api_base_url}}/autoequity/api/catalogs/years/{{year}}/brands' \
--header 'Authorization: Bearer {{access_token}}'

Response example

[
    {
        "id": "910",
        "name": "Acura"
    },
    {
        "id": "920",
        "name": "Alfa Romeo"
    },
    {
        "id": "950",
        "name": "Audi"
    },
    {
        "id": "930",
        "name": "Baic"
    }
]

Obtain brands by year and brand

Request information

{{year}}: Is the year of the auto.
{{brandId}}: Is the id of the brand obtained from auto brands

Request response status

Request response body

Curl example

curl --location --request GET '{{api_base_url}}/autoequity/api/catalogs/years/{{year}}/brands/{{brandId}}/models' \
--header 'Authorization: Bearer {{access_token}}'

Response example

[
    {
        "id": "528",
        "name": "ILX"
    },
    {
        "id": "801",
        "name": "MDX"
    },
    {
        "id": "802",
        "name": "RDX"
    }
]

Obtain versions by year, brand and model

Request information

{{year}}: Is the year of the auto.
{{brandId}}: Is the id of the brand obtained from auto brands
{{modelId}}: Is the id of the model obtained from auto models

Request response status

Request response body

Curl example

curl --location --request GET '{{api_base_url}}/autoequity/api/catalogs/years/{{year}}/brands/{{brandId}}/models/{{modelId}}/versions' \
--header 'Authorization: Bearer {{access_token}}'

Response example

[
    {
        "id": "2020910802280",
        "name": "5p Tech L4/2.0/T Aut"
    },
    {
        "id": "2020910802290",
        "name": "5p A Spech L4/2.0/T Aut"
    }
]