--- title: "Relatório de Risco de Crédito Positivo PJ" description: "API Relatório de Risco de Crédito Positivo PJ" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/9875095b-ca4e-4baa-9d3f-843b42c587bb markdown: https://doc.apibrasil.io/apis/creditos/9875095b-ca4e-4baa-9d3f-843b42c587bb.md source: apibrasil-documentation --- # Relatório de Risco de Crédito Positivo PJ > API Relatório de Risco de Crédito Positivo PJ - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 30,86 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/9875095b-ca4e-4baa-9d3f-843b42c587bb/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 Envie um POST com tipo=risco-credito-positivo-pj e o cnpj (14 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz documento, situacao (com_restricoes, sem_restricoes ou indeterminada), data_consulta, cadastro, decisao, score, indicadores, restricoes, governanca (administradores e sócios), alertas, historico_consultas e o link pdf do relatório. A cobrança acontece quando a consulta é concluída, inclusive quando a empresa não tem restrições (sem restrições é resultado cobrado); CNPJ sem cadastro ou sem informação de crédito responde HTTP 404 e falhas de consulta respondem 4xx/5xx, sem cobrança; 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 completa, 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": "risco-credito-positivo-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":"risco-credito-positivo-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": "369,140", "balance_before": "400,000", "tax": "30,860", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 30,86.", "valor_consulta": 30.86, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "alertas": [ { "observacao": "Observacao de teste", "tipo": "Informativo", "titulo": "Alerta ficticio" } ], "cadastro": { "capital_social": 100000, "cidades_filiais": "Cidade Exemplo; Outra Cidade", "cnae_primario": "4690-9/99", "cnae_secundario": "8299-7/99", "cnpj": "11.222.333/0001-81", "data_consulta_sintegra": "07/11/2026", "data_encerramento": null, "data_fundacao": "10/03/2010", "data_situacao": "01/01/2015", "data_situacao_sintegra": "02/02/2016", "email": "[omitido]", "enderecos": [ { "bairro": "Centro Ficticio", "cep": "01000-000", "cidade": "Cidade Exemplo", "complemento": "Sala 1", "logradouro": "Avenida Exemplo", "numero": "100", "uf": "SP" } ], "faixa_funcionarios": "10 a 49", "inscricao_estadual": "123456789", "inscricao_estadual_uf": "SP", "natureza_juridica": "Sociedade Empresaria Limitada", "nire": "35200000000", "nire_uf": "SP", "nome_fantasia": "TESTE COMERCIO", "opcao_tributaria": "Simples Nacional", "porte": "Pequeno", "quantidade_filiais": 2, "ramo_atividade_primario": "Comercio atacadista ficticio", "ramo_atividade_secundario": "Servicos ficticios", "razao_social": "EMPRESA TESTE LTDA", "razao_social_anterior": "EMPRESA ANTIGA TESTE LTDA", "situacao_cadastral": "ATIVA", "situacao_sintegra": "Habilitada", "telefones": [ { "ddd": "11", "numero": "30000000", "telefone": "(11) 3000-0000" } ], "tipo_sociedade": "Limitada" }, "data_consulta": "07/11/2026", "decisao": { "codigo": "1", "descricao": "Aprovado pelo modelo ficticio", "layout": "RP01", "resultado": "Aprovado" }, "documento": "11.222.333/0001-81", "governanca": { "administradores": [ { "cargo": "Administrador", "data_entrada": "10/03/2010", "documento": "404.428.201-35", "nome": "FULANO DE TESTE", "situacao_documento": "Regular" } ], "quantidade_administradores": 1, "quantidade_socios": 2, "socios": [ { "documento": "404.428.201-35", "nome": "FULANO DE TESTE", "percentual_participacao": 60, "situacao_documento": "Regular", "tipo_documento": "CPF" }, { "documento": "529.982.247-25", "nome": "SOCIA DE TESTE", "percentual_participacao": 40, "situacao_documento": "Regular", "tipo_documento": "CPF" } ] }, "historico_consultas": { "consultas": [ { "cnpj": "11.444.777/0001-61", "data": "15/10/2026", "razao_social": "CONSULENTE TESTE LTDA" } ], "data_final": "31/10/2026", "data_inicial": "01/10/2026", "quantidade": 1 }, "indicadores": { "compromissos": { "ocorrencias": [ { "periodo": "01/2026", "pontuacao": 21 }, { "periodo": "02/2026", "pontuacao": 22 }, { "periodo": "03/2026", "pontuacao": 23 } ], "pontuacao": 8 }, "credito_obtido": { "ocorrencias": [ { "periodo": "01/2026", "pontuacao": 11 }, { "periodo": "02/2026", "pontuacao": 12 }, { "periodo": "03/2026", "pontuacao": 13 } ], "pontuacao": 7.5 }, "eventos_pessoa_juridica": { "ocorrencias": [ { "indicador": "Abertura de filial", "periodo": "03/2026", "pontuacao": 2 } ], "pontuacao": 6 }, "pagamento_atrasado": { "ocorrencias": [ { "descricao": "Atraso de 1 a 15 dias", "itens": [ { "periodo": "01/2026", "pontuacao": 2 }, { "periodo": "02/2026", "pontuacao": 3 } ], "pontuacao": 1.5 } ] }, "pagamento_pontual": { "ocorrencias": [ { "periodo": "01/2026", "pontuacao": 31 }, { "periodo": "02/2026", "pontuacao": 32 }, { "periodo": "03/2026", "pontuacao": 33 } ], "pontuacao": 9.2 }, "periodo_relacionamento_fornecedores": { "ocorrencias": [ { "periodo": "Ate 12 meses", "valor": 25.5 }, { "periodo": "Mais de 12 meses", "valor": 74.5 } ], "pontuacao": 5 } }, "pdf": "(link do PDF da consulta)", "restricoes": { "acoes_civeis": { "data_maior": "02/06/2026", "data_menor": "02/06/2026", "data_primeira": "02/06/2026", "data_ultimo": "02/06/2026", "ocorrencias": [ { "acao": "Execucao de titulo", "autor": "AUTOR TESTE SA", "comarca": "Cidade Exemplo", "data_distribuicao": "02/06/2026", "documento": "11.222.333/0001-81", "foro": "Foro Central Ficticio", "origem": "Cidade Exemplo", "processo": "0000000-00.2026.8.00.0000", "requerido": "EMPRESA TESTE LTDA", "valor": 5000, "vara": "1a Vara Civel" } ], "quantidade": 1, "valor_maior": 5000, "valor_menor": 5000, "valor_primeiro": 5000, "valor_total": 5000, "valor_ultimo": 5000 }, "cheques_sem_fundo_bacen": { "correntista": null, "documento": null, "quantidade": 0, "tipo_pessoa": null }, "cheques_sem_fundo_varejo": { "correntista": null, "documento": null, "quantidade": 0, "tipo_pessoa": null }, "contumacia": { "data_primeira_ocorrencia": null, "data_ultima_ocorrencia": null, "quantidade": 0 }, "falencia_recuperacao_judicial": { "ocorrencias": [], "periodo_final": null, "periodo_inicial": null, "quantidade": 0 }, "faturamento_presumido": { "dados_cadastro_positivo": "Sim", "data_referencia": "10/2026", "faixa": "Faixa 2", "faturamento_anual": 1200000, "mensagem": "Faturamento presumido de teste", "valor_presumido": 100000 }, "limite_credito": { "descricao": "Limite sugerido", "texto": "Limite de teste", "valor": 50000 }, "pendencias_financeiras": { "data_maior": "10/10/2026", "data_primeiro": "10/10/2026", "ocorrencias": [ { "contrato": "CT-0001", "credor": "CREDOR TESTE SA", "data_inclusao": "20/10/2026", "data_vencimento": "10/10/2026", "entidade": "Entidade ficticia", "informante": "Informante ficticio", "modalidade": "Duplicata", "moeda": "R$", "origem": "Cidade Exemplo", "sub_judice": "N", "tipo_devedor": "Principal", "valor": 1250.9 } ], "periodo_final": "10/2026", "periodo_inicial": "01/2026", "provedores": [ "Provedor ficticio" ], "quantidade": 1, "total_credores": 1, "ultimo_vencimento": "10/10/2026", "valor_maior": 1250.9, "valor_primeiro": 1250.9, "valor_total": 1250.9 }, "protestos": { "data_maior": "05/09/2026", "data_primeiro": "05/09/2026", "data_ultimo": "05/09/2026", "ocorrencias": [ { "anuencia": "N", "cartorio": "1o Tabelionato de Protesto Ficticio", "credor": "CREDOR TESTE SA", "data": "05/09/2026", "moeda": "R$", "origem": "Cidade Exemplo", "quantidade": 1, "sub_judice": "N", "tipo_anotacao": "Protesto", "valor": 800, "valor_custas": 35.1, "vencimento": "01/08/2026" } ], "quantidade": 1, "ultimo_protesto": "05/09/2026", "valor_maior": 800, "valor_primeiro": 800, "valor_total": 800, "valor_ultimo": 800 } }, "score": { "classificacao": "B", "classificacao_numero": 3, "descricao": "Risco baixo", "execucao": "Concluida", "informante": "Base de teste", "layout": "SC01", "modelo": "Modelo ficticio", "plano": "Plano ficticio", "pontuacao": 712, "probabilidade_inadimplencia": 4.5, "risco": "Baixo", "texto": "Empresa com bom historico", "tipo": "Risco Positivo" }, "situacao": "com_restricoes" } } } ``` 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/9875095b-ca4e-4baa-9d3f-843b42c587bb/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/9875095b-ca4e-4baa-9d3f-843b42c587bb