Consultas Veiculares

As consultas veiculares são o principal recurso da API Checktudo. Este guia cobre tudo que você precisa saber para realizar consultas de forma eficiente.

Base URL

https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com

Visão Geral

A API permite consultar informações de veículos através de diferentes chaves de busca. Você pode combinar múltiplas chaves na mesma requisição para maior precisão.

Chaves Disponíveis

Chave	Descrição	Formato	Exemplo
licensePlate	Placa do veículo	ABC1234 ou ABC1D23	ABC1234
chassis	Número do chassi	17 caracteres	9BWZZZ377VT004251
renavam	Código Renavam	11 dígitos	00123456789
engineNumber	Número do motor	Alfanumérico	ABC123456
uf	Estado (UF)	2 caracteres	SP

Combinando Múltiplas Chaves

Você pode enviar várias chaves na mesma consulta. A API utilizará todas as chaves fornecidas para localizar o veículo:

// Apenas placa
{ "keys": { "licensePlate": "ABC1234" } }

// Placa + Chassi (maior precisão)
{ "keys": { "licensePlate": "ABC1234", "chassis": "9BWZZZ377VT004251" } }

// Apenas Renavam
{ "keys": { "renavam": "00123456789" } }

// Chassi + UF
{ "keys": { "chassis": "9BWZZZ377VT004251", "uf": "SP" } }

Dica

Quanto mais chaves você fornecer, mais precisa será a identificação do veículo.

Templates Disponíveis

Os templates definem quais informações serão retornadas. Cada template tem um custo diferente baseado na quantidade de dados.

Slug	Descrição
agregados	Consulta agregada com dados básicos do veículo
veiculo-total-mais	Consulta completa com todos os dados disponíveis

Como realizar consultas

Para um guia passo a passo de como realizar consultas, veja o Início Rápido.

Detalhes de cada endpoint

Para ver a resposta completa, todos os campos retornados e testar os endpoints interativamente, acesse a API Reference.

Tratamento de Erros

Erros Comuns

Código	Erro	Causa	Solução
400	INVALID_LICENSE_PLATE	Placa em formato inválido	Verifique o formato (ABC1234)
400	MISSING_REQUIRED_KEY	Chave obrigatória ausente	Inclua todas as chaves requeridas
402	INSUFFICIENT_BALANCE	Saldo insuficiente	Adicione créditos
404	VEHICLE_NOT_FOUND	Veículo não encontrado	Verifique os dados informados
503	SOURCE_UNAVAILABLE	Fonte indisponível	Tente novamente em alguns minutos

Exemplo de Erro

{
  "statusCode": 400,
  "error": {
    "code": "INVALID_LICENSE_PLATE",
    "message": "A placa informada está em formato inválido. Use o formato ABC1234 ou ABC1D23.",
    "field": "keys.licensePlate"
  }
}

Boas Práticas

1. Cache de resultados: Armazene consultas recentes para evitar custos repetidos
2. Validação prévia: Valide o formato da placa antes de enviar
3. Verifique duplicidade: Use o parâmetro duplicity: true se precisar repetir uma consulta em menos de 1 hora

Próximos Passos

• Início Rápido - Guia passo a passo
• API Reference - Teste os endpoints
• CRLV Digital
• Consultas em Lote