--- title: "Compliance Basic" description: "API Compliance Basic - Validação de CPF rápida e confiável" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/247ed7c2-4eb1-4a81-932e-7a7475ca5732 markdown: https://doc.apibrasil.io/apis/creditos/247ed7c2-4eb1-4a81-932e-7a7475ca5732.md source: apibrasil-documentation --- # Compliance Basic > API Compliance Basic - Validação de CPF rápida e confiável - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 4,80 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v1 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/247ed7c2-4eb1-4a81-932e-7a7475ca5732/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 API Compliance Basic - Reduza riscos e simplifique validações em segundos Com a API Compliance Basic, você integra rapidamente consultas essenciais de compliance ao seu sistema, tornando processos de validação muito mais ágeis e confiáveis. Em uma única chamada via POST, sua aplicação recebe informações tudo pronto para uso, permitindo decisões mais seguras e redução expressiva de custos operacionais. Automatize verificações de risco e análise de CPF em fluxos de onboarding, concessão de crédito e prevenção a fraudes, fortalecendo suas políticas internas e garantindo aderência regulatória. Garanta valor de negócio imediato, minimize falhas manuais e aumente a confiança nos seus processos com uma solução eficiente, robusta e de fácil integração. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "compliance-basic", "cpf": "00000000000", "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":"compliance-basic","cpf":"00000000000","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": "105,660", "balance_before": "105,660", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "resultado": { "beneficio_social": { "auxilio_brasil": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "auxilio_emergencial": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "bolsa_familia": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "garantia_safra": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "prestacao_continuada": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "seguro_defeso": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" } }, "compliance": { "aposentados": [], "ceaf": [], "ceis": [], "cnep": [], "doadores_eleitorais": [], "honorarios": [], "ibama": [], "militares": [], "pensionista": [], "pep": [], "reserva_militares": [], "servidor_publico": [], "vinculo_pep": [] }, "contatos": { "emails": [], "enderecos": [], "telefones": [ { "ddd": "11", "ds_tipo_telefone": "Movel", "dt_inclusao": "2022-08-14", "nr_ddi": null, "numero": "912345678", "ordem": 1, "uf_ddd": "SP" } ] }, "cpf": "00000000000", "dados_cadastrais": { "comprovante_rfb": null, "cpf": "00000000000", "ds_faixa_idade": "De 36 a 45", "ds_nacionalidade": "BRASILEIRA", "ds_orgao_emissor": "SSP", "ds_sexo": "Masculino", "ds_signo": "Aquario", "ds_status_rfb": "REGULAR", "dt_atualizacao_rfb": "15-02-2026", "dt_inscricao": null, "dt_nasc": "1989-02-14", "nit_pis": null, "nm_social": null, "nome_completo": "LUCAS FERREIRA ALMEIDA", "nome_mae": "RENATA FERREIRA ALMEIDA", "nome_unico": false, "nr_cpf_mae": null, "nr_rg": "MG1234567", "nr_titulo_eleitoral": null, "sg_sexo": "M", "sg_uf_rg": "MG", "st_menor_idade": false, "st_pep": false, "st_ppp": false }, "divida_publica": { "pgfn_fgts": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "pgfn_nao_previdenciario": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" }, "pgfn_previdenciario": { "quantidade": "0", "ultimas_ocorrencias": [], "valor": "0,00" } }, "obito": { "ano_obito": null, "data_obito": null, "fonte_obito": null, "mes_obito": null, "possivel_obito": null, "st_obito": false, "tipo_obito": null }, "patrimonio": { "aeronaves": [], "imoveis": [], "imoveis_rurais": [], "mei": [], "participacoes_empresas": [], "st_empresario": false, "st_multiempresario": false }, "socioeconomico": { "cd_ocupacao": null, "ds_faixa_renda_presumida": "De R$ 3.254,01 a R$ 6.508,00", "ds_grau_escolaridade": "Ensino superior completo", "ds_ocupacao": "Analista de sistemas", "dt_faixa_renda_presumida": "2026-01-10", "dt_grau_escolaridade": "2012-12-20", "dt_ocupacao": "2025-11-05", "historico_ocupacoes": [] }, "vinculo": { "empregador": [], "parentesco": [], "possiveis_colegas_trabalho": [], "socios": [] } } } } ``` 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/247ed7c2-4eb1-4a81-932e-7a7475ca5732/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/247ed7c2-4eb1-4a81-932e-7a7475ca5732