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.

Request

GET /vehicles/v3

Parâmetros - Busca por Placa

Parâmetro	Descrição	Obrigatório
licensePlate	Placa	Sim

Parâmetros - Busca por Registro

Parâmetro	Descrição	Obrigatório
registryId	Registro	Sim

Parâmetros - Busca por Chassis

Parâmetro	Descrição	Obrigatório
chassis	Chassis	Sim

Response

Campo	Descrição	Tipo
id	ID único da requisição	String
version	Versão da API	String
data	Objeto com o resultado da busca	Object

Exemplo Request

GET /vehicles/v3?licensePlate=AAA0001

TIP

Os parâmetros devem ser passados somente letras ou números, ex.: Placa AAA0001.

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

1. Exemplo quando dados encontrados

Status Code: 200

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v3",
  "data": {
    "debitTypeGuid": "d5ac9023-352d-4576-b70d-9878251af76d",
    "licensePlate": "FCN0000",
    "preMercosurLicensePlate": null,
    "chassis": "1N6LD16Y8PE413118",
    "chassisRemark": false,
    "engineNumber": "123456",
    "licensePlateState": "SC",
    "licensePlateCity": "RODEIO",
    "renavam": "00132972070",
    "InvoicedDocumentType": null,
    "InvoicedIdentificationNumber": null,
    "invoiceState": "DF",
    "manufactureYear": 1992,
    "modelYear": 1992,
    "maxTractionCapacity": 230,
    "totalGrossWeight": 140,
    "restrictions": {
      "renainfRestrictionIndicator": false,
      "renajudRestrictionIndicator": true,
      "rfbRestrictionIndicator": false,
      "robberyOrTheft": false,
      "occurrence": "ALIENACAO FIDUCIARIA, COMUNICACAO DE VENDA",
      "recall": false,
      "insuranceClaim": true
    },
    "status": "EM CIRCULACAO",
    "brandModel": "FORD/KA FLEX",
    "brandModelCode": 201191,
    "vehicleGroup": "AUTOS",
    "vehicleType": "AUTOMOVEL",
    "kind": "MISTO",
    "color": "CINZA",
    "fuel": "GASOLINA/GAS NATURAL VEICULAR",
    "category": "PARTICULAR",
    "origin": "NACIONAL",
    "potency": 173,
    "cylinders": 2488,
    "axle": 2,
    "capacity": 5,
    "fuelTankCapacityLiters": 60,
    "loadCapacityKg": 400,
    "yearOfLastLicensing": 2023,
    "proprietaryName": "EMPRESA LTDA - ME",
    "proprietaryDocumentNumber": "11312062000178",
    "proprietaryDocumentType": "CNPJ",
    "alienationInstitutionName": "banco votorantim s.a.",
    "alienationInstitutionDocument": "59588111000103",
    "licensedStatus": "regular",
    "licensedUntil": "regular até 31 de dezembro de 2024",
    "client": {
      "name": "EMPRESA LTDA - ME",
      "situation": "baixada",
      "size": "micro empresa",
      "opening": "2011-03-01T03:00:00.000Z",
      "legalNatureCode": "206-2",
      "legalNatureDescription": "sociedade empresária limitada",
      "shareCapital": null,
      "legalName": "empresa ltda",
      "documentNumber": "13316566000179",
      "birthDate": null,
      "contacts": {
        "phones": [
          "4733240476",
          "4733640252"
        ],
        "emails": [
          "emailempresa@terra.com.br"
        ]
      },
      "addresses": [
        {
          "street": "RUA BARAO DO RIO BRANCO",
          "number": "2163",
          "neighborhood": "GAVEA",
          "zipcode": "89136000",
          "city": "RODEIO"
        }
      ],
      "activities": [
        {
          "code": "00.00-0-00",
          "description": "Não informada"
        }
      ],
      "partners": [
        {
          "name": "SOLANGE SOLAR",
          "document": null,
          "type": "22-Sócio"
        },
        {
          "name": "JAIR NESSIAS",
          "document": null,
          "type": "49-Sócio-Administrador"
        }
      ]
    }
  },
  "metadata": {
    "timeSpent": 10000
  }
}

1. Exemplo quando dados não são encontrados para aquela placa

Status Code: 404

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v3",
  "error": {
    "statusCode": 404,
    "error": "Not Found",
    "message": "Dados não encontrados para a placa informada"
  }
}