--- title: "Acerta Essencial" description: "API Consulta de CPF - Decisões Ágeis com Dados Confiáveis" lang: en canonical: https://doc.apibrasil.io/apis/creditos/e37d6c51-4ce2-45fe-98ea-9d0966ea0f3a markdown: https://doc.apibrasil.io/apis/creditos/e37d6c51-4ce2-45fe-98ea-9d0966ea0f3a.md source: apibrasil-documentation --- # Acerta Essencial > API Consulta de CPF - Decisões Ágeis com Dados Confiáveis - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$3.50 per query - **Limit:** 990,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/e37d6c51-4ce2-45fe-98ea-9d0966ea0f3a/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 Acerta Essencial - Consulta Completa de Créditos para CPF em Instantes A API Acerta Essencial permite que você consulte rapidamente informações essenciais de crédito a partir do CPF, trazendo respostas precisas e em tempo real para tomada de decisão. Com integração facilitada via POST, sua empresa ganha agilidade e segurança para avaliar concessão de crédito, prevenir fraudes e aprimorar processos de cadastro. Otimize sua operação e ofereça mais valor aos seus clientes, integrando todas as respostas da Acerta Essencial diretamente no seu sistema – rapidez, confiabilidade e inteligência ao alcance da sua equipe! - **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 { "cpf": "00000000000", "tipo": "acerta-essencial", "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 '{"cpf":"00000000000","tipo":"acerta-essencial","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": "248,660", "balance_before": "248,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": { "acertaEssencialPositivo": { "consultaCredito": { "acoesCiveis": [], "chequesSemFundo": [], "chequesSustados": [], "creditoObtido": [], "dadosCadastrais": { "bairro": "MARIA VIRGINIA", "cep": "31155320", "cidade": "BELO HORIZONTE", "cpf": "00000000000", "dataNascimento": "02/06/1990", "endereco": "MEIRA DE VASCONCELOS", "estadoCivil": "NÃO INFORMADO", "grauInstrucao": "Não informado", "nome": "FULANO DE TAL EXEMPLO", "nomeMae": "MARIA EXEMPLO DE TAL", "numeroDependentes": "0", "regiaoCPF": "MG", "rendaPresumida": "Até R$ 1.400", "sexo": "MASCULINO", "situacao": "Regular", "textoRendaPresumida": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "tituloEleitor": "0000000000000", "uf": "MG" }, "historicoConsultas": [ { "data": "31/07/2025", "empresa": "NUBANK BV 1" } ], "participacaoEmEmpresas": [], "pendenciasFinanceiras": [], "protestos": [], "resumoConsulta": { "acoesCiveis": { "quantidadeTotal": 0, "valorTotal": 0 }, "chequesSemFundo": { "quantidadeTotal": 0 }, "chequesSustados": { "quantidadeTotal": 0 }, "pendenciasFinanceiras": { "quantidadeTotal": 0, "valorTotal": 0 }, "protestos": { "quantidadeTotal": 0, "valorTotal": 0 } }, "score": { "decisao": 0, "mensagem": "É provável que 66% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses.", "probabilidade": "03400", "score": "198" } }, "prioridade": 1, "providerId": 1, "statusRetorno": 1 }, "protestoNacional": { "ocorrencias": [], "prioridade": 2, "resumoConsulta": { "protestos": { "quantidadeTotal": 0, "valorTotal": 0 } }, "statusRetorno": 1 }, "resumoRetorno": { "cliente": 171, "codigoConsulta": 23, "dataConsulta": "05/09/2025 | 17:17", "document": "00000000000", "pdf": "", "pdfBase64": "", "protocolo": "eb0add72a7e849d", "tempoExecucao": 0.01 } } } ``` 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/e37d6c51-4ce2-45fe-98ea-9d0966ea0f3a/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/e37d6c51-4ce2-45fe-98ea-9d0966ea0f3a