VIN Search

Get vehicle details from a VIN.

The Vehicle VIN API allows you to search for vehicles by VIN. The request requires only a region, VIN, and API key. It will either return a matching vehicle with possible option packs or a null.

Get a vehicle by its VIN

GET/v2/vehicles/vins/{vin}

Authorization

Path parameters

vin*string

Plate number of the registered vehicle

Query parameters

Response

Success

Body

successboolean

vehicleVehicle (object)

upstream_vehiclestring

The raw vehicle description. It is recommended that end users manually verify that this value corresponds to the same vehicle type as the "vehicle" object above.

confidenceenum

The confidence that the vehicle was matched correctly. If this is 'reduced', it's recommended to manually check or prompt your end user to check if the vehicle is correct.

standardreduced

colourstring

The colour of the vehicle, if known

vinstring

The VIN of the vehicle, if known

additional_vehiclesarray of Vehicle (object)

Any additional alternate vehicle matches beyond the first (usually most likely) match

extended_dataany

Extended Data vehicle description product which can be selected by providing the appropriate query parameter

registration_statusRegistrationStatusProduct (object)

vehicle_ageVehicleAgeProduct (object)

writeoff_infoWriteoffInfoProduct (object)

build_dataVehicleBuildData (object)

odo_historyEnhancedLookupOdoHistory (array of object)

odo_predictionEnhancedLookupOdoPrediction (object)

vsrrEnhancedLookupVsrr (object)

Request

const response = await fetch('/v2/vehicles/vins/{vin}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "vehicle": {
    "id": "text",
    "region": "au",
    "title": "text",
    "year": 0,
    "make": "text",
    "model": "text",
    "badge": "text",
    "series": "text",
    "body_type": "text",
    "body_config": "text",
    "transmission": "text",
    "wheelbase": "text",
    "fuel": "text",
    "engine": "text",
    "drive": "text",
    "num_doors": 0
  },
  "upstream_vehicle": "text",
  "confidence": "standard",
  "colour": "text",
  "vin": "text",
  "additional_vehicles": [
    {
      "id": "text",
      "region": "au",
      "title": "text",
      "year": 0,
      "make": "text",
      "model": "text",
      "badge": "text",
      "series": "text",
      "body_type": "text",
      "body_config": "text",
      "transmission": "text",
      "wheelbase": "text",
      "fuel": "text",
      "engine": "text",
      "drive": "text",
      "num_doors": 0
    }
  ],
  "registration_status": {
    "expiry_date": "text",
    "status": "text"
  },
  "vehicle_age": {
    "compliance_plate": "text",
    "year_of_manufacture": 0
  },
  "build_data": {
    "vin": "text",
    "build_date": "text",
    "make": "text",
    "model": "text",
    "features": [
      {
        "code": "text",
        "value": "text"
      }
    ]
  },
  "odo_history": [
    {
      "read_date": "text",
      "odometer": 0
    }
  ],
  "odo_prediction": {
    "prediction": 0,
    "days_since_read": 0,
    "avg_yearly": 0,
    "avg_daily": 0,
    "ag_market_avg": 0
  },
  "vsrr": {
    "fuel_economy": {
      "star_rating": 0,
      "consumption": 0
    },
    "emissions": {
      "co2": 0,
      "star_rating": 0
    },
    "pollutants": {
      "star_rating": 0,
      "test_regime": "text"
    },
    "safety": {
      "driver": {
        "star_rating": 0,
        "test_regime": "text"
      }
    }
  }
}

Example Response

