--- title: "Dossiê de Crédito PJ" description: "API Dossiê de Crédito PJ" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/b19aa865-399a-4ce2-9d63-64436e5bd859 markdown: https://doc.apibrasil.io/apis/creditos/b19aa865-399a-4ce2-9d63-64436e5bd859.md source: apibrasil-documentation --- # Dossiê de Crédito PJ > API Dossiê de Crédito PJ - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 4,40 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/b19aa865-399a-4ce2-9d63-64436e5bd859/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 razão social no bloco dados_receita_federal. Sem informação para a consulta, a resposta é HTTP 404 e não há cobrança. Envie um POST com tipo=dossie-credito-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 os blocos dados_receita_federal, informacoes_da_empresa, administradores_da_empresa, quadro_societario, participacao_socio_adm_outras_empresas, pend_financeiras (com credor, valor, contrato e datas), pend_refin, protestos, protesto_sintetico, ch_sem_fundos_varejo, ch_sem_fundos_bacen, contumacia, acoes_civeis, somente_telefone e passagens_comerciais. Não traz score. 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": "dossie-credito-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":"dossie-credito-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,600", "balance_before": "400,000", "tax": "4,400", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 4,40.", "valor_consulta": 4.4, "api_limit_for": "credit", "homolog": false, "data": { "credcadastral": { "dados_receita_federal": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "tipo_pessoa": "JURIDICA", "nome": "", "razao_social": "EMPRESA FICTICIA DE HOMOLOGACAO LTDA", "situacao_receita": "ATIVA", "data_nascimento_fundacao": "01/01/2010", "nome_mae": "", "data_atualizacao": "", "sexo": "", "email": "", "natureza_juridica": "2062-SOCIEDADE EMPRESARIA LIMITADA", "atividade_economica_principal": "6311900-TRATAMENTO DE DADOS" }, "informacoes_da_empresa": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "cnpj": "00000000000000", "situacao": "ATIVA", "data_situacao": "01/01/2010", "razao_social": "EMPRESA FICTICIA DE HOMOLOGACAO LTDA", "razao_social_anterior": "", "nome_fantasia": "FICTICIA", "data_fundacao": "01/01/2010", "natureza_juridica": "2062-SOCIEDADE EMPRESARIA LIMITADA", "cnae_primario": "6311900-TRATAMENTO DE DADOS", "capital_social": "10000,00", "porte": "", "endereco": { "endereco": "RUA FICTICIA 100", "bairro": "CENTRO", "cidade": "CIDADE EXEMPLO", "uf": "XX", "cep": "00000000" }, "endereco_matriz": { "endereco": "", "bairro": "", "cidade": "", "uf": "", "cep": "" } }, "pend_financeiras": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "quantidade_ocorrencia": "0", "valor_total": "", "ultimo_vencimento": "", "provedores": [ { "provedor": "AMOSTRA", "quantidade_ocorrencias": "0", "valor_calculado": "" } ], "ocorrencias": [] }, "protestos": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "quantidade_ocorrencia": "0", "valor_total": "", "ultimo_protesto": "", "ocorrencias": [] }, "ch_sem_fundos_bacen": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "quantidade_ocorrencia": "0", "ocorrencias": [] }, "somente_telefone": { "status_retorno": { "codigo": "1", "descricao": "CONSULTA CONCLUIDA COM SUCESSO" }, "registro_localizado": "1", "dados": [ { "tipo_pessoa": "", "documento": "", "ddd": "00", "num_telefone": "00000000", "tipo_telefone": "", "pontuacao": "" } ] } }, "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/b19aa865-399a-4ce2-9d63-64436e5bd859/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/b19aa865-399a-4ce2-9d63-64436e5bd859