--- title: "Detalhamento Negativo" description: "API Detalhamento Negativo - Decisões mais seguras em tempo real" lang: pt-BR 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 - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 12,00 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/53d54afe-e3a2-423b-9f7f-d5022bb8070e/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 (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 /default, 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. - **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": "detalhamento-negativo", "cpf": "00000000000", "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":"detalhamento-negativo","cpf":"00000000000","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": "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. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cnpj/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": "detalhamento-negativo", "cnpj": "00000000000000", "homolog": true } ``` **Em 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}' ``` 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": "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 } } ``` 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/53d54afe-e3a2-423b-9f7f-d5022bb8070e/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/53d54afe-e3a2-423b-9f7f-d5022bb8070e