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

Get a vehicle by its VIN

Authorizations
ApiKeystringRequired
Path parameters
vinstringRequired

Plate number of the registered vehicle

Query parameters
featuresstringOptional

Comma separated list of additional registration lookup data codes, if using (e.g. additional_upstream_data)

prefer_more_resultsbooleanOptional

If enabled, a larger selection of vehicles may be returned and a manual selection would be required to select the correct vehicle. This is disabled by default in favor of a system which will infer the correct vehicle and order the results by likelihood of behind correct.

regionstring · enumOptional

The region to perform this request in

Possible values:
reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Responses
chevron-right
200

Success

application/json
successbooleanOptionalDefault: true
upstream_vehiclestringOptional

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.

confidencestring · enumOptional

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.

Possible values:
colourstringOptional

The colour of the vehicle, if known

vinstringOptional

The VIN of the vehicle, if known

extended_dataanyOptional

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

writeoff_infoobjectOptional
get
/v2/vehicles/vins/{vin}

Example Response

Features

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

circle-info

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.

Upstream Data

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

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.

Writeoff Information

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

Registration Status

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

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

circle-info

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

Last updated

Was this helpful?