Sign In

Disponibilidade do serviço

Last updated

GET /health informa a disponibilidade geral das modalidades da API. É público, não recebe corpo, não exige chave e não gera cobrança.

Requisição

curl 'https://api.verifica-online.com.br/health'

Resposta

HTTP status Condição
200 ok Todos os datasets estão classificados como operational.
503 unavailable Pelo menos um dataset está classificado como unavailable.
Campo Tipo Descrição
status string ok ou unavailable.
timestamp string Data e hora da leitura, em ISO 8601 UTC.
datasets array de objects Lista das 14 modalidades do catálogo.
datasets[].key string Identificador do dataset.
datasets[].status string operational ou unavailable.
error object Presente na resposta 503.
error.code string service_unavailable.
error.message string Mensagem da indisponibilidade geral.
error.request_id string Identificador da requisição HTTP de leitura.

Exemplo ilustrativo com uma modalidade indisponível:

{
  "status": "unavailable",
  "timestamp": "2026-10-03T02:30:00.000Z",
  "datasets": [
    { "key": "cpf_dados_completos", "status": "operational" },
    { "key": "cpf_dados_basicos", "status": "operational" },
    { "key": "cpf_enderecos", "status": "operational" },
    { "key": "cpf_telefones", "status": "operational" },
    { "key": "cpf_emails", "status": "operational" },
    { "key": "cpf_processos", "status": "operational" },
    { "key": "cpf_score_quod", "status": "operational" },
    { "key": "cpf_score_boa_vista", "status": "operational" },
    { "key": "cnpj_dados_basicos", "status": "operational" },
    { "key": "cnpj_processos", "status": "operational" },
    { "key": "cnpj_score_quod", "status": "operational" },
    { "key": "cnpj_score_boa_vista", "status": "operational" },
    { "key": "veicular_completa", "status": "unavailable" },
    { "key": "consulta_placa", "status": "operational" }
  ],
  "error": {
    "code": "service_unavailable",
    "message": "Serviço temporariamente indisponível.",
    "request_id": "92c4f9d8-3868-4125-a47f-34b93543bf81"
  }
}

Na resposta 200, status é ok, todos os itens são operational e o campo error não é enviado.

Interpretação

O endpoint informa o estado geral das modalidades no momento da leitura. Um estado operational não garante que uma consulta futura encontre dados ou termine com sucesso.

A resposta não avalia saldo, preço individual, situação da conta ou permissão de uma chave. A habilitação atual do processamento em lote é informada por batch.enabled no catálogo autenticado. Esse campo não garante capacidade de admissão: os limites da conta e a capacidade compartilhada são avaliados na criação de cada lote.

Um 503 geral não significa que todas as modalidades estejam indisponíveis. A lista datasets identifica a condição de cada uma. Entre 23h, inclusive, e 3h, exclusive, no fuso America/Sao_Paulo, veicular_completa fica indisponível para novas operações e, por isso, o estado geral será unavailable, mesmo que as outras modalidades permaneçam operacionais.

Integração com monitoramento

A decisão de executar uma modalidade deve combinar a leitura do catálogo da conta com o tratamento dos erros da operação real. O estado geral pode ser usado para monitoramento, enquanto a condição de cada dataset permite distinguir indisponibilidade parcial.

As respostas incluem o cabeçalho Cache-Control: no-store. Ao monitorar, registre o horário da leitura e o estado observado. Uma leitura antiga não confirma a disponibilidade atual.

Referências