--- title: "Endividamento Bancário PJ" description: "API Endividamento Bancário PJ" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/63783b9f-b8ea-41b4-8185-db811b5e6768 markdown: https://doc.apibrasil.io/apis/creditos/63783b9f-b8ea-41b4-8185-db811b5e6768.md source: apibrasil-documentation --- # Endividamento Bancário PJ > API Endividamento Bancário PJ - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 4,80 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/63783b9f-b8ea-41b4-8185-db811b5e6768/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/cnpj/credits ⚠️ Aviso: a consulta só é cobrada quando a resposta traz a data-base do SCR (relatorio_scr.database_consultada); um relatório sem operações também é cobrado, porque é a resposta do Banco Central. Sem informação para a consulta, a resposta é HTTP 404 e não há cobrança. Envie um POST com tipo=endividamento-pj e o cnpj (14 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.credcadastral e traz o bloco relatorio_scr: database_consultada, quantidade_instituicoes, quantidade_operacoes, consolidado (credito_avencer, credito_vencido, prejuizo e limite_credito, cada um com valor, percentual e operações por prazo), operacoes por modalidade e, quando disponível, score (pontuacao e faixa). Cada bloco tem o seu status_retorno (codigo 1 = bloco consultado com sucesso). Em data.pdf vem o link do relatório em PDF: baixe e guarde o arquivo logo após a consulta. Campo cnpj 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, sem cobrança, para qualquer cnpj válido. - **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": "endividamento-pj", "cnpj": "11222333000181", "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":"endividamento-pj","cnpj":"11222333000181","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": "395,200", "balance_before": "400,000", "tax": "4,800", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 4,80.", "valor_consulta": 4.8, "api_limit_for": "credit", "homolog": false, "data": { "credcadastral": { "relatorio_scr": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "tipo_documento": "", "documento": "", "nome_razao_social": "", "database_consultada": "1/2026", "data_inicio_relacionamento": "01/2015", "quantidade_instituicoes": "2", "quantidade_operacoes": "3", "quantidade_operacoes_discordancia": "0", "quantidade_operacoes_subjudice": "0", "valor_repasse": "0", "consolidado": { "credito_avencer": { "valor_total": "1.000,00", "percentual": "100,0", "operacoes": [ { "descricao": "A VENCER ATE 30 DIAS", "valor": "1.000,00", "percentual": "100,0", "qtd_meses": "1" } ] }, "credito_vencido": { "valor_total": "0", "percentual": "0", "operacoes": [] }, "limite_credito": { "valor_total": "0", "percentual": "0", "operacoes": [] }, "prejuizo": { "valor_total": "0", "percentual": "0", "operacoes": [] } }, "operacoes": [ { "modalidade": { "codigo": "02", "descricao": "EMPRESTIMOS" }, "sub_modalidade": { "codigo": "01", "descricao": "AMOSTRA" }, "variacao_cambial": "", "total": "1.000,00", "percentual": "100,0", "vencimentos": [] } ], "score": { "pontuacao": "700", "faixa": "BOM" } } }, "pdf": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fanalise-credito.apidocumentos.com.br%2Fpdf%2Fhomolog" } } ``` 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/63783b9f-b8ea-41b4-8185-db811b5e6768/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/63783b9f-b8ea-41b4-8185-db811b5e6768