--- title: "Protestos SP" description: "API Protestos SP - Consulta instantânea de pendências" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/290d6274-e016-47e3-ba99-b3b54b8fa32f markdown: https://doc.apibrasil.io/apis/creditos/290d6274-e016-47e3-ba99-b3b54b8fa32f.md source: apibrasil-documentation --- # Protestos SP > API Protestos SP - Consulta instantânea de pendências - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,66 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/290d6274-e016-47e3-ba99-b3b54b8fa32f/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 Protestos SP - Risco de crédito sob controle em segundos A API Protestos SP permite consultar em tempo real a situação de um CPF ou CNPJ no CADIN-SP via requisição POST ao endpoint de consulta/cpf/credits, retornando de forma estruturada a existência de pendências e débitos inscritos em dívida ativa. Com integração rápida e padronizada, ela se encaixa facilmente nos seus fluxos de análise de crédito, cadastro, cobrança e prevenção a fraudes, reduzindo risco e aumentando a qualidade das decisões. Ao trazer dados oficiais diretamente para o seu sistema, você automatiza consultas que antes eram manuais, ganha agilidade na aprovação de clientes e contratos e melhora a governança sobre o risco de inadimplência. Essa API é ideal para empresas que precisam de uma visão confiável e atualizada da situação fiscal dos seus clientes antes de conceder crédito ou firmar novos negócios. - **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-sp", "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-sp","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": "108,300", "balance_before": "108,300", "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-04-16T14:00:43Z", "cpf": "123.456.789-00", "dataConsulta": "16/04/2026 14:00:43", "documentoConsultado": "123.456.789-00", "eventosFuturosSIMEI": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "eventosFuturosSimplesNacional": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "meiTransportadorAutonomo": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "nome": "PESSOA FISICA HOMOLOGACAO", "nomeEmpresarial": "", "observacoes": "Dados ficticios de protestos para ambiente de homologacao. Nenhum registro real.", "optanteSimei": false, "optanteSimplesNacional": false, "pendencias": [], "possuiPendencias": false, "protestos": [ { "cartoriosProtesto": [ { "cidade": "ALFA NOVA - SP", "codigoCartorio": "HOMOLOG-SP-01", "codigoCidade": "000001", "dataAtualizacao": null, "endereco": "RUA HOMOLOGACAO, 100 - ALFA NOVA, SP", "nome": "1 TABELIAO FICTICIO DE PROTESTOS", "numProtestos": 1, "observacao": null, "possuiAnuencia": null, "protesto": [ { "dataProtesto": null, "valorProtestado": "1.000,00" } ], "telefone": "11 4000-0000", "valorTotalProtestosCartorio": "1.000,00" }, { "cidade": "BETA LESTE - SP", "codigoCartorio": "HOMOLOG-SP-02", "codigoCidade": "000002", "dataAtualizacao": null, "endereco": "AV. AMBIENTE DE TESTE, 250 - BETA LESTE, SP", "nome": "2 TABELIAO FICTICIO DE PROTESTOS", "numProtestos": 1, "observacao": null, "possuiAnuencia": null, "protesto": [ { "dataProtesto": null, "valorProtestado": "750,50" } ], "telefone": "11 4000-0001", "valorTotalProtestosCartorio": "750,50" }, { "cidade": "GAMA CENTRAL - SP", "codigoCartorio": "HOMOLOG-SP-03", "codigoCidade": "000003", "dataAtualizacao": null, "endereco": "TRAVESSA DEMO, 42 - GAMA CENTRAL, SP", "nome": "3 TABELIAO FICTICIO DE PROTESTOS", "numProtestos": 2, "observacao": null, "possuiAnuencia": null, "protesto": [ { "dataProtesto": null, "valorProtestado": "1.200,00" }, { "dataProtesto": null, "valorProtestado": "1.145,90" } ], "telefone": "11 4000-0002", "valorTotalProtestosCartorio": "2.345,90" } ], "estado": "SP", "pesquisaEfetuadaEm": null, "pesquisaRetroativaAte": null, "totalNumProtestosUf": 4, "valorTotalProtestosEstado": "4.096,40" } ], "simeiPeriodosAnteriores": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "simplesNacionalPeriodosAnteriores": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "situacaoSIMEI": "NAO enquadrado no SIMEI", "situacaoSimplesNacional": "Situacao nao informada", "status": "Nao foram encontradas pendencias.", "totalNumProtestos": 4, "totalPendencias": 0, "valorTotalProtestos": "4.096,40" } } ``` 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/290d6274-e016-47e3-ba99-b3b54b8fa32f/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/290d6274-e016-47e3-ba99-b3b54b8fa32f