Verifica Online API

A Verifica Online API oferece consultas de pessoas, empresas e veículos por HTTPS, com entrada e saída em JSON, autenticação por chave de API e consumo de saldo pré-pago em reais. Cada modalidade é identificada por uma chave de dataset e possui contrato próprio de entrada e de resultado.

URL base

https://api.verifica-online.com.br

Os caminhos desta documentação são relativos à URL base. As rotas de integração não utilizam prefixo /api.

Preparação da integração

1. Cadastro de uma conta no portal da API, confirmação do e-mail e aceite dos Termos de Uso vigentes.
2. Criação de uma chave na área Chaves de API. O segredo completo é exibido somente na criação.
3. Recarga do saldo para executar consultas cobradas.
4. Leitura de GET /datasets para obter preço efetivo da conta, disponibilidade e schemas.
5. Envio de uma consulta com Authorization, Content-Type e uma chave de idempotência mantida pela integração.

A conta, as credenciais e o saldo da API são independentes dos demais serviços do Verifica Online. O uso de dados pessoais exige finalidade legítima e fundamento legal próprio, conforme os Termos de Uso e a Política de Privacidade.

O saldo é crédito para uso nas consultas, sem opção de saque, retirada ou conversão em dinheiro. Não há reembolso por opção de deixar de utilizar os créditos, ressalvadas as hipóteses legalmente asseguradas ou de obrigação decorrente da oferta contratada. Os Termos de Uso detalham essas condições e o atendimento para pedidos cabíveis.

Primeira consulta

curl --request POST \
  'https://api.verifica-online.com.br/datasets/cpf_dados_basicos/queries' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: cadastro-exemplo-0001' \
  --data '{"cpf":"52998224725"}'

<API_KEY> representa o segredo emitido no portal. Os documentos, nomes, placas e resultados dos exemplos são ilustrativos; não representam autorização para consultar terceiros nem garantem a existência de dados.

Uma resposta concluída contém o identificador persistente da consulta, seu estado, a cobrança e o objeto data específico do dataset. O objeto pode conter campos nulos ou listas vazias sem que a consulta deixe de ser bem-sucedida. Uma consulta sem dados retorna status: "no_data", data: null e não é cobrada.

O código HTTP deve ser interpretado junto ao campo status. Uma consulta em processamento retorna 202. A recuperação de uma consulta já concluída pode retornar 200 mesmo quando seu estado é failed.

Rotas públicas

Leituras do catálogo, da disponibilidade, das métricas e dos resultados existentes não geram cobrança de consulta.

Catálogo de consultas

O suporte a lote indica compatibilidade do contrato. A admissão de novos lotes depende também de batch.enabled no catálogo. A consulta veicular_completa fica indisponível para novas operações entre 23h e 3h, no fuso America/Sao_Paulo.

Convenções

• Valores monetários com sufixo _cents são inteiros em centavos de BRL.
• Datas e horários do envelope são strings ISO 8601 em UTC. Datas cadastrais e outros campos seguem o formato descrito em cada dataset.
• CPF e CNPJ são strings sem máscara e com dígitos verificadores válidos. CNPJ aceita letras maiúsculas nas posições previstas pelo contrato.
• Placas brasileiras aceitam os formatos ABC1234 e ABC1D23, com normalização de letras, espaços e hífen.
• null indica ausência de um objeto ou valor quando admitido pelo schema. Uma lista vazia indica ausência de itens retornados.
• Respostas da API utilizam Cache-Control: no-store.

Guias de integração