Search Vehicle by Plate

The Vehicle Registration API allows you to search for a vehicle by supplying its number plate. The request requires a number plate and Australian state. This will return either a matching vehicle or a null.

Please note: The API assumes that the plate provided is for a passenger, van or light commercial vehicle. If other vehicle types are provided (motorcycles, trailers etc), we will use best endeavours to match the upstream vehicle description to a vehicle in our catalogue. This can result in some "fuzzy" matches however they will have a reduced confidence score (e.g. a Harley Davidson motorcycle matching to a Holden special vehicle).

We are working on a change to enforce a check on the vehicle type so that we avoid the fuzzy match scenario described above.

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

  • There are a variety of reasons why a reduced confidence score could be returned. In these scenarios we can find a match for the vehicle in our catalogue however some of the vehicle features may not be a perfect match. This is often because the vehicle is a grey import and further research is required to bring the vehicle into our catalogue.

    • An example is the 1999 Ferrari 355 F1 Spider Cabriolet (a UK import). We currently match this to the coupe version.

  • Other than the fuzzy search described above, a reduced confidence vehicle match may be sufficient for your needs and should be investigated.

• degraded

• failed

  • This will occur when a match cannot be found in our catalogue, even at the broadest level. For example if a plate for a boat trailer is provided e.g:

    "upstream_vehicle": "1986 Homebuilt MISC Misc Boat Trailer"

    Then we will clearly be unable to find a match.

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 Registration

get

Retrieve a vehicle by its registration number

Path parameters

platestringRequired

Registration number/plate of the vehicle

Example: ABC123

Query parameters

statestringRequired

The state associated with the supplied registration number

Example: NSW

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/plate/{plate}

HTTPcURLJavaScriptPython

GET /v1/vehicles/plate/{plate}?state=NSW 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": []
    }
  ]
}