Skip to main content
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.

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.
Valores aceitos para 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

A placa acima é fictícia e serve apenas para demonstrar a estrutura da requisição. Em chamadas reais ou sandbox, informe uma placa válida para o ambiente utilizado.

Regras da placa

O campo plate 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 tipo vehicle. Use apenas datasets com active: true.

Parâmetros adicionais por dataset

Alguns datasets podem exigir campos adicionais. Consulte additional_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

Quando mode é 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.
Campos descritos na estrutura do dataset podem não ser retornados em todas as consultas. Alguns dados dependem da disponibilidade da fonte e da placa consultada.

Retorno assíncrono

Quando mode é 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

  1. Liste os datasets disponíveis em Datasets e preços usando target: vehicle.
  2. Selecione apenas datasets veiculares ativos.
  3. Envie a placa, os datasets e os campos adicionais necessários.
  4. Use mode: "async" para iniciar a consulta e acompanhar o resultado depois.
  5. Consulte o resultado em Resultado assíncrono usando target: vehicle.