--- title: "Protestos SP" description: "API Protestos SP - Consulta instantânea de pendências" lang: en 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 - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$0.66 per query - **Limit:** 990,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/290d6274-e016-47e3-ba99-b3b54b8fa32f/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 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. - **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-sp", "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-sp","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": "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" } } ``` 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/290d6274-e016-47e3-ba99-b3b54b8fa32f/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/290d6274-e016-47e3-ba99-b3b54b8fa32f