--- title: "Protestos Nacional Resumido" description: "API Protestos Nacional Resumido" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/5a0a9292-00f2-4a97-bc03-49588acc2257 markdown: https://doc.apibrasil.io/apis/creditos/5a0a9292-00f2-4a97-bc03-49588acc2257.md source: apibrasil-documentation --- # Protestos Nacional Resumido > API Protestos Nacional Resumido - **Categoria:** Negativação e Protesto - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 6,49 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/5a0a9292-00f2-4a97-bc03-49588acc2257/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 Envie um POST com tipo=protestos-basica e o cpf ou o cnpj (apenas um por consulta; 11 ou 14 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz documento, tipo_documento, situacao (consta ou nada_consta), consta_protesto, total_protestos, valor_total_protestos, data_consulta, cnae_devedor, observacoes, documentos (por documento: totais, quantidade_cartorios, quantidade_cidades e titulos com valor), resumo (alerta) e o link pdf do relatório. A cobrança acontece quando a base devolve o veredito explícito, com ou sem protesto (consta ou nada consta); documento não encontrado ou retorno vazio responde HTTP 404, sem cobrança; campo cpf ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer cpf válido. - **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 { "tipo": "protestos-basica", "cpf": "12345678909", "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 '{"tipo":"protestos-basica","cpf":"12345678909","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": "393,510", "balance_before": "400,000", "tax": "6,490", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 6,49.", "valor_consulta": 6.49, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "cnae_devedor": "6201501", "consta_protesto": true, "data_consulta": "12/11/2026", "documento": "123.456.789-09", "documentos": [ { "documento": "123.456.789-09", "quantidade_cartorios": 2, "quantidade_cidades": 2, "titulos": [ { "valor_protestado": 1000 }, { "valor_protestado": 2000 }, { "valor_protestado": 1500.5 } ], "total_protestos": 3, "valor_total_protestos": 4500.5 } ], "observacoes": "Amostra de homologação com dados fictícios.", "pdf": "(link do PDF da consulta)", "resumo": { "alerta": "Constam protestos para o documento informado: 3 título(s) protestado(s) em 2 cartório(s) distinto(s)." }, "situacao": "consta", "tipo_documento": "cpf", "total_protestos": 3, "valor_total_protestos": 4500.5 } } } ``` 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/5a0a9292-00f2-4a97-bc03-49588acc2257/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/5a0a9292-00f2-4a97-bc03-49588acc2257