Search Vehicle by VIN

The Vehicle Registration API allows you to search for a vehicle by supplying its VIN. The request requires a VIN provided as a path variable. This will return either a matching vehicle or a null.

It is critical that the confidence of the match is checked. MotorWeb will seek to always provide a match however there may be instances where a definitive match is not possible, or the vehicle is very rare and not in our database.

Possible confidence scores are:

• standard

• reduced

• degraded

• failed

Any confidence score below standard should be investigated.

In all cases, and importantly if a matching vehicle is unable to be identified, we will return the upstream_vehicle field allowing you to identify how the relevant road transport authority describes the vehicle.

Depending on your use case you may wish to allow front-end users to manually classify the vehicle using the upstream_vehicle as a guide to fill out a Facet-style search.

Retrieve Vehicle By VIN

get

Retrieve a vehicle by its Vehicle Identification Number

Path parameters

vinstringRequired

VIN of the vehicle

Example: JMFXTGA2WBZ004048

Query parameters

reference_idstringOptional

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

Example: MY_REFERENCE_123

Responses

200

Vehicle Response

application/json

successbooleanOptional

Whether or not the identify new owner transaction was successful

Example: true

upstream_vehiclestringOptional

Detailed description of vehicle

Example: 2007 Mitsubishi OUTLANDER Outlander 2.4 AWD XLS Wagon CVT Petrol Wagon 2,359cc 127kw

confidencestringOptional

Confidence score for a given vehicle

Example: standard

colourstringOptional

Primary colour of the vehicle

Example: GREY

vinstringOptional

Vehicle Identification Number

Example: ABCDEFGH123456789

400

Bad Request / Validation Failed

application/json

404

Resource for id cannot be found

application/json

500

Unknown error on the service side

application/json

get

/v1/vehicles/vin/{vin}

HTTPcURLJavaScriptPython

GET /v1/vehicles/vin/{vin} HTTP/1.1
Accept: */*

{
  "success": true,
  "vehicle": {
    "id": 2983792384791283,
    "region": "au",
    "title": "2007 Mitsubishi Outlander XLS Automatic",
    "year": 2007,
    "make": "Mitsubishi",
    "model": "Outlander",
    "badge": "XLS",
    "series": null,
    "model_year": null,
    "release_month": 1,
    "release_year": 2007,
    "body_type": "Wagon",
    "body_config": null,
    "transmission": "Continuously Variable (CVT)",
    "transmission_type": "Automatic",
    "wheelbase": null,
    "wheelbase_type": null,
    "fuel": "Petrol",
    "fuel_type": "Petrol",
    "engine": "Piston",
    "engine_type": "Piston",
    "drive": "AWD",
    "drive_type": "Four Wheel Drive",
    "num_doors": 5,
    "num_seats": 5,
    "num_gears": 6,
    "num_cylinders": 4,
    "capacity_cc": 2359,
    "power_kw": 127,
    "torque_nm": 230,
    "range": 250,
    "options": []
  },
  "upstream_vehicle": "2007 Mitsubishi OUTLANDER Outlander 2.4 AWD XLS Wagon CVT Petrol Wagon 2,359cc 127kw",
  "confidence": "standard",
  "colour": "GREY",
  "vin": "ABCDEFGH123456789",
  "additional_vehicles": [
    {
      "id": 2983792384791283,
      "region": "au",
      "title": "2007 Mitsubishi Outlander XLS Automatic",
      "year": 2007,
      "make": "Mitsubishi",
      "model": "Outlander",
      "badge": "XLS",
      "series": null,
      "model_year": null,
      "release_month": 1,
      "release_year": 2007,
      "body_type": "Wagon",
      "body_config": null,
      "transmission": "Continuously Variable (CVT)",
      "transmission_type": "Automatic",
      "wheelbase": null,
      "wheelbase_type": null,
      "fuel": "Petrol",
      "fuel_type": "Petrol",
      "engine": "Piston",
      "engine_type": "Piston",
      "drive": "AWD",
      "drive_type": "Four Wheel Drive",
      "num_doors": 5,
      "num_seats": 5,
      "num_gears": 6,
      "num_cylinders": 4,
      "capacity_cc": 2359,
      "power_kw": 127,
      "torque_nm": 230,
      "range": 250,
      "options": []
    }
  ]
}