Dados do Veículo

Essa API foca em trazer informações sobre o veículos assim como dados do último ano de licenciamento do veículo.

Nessa versão (async), o funcionamento da API ocorerrá de forma assíncrona, ou seja, será feita a solicitação recebendo um ID, este ID será utilizado para consultar em um momento posterior o resultado da análise. Com o uso do webhook é possível ser notificado quando a requisição tiver seu processamento finalizado.

Essa API funcionará em duas etapas:

1. Solicitação (POST /vehicles-async/v3)
2. Consulta (GET /vehicles-async/v3/:requestId)

Request | Nova pesquisa

POST /vehicles-async/v3

Body - Busca por Placa

Parâmetro	Descrição	Tipo	Observação	Obrigatório
licensePlate	Placa	String	Ex.: AAA1234	Sim
webhook	Webhook	Object		Não
webhook.url	URL	string	Obrigatório somente se passado o webhook.	Sim
webhook.method	Método HTTP	String	Enum: (POST, GET, PATCH, PUT). Default: POST	Não
webhook.headers	Método HTTP	Object		Não
webhook.body	Método HTTP	Object		Não

Exemplo Request

POST /vehicles-async/v3

TIP

Todos os parâmetros devem ser passados no body da requisição (json), diferente da versão síncrona.

Exemplos JSON

1. Exemplo requisição simples.

{
  "licensePlate": "JIF4461"
}

2. Exemplo requisição com webhook (somente URL, default POST).

{
  "licensePlate": "JIF4461",
  "webhook": {
    "url": "https://url-de-retorno/1234"
  }
}

3. Exemplo requisição com webhook completo.

{
  "licensePlate": "JIF4461",
  "webhook": {
    "url": "https://url-de-retorno/1234",
    "method": "PUT",
    "headers": {
      "Authorization": "TOKEN",
      "Content-Type": "application/json"
    },
    "body": {
      "msg": "Ok!",
      "meuId": "1234"
    }
  }
}

Response | Nova pesquisa

Campo	Descrição	Tipo
id	ID único da requisição	String
version	Versão da API	String
metada	Informações sobre a requisição	Object
metada.timeSpent	Tempo de resposta da requisição	Number

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

1. Exemplo quando a solicitação é feita com sucesso.

Status Code: 200

{
  "id": "07f7d23e-1820-43b5-baee-d5c36ad6a58f",
  "version": "v3Async",
  "metadata": {
    "timeSpent": 142
  }
}

Request | Consulta pesquisa

GET /vehicles-async/v3/:requestId

Body - Busca por Placa

Parâmetro	Descrição	Obrigatório
requestId	ID da pesquisa a ser consultada	Sim

Exemplo Request

GET /vehicles-async/v3/cc02bb73-1d62-423e-9ef6-047a7963d5c1

Response | Consulta pesquisa

Campo	Descrição	Tipo	Observação
id	ID único da requisição	String
version	Versão da API	String
data	Objeto com todas as informação da busca	Object
data.status	Status da requisição	String	Enum: (pending, sucessful, error)
data.requestId	ID da pesquisa consultada	String
data.licensePlate	ID da placa consultada	String
data.createdAt	Data e hora da criação da pesquisa	String	Formato timestamp
data.vehicleData	Objeto com o resultado da busca	Object
data.webhook	Webhook da pesquisa consultada	Object	Retornado conforme foi recebido na criação da consulta
metada	Informações sobre a requisição	Object
metada.timeSpent	Tempo de resposta da requisição	Number

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

1. Exemplo retorno aguardando processamento.

TIP

O ID na raíz do retorno irá identificar unicamente essa consulta. O ID da consulta em si retornará dentro do objeto data.

{
  "id": "ef2a3b1d-7041-49ab-8927-58f470ef33f6",
  "version": "v3",
  "data": {
    "status": "pending",
    "requestId": "cc02bb73-1d62-423e-9ef6-047a7963d5c1",
    "licensePlate": "JIF4461",
    "createdAt": "2025-04-07T20:36:24.868Z",
    "vehicleData": null,
    "webhook": null
  },
  "metadata": {
    "timeSpent": 165
  }
}

1. Exemplo retorno finalizado com sucesso.

{
  "id": "cc02bb73-1d62-423e-9ef6-047a7964d5c0",
  "version": "v3",
  "data": {
    "status": "sucessful",
    "requestId": "cc02bb73-1d62-423e-9ef6-047a7963d5c1",
    "licensePlate": "JIF4461",
    "createdAt": "2025-04-08T13:46:53.652Z",
    "vehicleData": {
      "licensePlate": "jif4461",
      "preMercosurLicensePlate": null,
      "chassis": "93YBSR7RHBJ781071",
      "chassisRemark": true,
      "engineNumber": "D4DH760Q157965",
      "licensePlateState": "DF",
      "licensePlateCity": "BRASILIA",
      "renavam": "00311900097",
      "invoicedDocumentType": null,
      "invoicedIdentificationNumber": "04621624000187",
      "invoiceState": "DF",
      "manufactureYear": 2011,
      "modelYear": 2011,
      "maxTractionCapacity": 2,
      "totalGrossWeight": 1,
      "restrictions": {
        "occurrence": null,
        "robberyOrTheft": false,
        "renajudRestrictionIndicator": false,
        "renainfRestrictionIndicator": false,
        "recall": false,
        "insuranceClaim": false
      },
      "status": null,
      "brandModel": "RENAULT/SANDERO EXP1016V",
      "brandModelCode": null,
      "vehicleGroup": "AUTOS",
      "vehicleType": "AUTOMOVEL",
      "kind": "PASSAGEIRO",
      "color": "PRATA",
      "fuel": "ALCOOL/GASOLINA",
      "category": "PARTICULAR",
      "origin": "NACIONAL",
      "potency": 77,
      "cylinders": 998,
      "axle": null,
      "capacity": 5,
      "fuelTankCapacityLiters": null,
      "loadCapacityKg": null,
      "yearOfLastLicensing": null,
      "activeFlag": null,
      "proprietaryName": "JOHN DOE",
      "proprietaryDocumentNumber": null,
      "proprietaryDocumentType": null,
      "alienationInstitutionName": null,
      "alienationInstitutionDocument": null,
      "licensedStatus": null,
      "licensedUntil": null,
      "client": {
        "name": "JOHN DOE",
        "motherName": null,
        "fatherName": null,
        "situation": null,
        "size": null,
        "opening": null,
        "legalNatureCode": null,
        "legalNatureDescription": null,
        "shareCapital": null,
        "legalName": "JOHN DOE",
        "documentNumber": "04583429126",
        "birthDate": null,
        "birthDateStr": null,
        "addresses": [],
        "activities": [],
        "partners": []
      }
    },
    "webhook": null
  },
  "metadata": {
    "timeSpent": 143
  }
}