Brazil

Brazil eKYC verification matches submitted individual data against Brazilian government sources of truth. Brazil also supports a separate income verification endpoint that returns employment and income data for a valid CPF. See the eKYC API Reference for common response semantics that apply across all identity-matching sources.

Available sources

BR GOVT 1

Request parameters

Sample request

{
    "plugins": ["kyc"], //required field
    "firstName": "Renata", // required field
    "surName": "De Maria Santos", //required field 
    "houseNo" : "121",
    "street" : "Rua Luiz Ferreira Dorta",
    "postalCode": "76535000",
    "country": "BR", //required firled
    "state" : "RJ",
    "city" : "Rio de Janerio",
    "dateOfBirth": "1980-06-01",
    "nationality" : "1",
    "taxId" : "23490843490" //required field
}

Response fields

BR GOVT 1 anchors verification on the tax ID (CPF). See the eKYC API Reference for common match field definitions and status values. BR GOVT 1 uses approximatematch as an alternative to fuzzy for some fields, and unabletoverify for address components when the individual has no driver's license record.

taxIdLevel

taxIdLevel reflects the status of the submitted CPF:

• low: The CPF status is regular (verified).
• high: The CPF status is suspended, associated with a deceased holder, pending regularization, canceled due to multiplicity, or canceled by authority.

Reason codes

BR GOVT 1 returns reason codes alongside match and risk-level fields. Selected Brazil-specific reason codes:

For the full list of reason codes, see eKYC Reason Codes.

Sample response

{
    "kyc": [
        { "key": "taxIdNationalityMatch", "status": "exact" },
        { "key": "taxIdDobMatch", "status": "exact" },
        { "key": "taxIdMatch", "status": "exact" },
        { "key": "taxIdAddressMatch", "status": "approximatematch", "reasonCodes": ["ASCV"] },
        { "key": "taxIdNameMatch", "status": "exact" },
        { "key": "taxIdStateMatch", "status": "exact" },
        { "key": "taxIdCityMatch", "status": "exact" },
        { "key": "taxIdPostalCodeMatch", "status": "nomatch" },
        { "key": "taxIdLevel", "status": "low", "reasonCodes": ["TSR"] },
        { "key": "overallLevel", "status": "low" }
    ]
}

BR Income verification

Brazil supports a separate endpoint for retrieving employment and estimated income data for a valid CPF. This endpoint is distinct from the standard eKYC endpoint and returns employment type, employment sector, and an estimated income range in Brazilian Real.

Endpoint

POST /omni/externalVerification/income

For the request contract, see the eKYC Income Verification API reference.

Response fields

Each field returns a status (indicating whether data was available), a sub_label (a display label for the field), and a message (the actual value or Unavailable).

Estimated income range

The income range is calculated as a multiple of the Brazilian minimum wage and returned as a range in Brazilian Real (R$):

• No information
• 0 - 1412
• 1412 - 2824
• 2824 - 4236
• 4236 - 7060
• 7060 - 9884
• 9884 - 14120
• 14120 - 21180
• 21180 - 28240
• Above 28240

Employment type

Employment type describes the individual's current employment status. Example values:

• ENTREPRENEUR / BUSINESS OWNER
• SELF-EMPLOYED
• EMPLOYEE

Employment sector

Employment sector describes the industry the individual works in, including a CNAE code and Portuguese-language description. The CNAE (Classificação Nacional de Atividades Econômicas) is Brazil's national classification of economic activities, maintained by the Instituto Brasileiro de Geografia e Estatística (IBGE).

Example values:

• PRIVATE - 4789001 - COMERCIO VAREJISTA DE SUVENIRES, BIJUTERIAS E ARTESANATOS
• PRIVATE - 7319002 - PROMOCAO DE VENDAS
• PUBLIC - 8412400 - REGULACAO DAS ATIVIDADES DE SAUDE, EDUCACAO, SERVICOS CULTURAIS E OUTROS SERVICOS SOCIAIS

For the full CNAE classification, see the IBGE CNAE reference.

Sample response

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

Availability

Income data may not always be available even for a valid, verified CPF. If a CPF passes the standard BR GOVT 1 check but no income data is available, the income verification endpoint returns failure statuses for the affected fields.

Brazil Tax + Phone Register

Request parameters

Sample request

{
    "plugins": ["kyc"], //required field
    "source": "BR_TAX_PHONE_REGISTER", //required field
    "firstName": "João", //required field
    "middleName": "Carlos",
    "surName": "da Silva Oliveira", //required field
    "street": "Rua Augusta",
    "houseNo": "1500",
    "city": "São Paulo", //required field
    "state": "SP",
    "postalCode": "01304-001",
    "country": "BR", //required field
    "dateOfBirth": "1991-08-02",
    "gender": "m",
    "email": "example.example@gmail.com",
    "phone": "+55 11 91234-5678",
    "idNum": "12345678909"
}

Response fields

Brazil Tax + Phone Register anchors verification on individual name, address, and phone number. See the eKYC API Reference for common match field definitions and status values.

fullNameMatch calculation

• exact when firstNameMatch is exact and lastNameMatch is exact, and middleNameMatch is exact or nodata.
• nomatch when firstNameMatch is nomatch or lastNameMatch is nomatch.
• fuzzy for any other combination.

fullAddressMatch calculation

• exact when cityMatch is exact, and at least one of streetMatch, stateMatch, or postalCodeMatch is exact or nodata.
• nomatch when cityMatch is nomatch.
• nodata when cityMatch, streetMatch, stateMatch, and postalCodeMatch are all nodata.
• fuzzy for any other combination.

overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name and city:

• low when fullNameMatch and cityMatch are both exact.
• high when fullNameMatch or cityMatch is nomatch.
• medium for all other combinations.

Contact your Incode representative to customize the overallLevel calculation for your use case.

Sample response

{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "exact" },
        { "key": "fullNameMatch", "status": "exact" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "idNumMatch", "status": "exact" },
        { "key": "genderMatch", "status": "nomatch" },
        { "key": "phoneMatch", "status": "exact" },
        { "key": "emailMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "low" }
    ]
}