{
    "success": true,
    "vehicle": {
        "id": "4568590518845440",
        "region": "au",
        "title": "2021 Tesla Model 3 Rear-Wheel Drive Auto",
        "year": "2021",
        "make": "Tesla",
        "model": "Model 3",
        "badge": "Rear-Wheel Drive",
        "series": null,
        "model_year": "MY21",
        "release_month": 11,
        "release_year": 2021,
        "body_type": "Sedan",
        "body_config": null,
        "transmission": "Reduction Gear",
        "transmission_type": "Reduction Gear",
        "wheelbase": null,
        "wheelbase_type": null,
        "fuel": "Electric",
        "fuel_type": "Electric",
        "engine": "Electric",
        "engine_type": "Electric",
        "drive": "RWD",
        "drive_type": "Rear Wheel Drive",
        "num_doors": 4,
        "num_seats": 5,
        "num_gears": 1,
        "num_cylinders": null,
        "capacity_cc": null,
        "power_kw": null,
        "torque_nm": null,
        "range": null,
        "options": [
            {
                "detail": "Standard Paint",
                "price": 0
            },
            {
                "detail": "Paint - Black",
                "price": 1500
            },
            {
                "detail": "Full Self Driving Capability",
                "price": 10100
            },
            {
                "detail": "Paint - Multi-Coat Red",
                "price": 2900
            },
            {
                "detail": "Interior - Black & White",
                "price": 1500
            },
            {
                "detail": "19\" Sport Wheels",
                "price": 2200
            }
        ]
    },
    "upstream_vehicle": "2021 TESLA MODEL 3 Sedan",
    "confidence": "standard",
    "additional_vehicles": []
}

Features

You can request more data than the standard payload by leveraging a range of features described below.

Ensure your commercial agreement has these features enabled if you require them.

Extended Data

This feature will return an extended payload of vehicle data from the registration authority. Use features=extended_data to receive this payload.

   "extended_data": {
        "body_type_description": "CAR/SEDAN",
        "color_description": "WHITE",
        "engine_number": "DKJ039523",
        "make_code": "VOLKS",
        "make_description": "",
        "model_code": "",
        "model_description": "POLO",
        "vehicle_type_description": "CAR / SMALL PASSENGER VEHICLE"

Upstream Data

This feature will return structured descriptive data from the registration authority. Use features=additional_upstream_data to receive this payload.

    "additional_upstream_data": {
        "vin": "WVWZZZAWZKU065305",
        "year": "2019",
        "make": "Volkswagen",
        "model": "Polo",
        "badge": "AW",
        "series": "85TSI Comfortline",
        "fuel_type": "95 RON PULP",
        "body_style": "Hatch",
        "transmission": "7 auto",
        "capacity_cc": "1000",
        "colour": "White",
        "title": "2019 Volkswagen AW Polo 85TSI Comfortline 4 Hatch 7sp auto 1.0L 1000cc 3cyl T/Petrol 2018"

Vehicle Age

This feature will return structured data on the age of a vehicle from the registration authority. Use features=vehicle_age to receive this payload.

    "vehicle_age": {
        "compliance_plate": "2019-04",
        "year_of_manufacture": 2019

Writeoff Information

This feature will return information about the write-off status of a vehicle. Use features=writeoff_info

  "writeoff_info": {
        "incident_list": [
            {
                "code": "Repairable Write-off",
                "damage_codes": "I04AI17DI21C",
                "jurisdiction": "VIC",
                "recorded_date": "2024-04-28",
                "type_code": "Collision"
            }
        ]

Registration Status

This feature will return information about the registration status of a vehicle. Use features=registration_status

    "registration_status": {
        "expiry_date": "2024-09-06",
        "status": "REGISTERED"
    }

Build Data

This feature will return the options fitted to the vehicle based on your Factory Build Data. It will show all options, the price, and whether or not it is fitted to the vehicle. Usefeatures=build_data

"build_data": {
        "vin": "WAUZZZ8V7K1028938",
        "make": "AUDI",
        "model": "A3",
        "features": [
            {
                "code": "0A1",
                "value": "2 doors"
            },
            {
                "code": "0AE",
                "value": "Front stabilizer bar"
            },
            {
                "code": "0B2",
                "value": "Wheelbase"
            },
        ],
        "build_date": "2019-03-20"

Refer to Factory Build Data reference material for more information on supported OEMs.

Vehicle Safety Risk Ratings (VSRR)

This feature will return the vehicle's Vehicle Safety Risk Ratings (VSRR). Use features=vsrr

 "vsrr": {
        "fuel_economy": {
            "star_rating": 2,
            "consumption": 8.8
        },
        "emissions": {
            "co2": 212,
            "star_rating": 2
        },
        "pollutants": {
            "star_rating": 3,
            "test_regime": "A79/02"
        },
        "safety": {
            "driver": {
                "star_rating": 4,
                "test_regime": "Based on 2023 UCSR rating for 16-19 models"

PreviousRegistration Status NextFacet Search

Last updated 7 days ago