--- title: "Detalhamento Negativo" description: "API Detalhamento Negativo - Decisões mais seguras em tempo real" lang: en canonical: https://doc.apibrasil.io/apis/creditos/53d54afe-e3a2-423b-9f7f-d5022bb8070e markdown: https://doc.apibrasil.io/apis/creditos/53d54afe-e3a2-423b-9f7f-d5022bb8070e.md source: apibrasil-documentation --- # Detalhamento Negativo > API Detalhamento Negativo - Decisões mais seguras em tempo real - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$12.00 per query - **Limit:** 999,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/53d54afe-e3a2-423b-9f7f-d5022bb8070e/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 (2 endpoints) ### 1. POST /consulta/cpf/credits API Detalhamento Negativo - Reduza Riscos com Consultas Precisas Integre rapidamente a API Detalhamento Negativo ao seu sistema e tenha acesso instantâneo a informações detalhadas sobre restrições e ocorrências negativas associadas a pessoas físicas ou jurídicas. Com o endpoint consulta/cpf/credits, em poucos segundos sua empresa obtém um retorno completo e padronizado via POST, potencializando decisões de crédito mais seguras e assertivas. Essa solução multiplica o valor do seu negócio ao agilizar processos de análise, evitar inadimplência e personalizar ofertas, tudo com máxima confiabilidade e facilidade de implementação. - **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 { "tipo": "detalhamento-negativo", "cpf": "00000000000", "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 '{"tipo":"detalhamento-negativo","cpf":"00000000000","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": "105,660", "balance_before": "105,660", "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": { "consultaRealizadaEm": "2025-10-17T20:18:24Z", "cpf": "00000000000", "dataConsulta": "17/10/2025 17:18:22", "documentoConsultado": "000.000.000-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": "Helena Ribeiro Homolog", "nomeEmpresarial": "", "observacao": null, "optanteSimei": false, "optanteSimplesNacional": false, "pendencias": [], "pessoaFisica": { "pendenciaFinanceira": { "acoesJudiciais": [], "chequesSemFundo": [], "protestos": [], "recuperacoesJudiciaisFalencia": [], "status": "Nao Consta Pendencia", "totalPendencia": 0 } }, "pessoaJuridica": null, "possuiPendencias": false, "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.", "totalPendencias": 0 } } ``` ### 2. POST /consulta/cnpj/credits API Detalhamento Negativo - Decisões de Crédito Mais Inteligentes A API Detalhamento Negativo integra-se rapidamente ao seu sistema por meio de um simples POST, entregando respostas completas sobre restrições financeiras vinculadas ao CNPJ consultado. Essencial para processos de análise e concessão de crédito, ela permite que sua empresa identifique pendências e riscos de inadimplência de forma automática e em tempo real. Isso garante decisões assertivas, melhora a experiência do cliente e otimiza operações, ampliando a segurança das suas transações comerciais diretamente na sua rotina digital. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cnpj/credits` - **Route version:** v2 **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "tipo": "detalhamento-negativo", "cnpj": "00000000000000", "homolog": true } ``` **In cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cnpj/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"detalhamento-negativo","cnpj":"00000000000000","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": "105,660", "balance_before": "105,660", "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": { "cnpj": "00000000000000", "consultaRealizadaEm": "2025-10-17T20:18:24Z", "dataConsulta": "17/10/2025 17:18:22", "documentoConsultado": "00.000.000/0000-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": "Comercial Homolog LTDA", "nomeEmpresarial": "Comercial Homolog LTDA", "observacao": null, "optanteSimei": false, "optanteSimplesNacional": false, "pendencias": [], "pessoaFisica": null, "pessoaJuridica": { "pendenciaFinanceira": { "acoesJudiciais": [], "chequesSemFundo": [], "protestos": [], "recuperacoesJudiciaisFalencia": [], "status": "Nao Consta Pendencia", "totalPendencia": 0 } }, "possuiPendencias": false, "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.", "totalPendencias": 0 } } ``` 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/53d54afe-e3a2-423b-9f7f-d5022bb8070e/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/53d54afe-e3a2-423b-9f7f-d5022bb8070e