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
A API normaliza o valor recebido antes da consulta, removendo hífen, espaços e pontuação.
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
Status possíveis:
Para consultar o resultado final, use o
Corpo da requisição
Placa do veículo. Aceita formato antigo e Mercosul.
Lista de IDs dos datasets veiculares que serão consultados.
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
Modo da consulta.
mode:
| Valor | Descrição |
|---|---|
async | Inicia a consulta e retorna um id para acompanhar o resultado depois. |
sync | Aguarda a conclusão da consulta e retorna os dados diretamente na resposta. |
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:
| Formato | Exemplo estrutural | Descrição |
|---|---|---|
| Antigo | ABC1234 | Três letras seguidas de quatro números. |
| Mercosul | ABC1D23 | Três letras, um número, uma letra e dois números. |
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
Código da resposta da API.
Mensagem descritiva da resposta.
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
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único da consulta. |
status | string | Status final da consulta. Normalmente completed. |
target | string | Tipo da consulta. Para esta rota, retorna vehicle. |
query | object | Dados usados na consulta. |
cost | object | Valores cobrados e estornados. |
timing | object | Tempo total e tempo individual por dataset. |
errors | object | Erros por dataset, quando ocorrerem. |
datasets_status | object | Status individual de cada dataset. |
result | object | Resultado agrupado por dataset. |
created_at | string | Data de criação da consulta em ISO 8601. |
last_updated_at | string | Data da última atualização da consulta em ISO 8601. |
Estrutura de result.query
| Campo | Tipo | Descrição |
|---|---|---|
plate | string | Placa consultada, normalizada sem pontuação. |
datasets | array<string> | Datasets solicitados. |
additional | object | Dados adicionais enviados por dataset. |
Estrutura de result.cost
| Campo | Tipo | Descrição |
|---|---|---|
total | number | Valor total debitado após regras de retorno e estorno. |
refunded | number | Valor total estornado. |
datasets | object | Detalhamento de cobrança por dataset. |
Estrutura de result.timing
| Campo | Tipo | Descrição |
|---|---|---|
total | number | Tempo total da consulta em segundos. |
datasets | object | Tempo individual de cada dataset em segundos. |
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
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador da consulta assíncrona. |
status | string | Status atual da consulta. |
status_values | array<string> | Lista de status possíveis. |
datasets | array<string> | Datasets solicitados na consulta. |
| Status | Descrição |
|---|---|
queued | Consulta criada e aguardando processamento. |
processing | Consulta em processamento. |
completed | Consulta finalizada. Verifique o resultado, erros e status por dataset no endpoint de resultado. |
failed | Consulta finalizada com falha geral. |
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.| Status | Quando ocorre |
|---|---|
200 | Consulta síncrona concluída com sucesso. |
202 | Consulta assíncrona iniciada com sucesso. |
400 | Requisição inválida, placa inválida, dataset ausente ou parâmetro incompatível. |
401 | A chave da API está ausente, inválida ou não pôde ser autenticada. |
403 | A credencial não possui escopo de consulta, o plano não permite acesso ou há bloqueio financeiro. |
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.

