Brazil

Brazilian 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

{/* TODO: Confirm with PM — the API source string. Existing API documentation does not explicitly list the source string; BR_GOVT_1 is inferred from the Dashboard source name. */}

BR GOVT 1

Request parameters

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.

Note: unabletoverify is returned for address-based fields (taxIdStateMatch, taxIdAddressMatch, taxIdCityMatch, taxIdPostalCodeMatch) when the individual does not have a driver's license record. Addresses are validated through the Brazilian government's driver's license source of truth.

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

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$).

{/* TODO: Confirm with PM — the income range table reflects the 2024 Brazilian minimum wage (R$1412). Confirm the current minimum wage figure and update the table accordingly. */}

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.