--- title: "Background Check" description: "API Background Check" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/d9666fb1-983b-4dbc-b6cb-8a35acd8d032 markdown: https://doc.apibrasil.io/apis/creditos/d9666fb1-983b-4dbc-b6cb-8a35acd8d032.md source: apibrasil-documentation --- # Background Check > API Background Check - **Categoria:** Análise Antifraude - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 16,90 por consulta - **Limite:** 990.000 por mês - **Cadastro:** CPF ou CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/d9666fb1-983b-4dbc-b6cb-8a35acd8d032/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=background-check e o cpf ou o cnpj (com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz identificacao, processos, protestos, cndt (emitiu_certidao_negativa, ocorrencias e link_certidao) e resumo (alerta), consulta (tipo, valor, entrada, data_hora, blocos_ok e blocos_total) e o link pdf do relatório. A cobrança acontece quando os blocos processos e protestos são respondidos (com ou sem registros); campo cpf ou 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 cpf ou 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": "background-check", "cpf": "12345678909", "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":"background-check","cpf":"12345678909","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": "383,100", "balance_before": "400,000", "tax": "16,900", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 16,90.", "valor_consulta": 16.9, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "identificacao": { "documento": "***.428.201-**", "tipo_pessoa": "fisica", "nome": "PESSOA CONSULTADA EXEMPLO" }, "processos": { "quantidade": 3, "ativos": 2, "arquivados": 1, "ativos_penais": 0, "valor_total_causas": 41800.5, "lista": [ { "numero": "10000000020234010000", "tribunal": "TRF1", "uf": "DF", "classe": "PROCEDIMENTO COMUM CIVEL", "assunto": "INDENIZACAO POR DANO MORAL", "ramo_direito": "DIREITO CIVIL", "situacao": "EM TRAMITACAO", "orgao_julgador": "1A VARA FEDERAL CIVEL", "data_distribuicao": "2023-09-05", "valor_causa": 15000, "polo_consultado": "passivo", "tipo_parte": "reu", "partes": [ { "nome": "EMPRESA AUTORA EXEMPLO LTDA", "polo": "ativo", "tipo": "autor" }, { "nome": "PESSOA CONSULTADA EXEMPLO", "polo": "passivo", "tipo": "reu" } ] }, { "numero": "20000000020228260100", "tribunal": "TJSP", "uf": "SP", "classe": "EXECUCAO DE TITULO EXTRAJUDICIAL", "assunto": "CHEQUE", "ramo_direito": "DIREITO CIVIL", "situacao": "EM TRAMITACAO", "orgao_julgador": "3A VARA CIVEL", "data_distribuicao": "2022-03-14", "valor_causa": 4800.5, "polo_consultado": "passivo", "tipo_parte": "executado", "partes": [ { "nome": "COMERCIO EXEMPLO S.A.", "polo": "ativo", "tipo": "exequente" }, { "nome": "PESSOA CONSULTADA EXEMPLO", "polo": "passivo", "tipo": "executado" } ] }, { "numero": "30000000020195020000", "tribunal": "TRT2", "uf": "SP", "classe": "RECLAMACAO TRABALHISTA", "assunto": "VERBAS RESCISORIAS", "ramo_direito": "DIREITO DO TRABALHO", "situacao": "ARQUIVADO", "orgao_julgador": "10A VARA DO TRABALHO", "data_distribuicao": "2019-06-20", "valor_causa": 22000, "polo_consultado": "passivo", "tipo_parte": "reclamado", "partes": [ { "nome": "EX-FUNCIONARIO EXEMPLO", "polo": "ativo", "tipo": "reclamante" }, { "nome": "PESSOA CONSULTADA EXEMPLO", "polo": "passivo", "tipo": "reclamado" } ] } ], "lista_truncada": false, "status": "ok", "tempo_ms": 1840 }, "protestos": { "quantidade": 2, "valor_total": 4967.86, "lista": [ { "uf": "SP", "cartorio": "1 TABELIAO DE PROTESTO DE LETRAS E TITULOS", "cidade": "SAO PAULO", "data_protesto": "2026-02-13", "valor": 4534.42 }, { "uf": "MG", "cartorio": "TABELIONATO DE PROTESTO DE TITULOS", "cidade": "NOVA LIMA", "data_protesto": "2026-06-30", "valor": 433.44 } ], "lista_truncada": false, "status": "ok", "tempo_ms": 2310 }, "cndt": { "emitiu_certidao_negativa": true, "ocorrencias": 0, "emissao": "2026-11-06", "validade": "2027-05-05", "link_certidao": "/pdf/homolog", "status": "ok", "tempo_ms": 3120 }, "resumo": { "alerta": "alto", "motivos": [ "processos_ativos", "protestos" ], "blocos_total": 3, "blocos_ok": 3, "blocos_indisponiveis": [], "tempo_ms": 3120, "data_hora": "2026-11-06T12:00:00Z", "tipo": "background-check" } } } } ``` 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/d9666fb1-983b-4dbc-b6cb-8a35acd8d032/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/d9666fb1-983b-4dbc-b6cb-8a35acd8d032