--- title: "Acerta Essencial Plus" description: "API Cadastro e Crédito - Decisões Rápidas e Seguras" lang: en canonical: https://doc.apibrasil.io/apis/creditos/9ec5e44b-da99-4c6f-8aec-3d74674e641a markdown: https://doc.apibrasil.io/apis/creditos/9ec5e44b-da99-4c6f-8aec-3d74674e641a.md source: apibrasil-documentation --- # Acerta Essencial Plus > API Cadastro e Crédito - Decisões Rápidas e Seguras - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$4.49 per query - **Limit:** 990,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/9ec5e44b-da99-4c6f-8aec-3d74674e641a/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 de Análise de Crédito - Decisão Rápida e Segura Com a Acerta Essencial Plus, você integra em minutos uma potente consulta de dados cadastrais e financeiros de CPF ao seu sistema, potencializando sua análise de crédito, validação de identidade e prevenção à fraude. Nossa API reúne informações detalhadas de múltiplas fontes confiáveis, retornando um panorama preciso e atualizado do perfil financeiro do consumidor em tempo real. É a escolha ideal para negócios que buscam agilidade, segurança e qualidade nas decisões, impulsionando a aprovação de crédito e garantindo compliance regulatório com confiança. - **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-positivo", "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-positivo","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 { "error": false, "message": "Requisição processada com sucesso", "balance": "4.971,310", "response": { "error": false, "message": "Requisição realizada com sucesso", "data": { "dados": [ { "acertaEssencialPositivo": { "consultaCredito": { "acoesCiveis": [], "chequesSemFundo": [], "chequesSustados": [], "creditoObtido": [], "dadosCadastrais": { "bairro": "SAGRADA FAMILIA", "cep": "31030071", "cidade": "BELO HORIZONTE", "cpf": "09906747625", "dataNascimento": "01/09/1990", "endereco": "RUA EXEMPLO", "estadoCivil": "NÃO INFORMADO", "grauInstrucao": "Não informado", "nome": "JOAO DA SILVA", "nomeMae": "MARIA DA SILVA", "numeroDependentes": "0", "regiaoCPF": "MG", "rendaPresumida": "De R$ 1.401 até R$ 2.000", "sexo": "MASCULINO", "situacao": "Regular", "telefone": "31999999999", "textoRendaPresumida": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "tituloEleitor": "0000000000000", "uf": "MG" }, "historicoConsultas": [ { "data": "07/08/2025", "empresa": "EMPRESA EXEMPLO LTDA" } ], "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 96% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses.", "probabilidade": "00400", "score": "556" } }, "prioridade": 1, "providerId": 1, "statusRetorno": 1 }, "resumoRetorno": { "cliente": 171, "codigoConsulta": 12, "dataConsulta": "05/09/2025 | 15:29", "document": "09906747625", "pdf": "", "pdfBase64": "", "protocolo": "27d8f49167a343b", "tempoExecucao": 0.02 }, "scoreRating": { "prioridade": 2, "score": 850, "statusRetorno": 1 } } ], "homolog": true, "msg": "consulta realizada com sucesso!", "status": true } }, "tax": "0.340", "api_limit_for": "credit" } ``` ## 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/9ec5e44b-da99-4c6f-8aec-3d74674e641a/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/9ec5e44b-da99-4c6f-8aec-3d74674e641a