Pular para o conteúdo principal

Realizar uma consulta

Para iniciar uma consulta, envie a tag do tipo de consulta e a placa ou o chassi do veículo.

Requisição

POST {{host}}/query/new
Content-Type: application/json
x-api-key: {{api-key}}

Corpo da requisição

Com placa:

{
"tag": "AGGREGATE",
"licensePlate": "RMN9G52"
}

Com chassi:

{
"tag": "AGGREGATE",
"chassis": "9BWZZZ377VT004251"
}
CampoObrigatórioDescrição
tagSimIdentificador do tipo de consulta (ex.: AGGREGATE)
licensePlateUm dos doisPlaca do veículo (sem hífen)
chassisUm dos doisChassi do veículo

Informe placa ou chassi — não é necessário enviar os dois.

Resposta

A requisição apenas aceita a consulta para processamento. O resultado completo será enviado para o webhook configurado na sua chave de API quando a consulta estiver pronta.

Consulte Chave de API e webhook para configurar a URL de recebimento.

Exemplo de retorno via webhook (AGGREGATE)

Quando a consulta for concluída com sucesso, seu webhook recebe um payload semelhante a este:

{
"id": "698b97aff3b697fbce1fd981",
"type": "AGGREGATE",
"status": "SUCCESS",
"response": {
"agregados": {
"anoFabricacao": "2021",
"anoModelo": "2021",
"caixaCambio": null,
"capacidadeCarga": null,
"capacidadePassageiro": "5",
"capMaxTracao": null,
"categoria": null,
"chassi": "999999999999999",
"municipio": null,
"cilindradas": 999,
"codigoCombustivel": null,
"codigoMarca": null,
"codigoMarcaModelo": "102652",
"codigoMunicipio": null,
"combustivel": "ALCOOL/GASOLINA",
"corVeiculo": "PRATA",
"dataEmplacamento": "1970-01-01T00:00:00.000Z",
"docFaturado": null,
"docProprietario": null,
"documentoImportadora": null,
"dtUltimaAtualizacao": null,
"eixos": "2",
"eixoTraseiroDif": null,
"especieVeiculo": "PASSAGEIRO",
"familia": null,
"identImportadora": null,
"inspecaoGnv": null,
"limiteRestricaoTrib": null,
"marca": "FIAT",
"marcaModelo": null,
"modelo": "MOBI",
"municipioEmplacamento": null,
"nacionalidade": "NACIONAL",
"numCarroceria": null,
"numFaturado": "167909999999999",
"numMotor": null,
"numTerceiroEixo": null,
"pbt": null,
"pesoBrutoTotal": "134",
"placa": "ABC1234",
"potencia": 75,
"procedencia": "NACIONAL",
"qtdPax": null,
"renavam": "999999999999999",
"situacaoChassi": "N",
"situacaoVeiculo": "S",
"tipoCarroceria": "Não Aplicável",
"tipoDocFaturado": "JURÍDICA",
"tipoDocImportadora": "DESCONHECIDO",
"tipoMontagem": 1,
"tipoVeiculo": "AUTOMOVEL",
"uf": null,
"ufFaturado": null,
"ultimaDataInclusao": null,
"valorAnunciado": null
}
},
"servicesBroken": [],
"keys": {
"licensePlate": "ABC1234"
},
"createdAt": "2026-02-10T20:40:15.828Z",
"updatedAt": "2026-02-10T20:40:19.559Z"
}
CampoDescrição
idIdentificador único da consulta
typeTipo da consulta (AGGREGATE)
statusStatus do processamento (SUCCESS, FAILED, etc.)
response.agregadosDados agregados do veículo
servicesBrokenServiços que falharam durante a consulta (vazio quando tudo ok)
keysChaves utilizadas na consulta (placa ou chassi)
createdAt / updatedAtDatas de criação e atualização da consulta