Busca por placa
Veículos
Busca por placa
Execute consultas veiculares por placa nos datasets selecionados.
POST
Busca por placa
Executa uma consulta veicular usando a placa informada e os datasets selecionados.
A consulta aceita placas no formato antigo e no padrão Mercosul. Pontuação, espaços e hífen são removidos automaticamente antes da validação.
Valores aceitos para
Estrutura de
Estrutura de
Estrutura de
Estrutura de
Estrutura de
O campo
Estrutura de
Objeto com o status individual de cada dataset.
Estrutura de
Objeto indexado pelo ID do dataset. Cada chave contém o retorno do dataset correspondente.
Estrutura de
Corpo da requisição
string
required
Placa do veículo. Aceita formato antigo e Mercosul.
string[]
required
Lista de IDs dos datasets veiculares que serão consultados.
object
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
string
default:"async"
Modo da consulta.
mode:
string
Use
sandbox para executar uma chamada de teste sem consumo de saldo.Para detalhes sobre chamadas de teste, consulte Ambiente de teste.
Exemplo de corpo
Regras da placa
O campoplate aceita os dois padrões principais de placas brasileiras:
A API normaliza o valor recebido antes da consulta, removendo hífen, espaços e pontuação.
Datasets veiculares
Antes de iniciar a consulta, liste os datasets disponíveis em Datasets e preços usando o tipovehicle.
Use apenas datasets com active: true.
Parâmetros adicionais por dataset
Alguns datasets podem exigir campos adicionais. Consulteadditional_fields no endpoint de datasets e preços para saber quais campos devem ser enviados.
Exemplo de envio de dados adicionais:
Resposta
integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal da consulta. A estrutura varia de acordo com o modo de execução.
Retorno síncrono
Quandomode é sync, a resposta pode retornar code: 200 com os dados completos da consulta.
Estrutura de result
Estrutura de result.query
Estrutura de result.cost
Estrutura de result.timing
Estrutura de result.errors
O campo errors retorna um objeto indexado pelo ID do dataset quando alguma base falha.
Estrutura de result.datasets_status
Objeto com o status individual de cada dataset.
Estrutura de result.result
Objeto indexado pelo ID do dataset. Cada chave contém o retorno do dataset correspondente.
Retorno assíncrono
Quandomode é async, a resposta inicial retorna code: 202 e o processamento continua em segundo plano.
Estrutura de result
Status possíveis:
Para consultar o resultado final, use o
id retornado no endpoint de resultado assíncrono com target: vehicle.
Respostas esperadas
As respostas possíveis estão exemplificadas no painel lateral da página.Fluxo recomendado
- Liste os datasets disponíveis em Datasets e preços usando
target: vehicle. - Selecione apenas datasets veiculares ativos.
- Envie a placa, os datasets e os campos adicionais necessários.
- Use
mode: "async"para iniciar a consulta e acompanhar o resultado depois. - Consulte o resultado em Resultado assíncrono usando
target: vehicle.

