eKYC Income verification

post

https://demo-api.incodesmile.com/omni/externalVerification/income

This endpoint performs an eKYC income check

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Example

Check income:

{
  "country": "br",
  "taxId": "32757350803" // cpf 76433943853. 32757350803
}

taxId

string

required

11 digit CPF

country

string

required

Two letter Alpha-2 country code. (Must be BR).

Headers

api-version

string

required

Defaults to 1.0

Responses

200

Example:

{
    "income": [
        {
            "key": "employment_type",
            "status": "success",
            "sub_label": "Type",
            "message": "ENTREPRENEUR | BUSINESS OWNER"
        },
        {
            "key": "employment_sector",
            "status": "success",
            "sub_label": "Sector",
            "message": "PRIVATE - 4639701 - COMERCIO ATACADISTA DE PRODUTOS ALIMENTICIOS EM GERAL"
        },
        {
            "key": "income_range",
            "status": "success",
            "sub_label": "Estimated Income Range",
            "message": "9240-13200"
        }
    ]
}

400

Example:

{
    "timestamp": 1722948860110,
    "status": 400,
    "error": "Both country and taxId are mandatory fields must be submitted for successful request",
    "message": "Both country and taxId are mandatory fields must be submitted for successful request",
    "path": "/omni/externalVerification/income"
}

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Example: { "timestamp": 1722948860110, "status": 400, "error": "Both country and taxId are mandatory fields must be submitted for successful request", "message": "Both country and taxId are mandatory fields must be submitted for successful request", "path": "/omni/externalVerification/income" }