Consulta de agregados

Para iniciar uma consulta de agregados, envie a tag AGGREGATE junto com 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": "ABC1234"
}

Com chassi:

{
  "tag": "AGGREGATE",
  "chassis": "9BWZZZ377VT004251"
}

Campo	Obrigatório	Descrição
tag	Sim	Identificador do tipo de consulta (ex.: AGGREGATE)
licensePlate	Um dos dois	Placa do veículo (sem hífen)
chassis	Um dos dois	Chassi do veículo

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

Resposta via webhook

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:

{
  "tag": "AGGREGATE",
  "data": {
    "queryId": "698b97aff3b697fbce1fd981",
    "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": []
  }
}

Campo	Descrição
tag	Tipo da consulta (AGGREGATE)
data.queryId	Identificador único da consulta
data.status	Status do processamento (SUCCESS, FAILED, etc.)
data.response	Resultado da consulta. Pode ser null quando não houver dados disponíveis.
data.response.agregados	Dados agregados do veículo
data.servicesBroken	Serviços que falharam durante a consulta (vazio quando tudo ok)