--- title: "Protesto Nacional" description: "API Protesto Nacional - Decisão de Crédito Mais Segura em Instantes" lang: en canonical: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad markdown: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad.md source: apibrasil-documentation --- # Protesto Nacional > API Protesto Nacional - Decisão de Crédito Mais Segura em Instantes - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$3.50 per query - **Limit:** 990,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad/openapi.json ## How to call **Base address:** `https://gateway.apibrasil.io/api/v2` Authentication: the `Authorization: Bearer ` header. Nothing else. With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits API Protesto Nacional - Decisão de crédito mais segura em segundos A API Protesto Nacional permite consultar, via CPF, a existência de protestos em âmbito nacional de forma rápida, segura e totalmente integrada ao seu fluxo de análise de crédito. Com uma única chamada POST para o endpoint de consulta/cpf/credits, seu sistema recebe em tempo real o retorno estruturado sobre registros de protesto, facilitando regras automáticas de aprovação, bloqueio ou revisão manual. A integração é simples, com baixo esforço de desenvolvimento, viabilizando ganhos imediatos na redução de inadimplência, prevenção a fraudes e melhoria da qualidade da carteira de clientes. Você pode usar a resposta da API diretamente em motores de decisão, cadastros, esteiras de crédito, cobrança preventiva e qualquer plataforma interna que dependa de informações confiáveis sobre a situação de protestos de um CPF. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Route version:** v2 **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "cpf": "00000000000", "tipo": "protestos-nacional-base", "homolog": true } ``` **In cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"cpf":"00000000000","tipo":"protestos-nacional-base","homolog":true}' ``` This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge. **Sample response, from the catalog** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "410,400", "balance_before": "410,400", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "constamProtestos": true, "consultaRealizadaEm": "2026-07-20T19:59:54Z", "cpf": "00000000000", "dataConsulta": "20/07/2026 19:59:54", "documentoConsultado": "00000000000", "observacoes": "A entidade possui protestos", "protestos": [ { "cartoriosProtesto": [ { "cidade": "NOVA LIMA", "codigoCartorio": "99", "codigoCidade": "3144805", "endereco": "R DOMINGOS RODRIGUES, 185", "nome": "99-TABELIONATO DE PROTESTO DE TITULOS - NOVA LIMA", "numProtestos": 1, "possuiAnuencia": false, "protesto": [ { "dataProtesto": null, "valorProtestado": "411,40" } ], "telefone": "(31) 3541-1061", "valorTotalProtestosCartorio": "411,40" } ], "estado": "MG", "pesquisaEfetuadaEm": "20/07/2026 19:59:54", "totalNumProtestosUf": 1, "valorTotalProtestosEstado": "411,40" }, { "cartoriosProtesto": [ { "cidade": "SAO PAULO", "codigoCartorio": "01", "codigoCidade": "3550308", "endereco": "AVENIDA BRIGADEIRO LUIZ ANTONIO, 371 CENTRO, SAO PAULO - SP", "nome": "01-1. TABELIAO DE PROTESTO DE LETRAS E TITULOS", "numProtestos": 2, "possuiAnuencia": true, "protesto": [ { "dataProtesto": "13/02/2026", "valorProtestado": "4.534,42" }, { "dataProtesto": "30/06/2026", "valorProtestado": "433,44" } ], "telefone": "(11) 3113-6916", "valorTotalProtestosCartorio": "4.967,86" } ], "estado": "SP", "pesquisaEfetuadaEm": "20/07/2026 19:59:54", "totalNumProtestosUf": 2, "valorTotalProtestosEstado": "4.967,86" } ], "totalNumProtestos": 3, "valorTotalProtestos": "5.379,26" } } ``` In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes. ## Pitfalls: what an integration gets wrong without warning Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else: 1. **The error arrives in the BODY, with HTTP 200.** The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`. 2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.** Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them. 3. **Every call costs money.** Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling. 4. **HTTP 402 means insufficient balance, and retrying does not fix it.** It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx. 5. **`extra_charges` bills on top of the lookup price.** When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both. ## See also - OpenAPI specification: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad/openapi.json - API catalog: [API catalog](https://doc.apibrasil.io/apis.md) - Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md) - Documentation index: https://doc.apibrasil.io/llms.txt - HTML version of this page: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad