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
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
400
Bad Request
application/json
401
Unauthorized
application/json
get
/v2/vehicles/vins/{vin}
Example Response
Features
You can request more data than the standard payload by leveraging the features described below.
Ensure your commercial agreement has these features enabled if you require them.
Extended Data
This feature will return structured descriptive data from the registration authority. Use features=additional_upstream_data to receive this payload.