--- title: "Dossiê de Crédito Completo" description: "API Dossiê de Crédito Completo" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/cd4b3acc-e398-42a5-98b9-d3a5a381de24 markdown: https://doc.apibrasil.io/apis/creditos/cd4b3acc-e398-42a5-98b9-d3a5a381de24.md source: apibrasil-documentation --- # Dossiê de Crédito Completo > API Dossiê de Crédito Completo - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 15,37 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/cd4b3acc-e398-42a5-98b9-d3a5a381de24/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/cpf/credits Envie um POST com tipo=dossie-quod-completo e o cpf ou o cnpj (um só por consulta, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz documento, tipo_entidade (pf ou pj), situacao (com_pendencias, sem_pendencias ou indeterminado), resumo, empresa (para CNPJ), pessoa (para CPF), observacao e o link pdf do relatório. A cobrança acontece quando o dossiê é concluído, com ou sem pendências; documento sem nenhuma informação ou retorno vazio responde HTTP 404, 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/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": "dossie-quod-completo", "cnpj": "11222333000181", "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":"dossie-quod-completo","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": "384,630", "balance_before": "400,000", "tax": "15,370", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 15,37.", "valor_consulta": 15.37, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "documento": "11.222.333/0001-81", "empresa": { "cadastro_positivo": "Participante", "conglomerado": { "consultas": [ { "cnpj": "22.333.444/0001-55", "detalhes": [ { "data": "01/11/2026", "quantidade_consultada": 2, "segmento_empresa": "Varejo" } ], "mais_90_dias": 12, "ultimos_30_dias": 3, "ultimos_60_dias": 5, "ultimos_90_dias": 7 } ] }, "consultas_recentes": { "cnpj": "11.222.333/0001-81", "detalhes": [ { "data": "01/11/2026", "quantidade_consultada": 2, "segmento_empresa": "Varejo" } ], "mais_90_dias": 12, "ultimos_30_dias": 3, "ultimos_60_dias": 5, "ultimos_90_dias": 7 }, "dados_cadastrais": { "codigo_atividade_principal": "4751201", "codigo_atividade_secundaria": "4789099", "data_fundacao": "15/03/2010", "descricao_atividade_principal": "Comercio varejista ficticio", "descricao_atividade_secundaria": "Comercio varejista de outros produtos", "email": "[omitido]", "endereco": { "bairro": "Centro", "cep": "01000-000", "cidade": "Cidade Teste", "complemento": "Sala 1", "logradouro": "Rua Exemplo", "numero": "100", "uf": "SP" }, "natureza_juridica": "Sociedade Empresaria Limitada", "nire": "35200000000", "nome_fantasia": "TESTE COMERCIO", "outras_empresas": [ { "data_fundacao": "01/01/2018", "documento": "22.333.444/0001-55" } ], "outros_emails": [ "[omitido]" ], "outros_enderecos": [ { "bairro": "Centro", "cep": "01000-000", "cidade": "Cidade Teste", "complemento": "Sala 1", "logradouro": "Rua Exemplo", "numero": "200", "uf": "SP" } ], "outros_telefones": [ "1100000001" ], "quantidade_filiais": 2, "razao_social": "EMPRESA TESTE LTDA", "situacao_cadastral": "Ativa", "telefone": "1100000000" }, "dados_empresariais": [ { "data_inicio_entrada": "01/01/2015", "data_inicio_sociedade": "01/01/2015", "data_saida": null, "documento": "404.428.201-35", "entidade": "Pessoa Fisica", "funcao_socio": "Socio Administrador", "nome_empresa": "FULANO DE TESTE", "percentual_participacao": 50, "situacao": "Ativo", "socio_administrador": true, "valor_financeiro": 50000 } ], "indicadores": { "indicacoes": [ { "conceito": "Pontualidade", "indicadores_negocio": [ { "faixa": "Boa", "risco": "Baixo" } ] } ], "observacao": null, "quantidade_indicadores": 1 }, "pendencia_financeira": { "acoes_judiciais": [ { "autor_processo": "CREDOR FICTICIO SA", "cidade": "Cidade Teste", "comarca": "Comarca Teste", "data_ajuizamento": "10/03/2026", "documento": "404.428.201-35", "forum": "Foro Central", "numero_processo_antigo": null, "numero_processo_principal": "0000000-00.2026.8.26.0000", "parte_acusada": "FULANO DE TESTE", "situacao": "Ativo", "tipo_processo": "Execucao", "tipo_tribunal": "Estadual", "valor": 1500.5, "vara": "1a Vara Civel" } ], "cheques_sem_fundo": [ { "codigo_banco": "999", "data_ultima_ocorrencia": "01/04/2026", "documento": "404.428.201-35", "entidade": "Banco Teste", "nome_agencia": "Agencia Teste", "numero_agencia": "0001", "quantidade_ocorrencia": 1 } ], "negativacoes": [ { "data_inclusao": "10/02/2026", "data_modificacao": "11/02/2026", "data_ocorrencia": "05/02/2026", "documento": "11.222.333/0001-81", "endereco": { "bairro": "Centro", "cep": "01000-000", "cidade": "Cidade Teste", "complemento": "Sala 1", "logradouro": "Rua Exemplo", "numero": "100", "uf": "SP" }, "motivo": "Divida ficticia", "nome_empresa": "CREDORA TESTE LTDA", "numero_contrato": "CT-0001", "situacao": "Ativa", "tipo_participacao": "Devedor principal", "valor": 500 } ], "protestos": [ { "cartorios": [ { "cidade": "Cidade Teste", "codigo_cartorio": "01", "codigo_cidade": "3550308", "endereco": "Rua do Cartorio, 1", "nome": "1o Tabelionato de Teste", "quantidade_protestos": 2, "telefone": "1100000000", "valor_protestado": 1200.25 } ], "observacao": "Informacao de teste", "situacao": "Com protestos", "valor_total": 1200.25 } ], "recuperacoes_judiciais_falencia": [], "situacao": "Possui pendencias", "total_pendencia": 3200.75 }, "quadro_societario": { "capital_social": 100000, "socios": [ { "data_inicio_entrada": "01/01/2015", "data_inicio_sociedade": "01/01/2015", "data_saida": null, "documento": "404.428.201-35", "entidade": "Pessoa Fisica", "funcao_socio": "Socio Administrador", "nome_empresa": "FULANO DE TESTE", "percentual_participacao": 50, "situacao": "Ativo", "socio_administrador": true, "valor_financeiro": 50000 } ] }, "score": { "observacao": "Amostra ficticia", "pessoa_fisica": null, "pessoa_juridica": { "indicadores_negocio": [ { "indicador": "Porte", "observacao": "Amostra", "risco": "Baixo", "situacao": "Informado" } ], "motivos": [ "Tempo de atividade", "Consultas recentes" ], "score": 710 } } }, "observacao": null, "pdf": "(link do PDF da consulta)", "pessoa": null, "resumo": { "possui_pendencia": true, "quantidades": { "acoes_judiciais": 1, "cheques_sem_fundo": 1, "negativacoes": 1, "protestos": 1, "recuperacoes_judiciais_falencia": 0 }, "score": 710, "total_pendencia": 3200.75 }, "situacao": "com_pendencias", "tipo_entidade": "pj" } } } ``` 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/cd4b3acc-e398-42a5-98b9-d3a5a381de24/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/cd4b3acc-e398-42a5-98b9-d3a5a381de24