--- title: "Protesto Nacional" description: "API Protesto Nacional - Decisão de Crédito Mais Segura em Instantes" lang: pt-BR 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 - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 1,72 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## 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. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "cpf": "00000000000", "tipo": "protestos-nacional-base", "homolog": true } ``` **Em 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}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```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" } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/23bdea5a-5c68-406a-9f1a-0ac368f693ad