--- title: "VAR" description: "API VAR - Validação de CPF em tempo real para decisões mais seguras" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/4b9bfb74-7eb1-48e0-8477-5247e344e461 markdown: https://doc.apibrasil.io/apis/creditos/4b9bfb74-7eb1-48e0-8477-5247e344e461.md source: apibrasil-documentation --- # VAR > API VAR - Validação de CPF em tempo real para decisões mais seguras - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 1,78 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/4b9bfb74-7eb1-48e0-8477-5247e344e461/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 VAR - Mais segurança e inteligência na análise de crédito em tempo real A API VAR permite consultar CPF e informações de crédito em segundos, diretamente dentro do seu sistema, acelerando decisões e reduzindo riscos. Com integração rápida via método POST no endpoint de consulta/cpf/credits, você passa os dados essenciais e recebe um retorno estruturado com o perfil de crédito do consumidor para automatizar regras, limites e aprovações. Essa inteligência integrada aumenta a taxa de aprovação com segurança, evita inadimplência e melhora a experiência do cliente final. Use a API VAR para enriquecer cadastros, apoiar motores de decisão, personalizar ofertas financeiras e ter um fluxo de crédito mais ágil, confiável e lucrativo. - **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": "var", "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":"var","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": { "resultados": [ { "cadastral": { "comprovante_rfb": "MOCK-HML-0001", "ds_faixa_idade": "De 26 a 35", "ds_nacionalidade": "Brasileira", "ds_orgao_emissor": "SSP-MG", "ds_sexo": "Feminino", "ds_signo": "Virgem", "ds_status_rfb": "REGULAR", "dt_atualizacao_rfb": "2025-03-01", "dt_inscricao": "15/08/2010", "dt_nasc": "1992-09-12", "nit_pis": null, "nm_completo": "HELENA MOCK SILVA HOMOLOG", "nm_mae": "ROSA MOCK SILVA HOMOLOG", "nm_social": "HELENA MOCK SILVA HOMOLOG", "nome_unico": false, "nr_cpf": "00000000000", "nr_cpf_mae": null, "nr_rg": "MG99112233", "nr_titulo_eleitoral": null, "sg_sexo": "F", "sg_sg_uf_rg": "MG", "st_menor_idade": false, "st_pep": false, "st_ppp": false }, "contato": { "ds_email": [ { "cd_ordem": 1, "ds_email": "[omitido]", "dt_inclusao": "2025-02-18" }, { "cd_ordem": 2, "ds_email": "[omitido]", "dt_inclusao": "2024-11-05" } ], "endereco": [ { "caracteristicas": "Residencial", "cd_ordem": 1, "ds_bairro": "JARDIM DADOS FICTICIOS", "ds_cidade": "CIDADE HOMOLOG", "ds_complemento": "BL Z AP 101", "ds_logradouro": "RUA SEM NUMERO REAL 5000", "ds_regiao": "SUDESTE", "dt_informacao": "2025-02-20", "latitude": "-19.750000", "longitude": "-43.940000", "nr_nr_cep": "30130000", "nr_numero": "10", "outras_grafias": null, "sg_sg_uf": "MG", "sg_tipo_logradouro": "RUA" }, { "caracteristicas": "Comercial", "cd_ordem": 2, "ds_bairro": "DISTRITO MOCK INDUSTRIAL", "ds_cidade": "POLO FICTICIO", "ds_complemento": "GALPAO 9", "ds_logradouro": "AV INEXISTENTE NO CADASTRO 200", "ds_regiao": "SUDESTE", "dt_informacao": "2024-12-01", "latitude": "-20.100000", "longitude": "-44.200000", "nr_nr_cep": "32600000", "nr_numero": "2500", "outras_grafias": null, "sg_sg_uf": "MG", "sg_tipo_logradouro": "AV" } ], "nr_telefone": [ { "cd_ordem": 1, "ds_tipo_nr_telefone": "Movel", "dt_inclusao": "2025-02-18", "nr_ddd": "31", "nr_ddi": "55", "nr_nr_telefone": "900001111", "sg_uf_ddd": "MG" }, { "cd_ordem": 2, "ds_tipo_nr_telefone": "Fixo", "dt_inclusao": "2024-11-05", "nr_ddd": "31", "nr_ddi": "55", "nr_nr_telefone": "30001111", "sg_uf_ddd": "MG" } ] }, "nr_cpf": "00000000000", "obito": { "ano_obito": null, "dt_obito": null, "fonte_obito": null, "mes_obito": null, "possivel_obito": false, "st_obito": false, "tipo_obito": null }, "socioeconomico": { "cd_ocupacao": "212405", "cfm": [], "ds_faixa_renda_presumida": "De R$ 3.000,01 a R$ 6.000,00", "ds_grau_escolaridade": "Ensino Medio Completo", "ds_ocupacao": "Analista de sistemas (mock)", "dt_faixa_renda_presumida": "2025-02-01", "dt_grau_escolaridade": "2024-12-01", "dt_ocupacao": "2025-02-01", "historico_ocupacoes": [ { "ano": "2025", "cbo": "212405", "ds_ocupacao": "Analista de sistemas (mock)", "faixa_renda_presumida": 5100, "renda_presumida": "5.100,00" }, { "ano": "2024", "cbo": "411010", "ds_ocupacao": "Assistente administrativo (mock)", "faixa_renda_presumida": 2800, "renda_presumida": "2.800,00" } ] }, "vinculo": { "empregador": [ { "cd_ordem": 1, "dt_admissao": "2022-07-11", "dt_demissao": null, "dt_informacao": "2025-02-18", "nr_cnpj": "11222333000181", "razao_social": "EMPRESA TOTALMENTE FICTICIA VAR LTDA" } ], "parentesco": [ { "cd_ordem": 1, "ds_vinculo": "Irma", "dt_informacao": "2024-10-10", "nm_completo": "MARINA MOCK SILVA HOMOLOG", "nr_cpf": "11144477735" } ], "possiveis_colegas_trabalho": [ { "cd_ordem": 1, "nm_completo": "PEDRO MOCK OLIVEIRA HOMOLOG", "nr_cpf": "52998224725" }, { "cd_ordem": 2, "nm_completo": "JULIA MOCK COSTA HOMOLOG", "nr_cpf": "39053344705" } ], "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/4b9bfb74-7eb1-48e0-8477-5247e344e461/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/4b9bfb74-7eb1-48e0-8477-5247e344e461