--- title: "Compliance Complete - PF" description: "API Compliance - Validação completa de CPF em segundos" lang: en canonical: https://doc.apibrasil.io/apis/creditos/9273ef16-a6b7-4501-845b-93e137acdc9d markdown: https://doc.apibrasil.io/apis/creditos/9273ef16-a6b7-4501-845b-93e137acdc9d.md source: apibrasil-documentation --- # Compliance Complete - PF > API Compliance - Validação completa de CPF em segundos - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$14.44 per query - **Limit:** 999,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/9273ef16-a6b7-4501-845b-93e137acdc9d/openapi.json ## How to call **Base address:** `https://gateway.apibrasil.io/api/v2` Authentication: the `Authorization: Bearer ` header. Nothing else. With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits API Compliance - Validação instantânea de CPF com segurança máxima Transforme a validação de CPF na sua empresa com a Compliance Complete - PF, que realiza consultas completas, rápidas e seguras através de um endpoint prático via REST. Ao integrar essa solução ao seu sistema, você recebe em segundos o status do CPF, indicadores de conformidade e informações detalhadas já consolidadas, facilitando decisões precisas em processos como onboarding, análise de crédito e monitoramento de clientes. Com uma abordagem que reduz fraudes, elimina erros manuais e agiliza o cadastro, sua operação ganha eficiência sem perder o rigor regulatório, garantindo uma experiência fluida para o usuário final. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Route version:** v2 **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "tipo": "compliance-complete", "cpf": "00000000000", "homolog": true } ``` **In 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-complete","cpf":"00000000000","homolog":true}' ``` This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge. **Sample response, from the catalog** ```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": [] }, "consultas": { "contagem_consultas_31_a_60_dias": 1, "contagem_consultas_61_a_90_dias": 2, "contagem_consultas_mais_90_dias": 4, "contagem_consultas_ultimos_30_dias": 3, "detalhes_consultas": [ { "contagem_consultas": 1, "data_consulta": { "ano": "2026", "dia": "21", "mes": "02" }, "segmento": "4" }, { "contagem_consultas": 2, "data_consulta": { "ano": "2026", "dia": "10", "mes": "01" }, "segmento": "4" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2025", "dia": "17", "mes": "12" }, "segmento": "3" } ] }, "contatos": { "emails": [ { "email": "[omitido]", "ordem": 1, "tipo": "Pessoal" } ], "enderecos": [ { "bairro": "Centro", "cep": "30140071", "cidade": "Belo Horizonte", "logradouro": "Rua Exemplo Mock", "numero": "120", "ordem": 1, "uf": "MG" } ], "telefones": [ { "ddd": "31", "ds_tipo_telefone": "Movel", "dt_inclusao": "2024-11-08", "nr_ddi": null, "numero": "987654321", "ordem": 1, "uf_ddd": "MG" } ] }, "cpf": "00000000000", "dados_cadastrais": { "comprovante_rfb": null, "cpf": "00000000000", "ds_faixa_idade": "De 26 a 35", "ds_nacionalidade": null, "ds_orgao_emissor": "SSP", "ds_sexo": "Feminino", "ds_signo": "Leao", "ds_status_rfb": "REGULAR", "dt_atualizacao_rfb": "02-03-2026", "dt_inscricao": null, "dt_nasc": "1993-08-19", "nit_pis": null, "nm_social": null, "nome_completo": "MARIA EDUARDA SOUZA", "nome_mae": "ANA CLARA SOUZA", "nome_unico": false, "nr_cpf_mae": null, "nr_rg": "MG5566778", "nr_titulo_eleitoral": null, "sg_sexo": "F", "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" } }, "indicadores": { "pontualidade_de_pagamento": { "descricao": "Media", "descricao_complementar": "Consumidor com pagamentos majoritariamente em dia na media dos ultimos 12 meses." }, "relacionamento_com_mercado": { "descricao": "Alta", "descricao_complementar": "Comportamento financeiro compativel com o perfil esperado para produtos de credito." } }, "negativacoes": { "acoes_judiciais_apontamentos": [], "apontamentos": [], "ccf_apontamentos": [], "controle_pendencias_credito": "0", "data_ultimo_apontamento": { "ano": null, "dia": null, "mes": null } }, "obito": { "ano_obito": null, "data_obito": null, "fonte_obito": null, "mes_obito": null, "possivel_obito": null, "st_obito": false, "tipo_obito": null }, "participacao_societaria_em_empresas": [], "patrimonio": { "aeronaves": [], "imoveis": [], "imoveis_rurais": [], "mei": [], "participacoes_empresas": [], "st_empresario": false, "st_multiempresario": false }, "possui_dados_negativacoes": false, "protestos": [ { "cartorios": [], "cnpj": null, "cpf_cnpj": null, "data_consulta": "2026-03-04", "descricao_erro": null, "erro": null, "id_transacao": "mock-transacao-001", "retorno": "Sem protestos ativos", "situacao": "OK", "valor_protestados_total": null } ], "score_credito": { "descricao_probabilidade_pagamento": "A chance deste consumidor nao pagar nos proximos meses e de 9%.", "descricao_score": "Capacidade de pagamento acima da media da populacao.", "probabilidade_pagamento": "91% a 94%", "risco": "Baixo", "score": 812, "score_compromisso_pagamento": 92, "score_perfil": 57, "segmento": "4.0" }, "segmento": "4", "socioeconomico": { "cd_ocupacao": null, "ds_faixa_renda_presumida": "De R$ 2.500,01 a R$ 4.000,00", "ds_grau_escolaridade": "Ensino superior incompleto", "ds_ocupacao": "Assistente administrativo", "dt_faixa_renda_presumida": "2026-02-01", "dt_grau_escolaridade": "2019-12-12", "dt_ocupacao": "2025-09-19", "historico_ocupacoes": [] }, "status_cadastro_positivo": "1", "vinculo": { "empregador": [], "parentesco": [], "possiveis_colegas_trabalho": [], "socios": [] } } } } ``` In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes. ## Pitfalls: what an integration gets wrong without warning Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else: 1. **The error arrives in the BODY, with HTTP 200.** The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`. 2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.** Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them. 3. **Every call costs money.** Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling. 4. **HTTP 402 means insufficient balance, and retrying does not fix it.** It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx. 5. **`extra_charges` bills on top of the lookup price.** When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both. ## See also - OpenAPI specification: https://doc.apibrasil.io/apis/creditos/9273ef16-a6b7-4501-845b-93e137acdc9d/openapi.json - API catalog: [API catalog](https://doc.apibrasil.io/apis.md) - Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md) - Documentation index: https://doc.apibrasil.io/llms.txt - HTML version of this page: https://doc.apibrasil.io/apis/creditos/9273ef16-a6b7-4501-845b-93e137acdc9d