# Registration Plate Search

### Overview

The Vehicle Registration API allows you to search for a vehicle by supplying its number plate. The request requires a region, the state (dependent on region), number plate & API key. This will return either a matching vehicle with possible option packs, or a null.

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](https://devhub.autograb.com/nz-autograb-api-doc/vehicle-search/facet-search).

{% code overflow="wrap" %}

```json
curl "https://api.autograb.com.au/v2/vehicles/registrations/{number_plate}?region=nz"
-H 'ApiKey: {API_KEY}'
```

{% endcode %}

That would produce the payload below.

```json
{
    "success": true,
    "vehicle": {
        "id": "5233518187642880",
        "region": "nz",
        "title": "2010 Volkswagen Polo Comfortline Automatic",
        "year": "2010",
        "make": "Volkswagen",
        "model": "Polo",
        "badge": "Comfortline",
        "series": "6R",
        "model_year": "MY10",
        "release_month": 1,
        "release_year": 2010,
        "body_type": "Hatchback",
        "body_config": null,
        "transmission": "Dual Clutch Automatic (DCT)",
        "transmission_type": "Automatic",
        "wheelbase": null,
        "wheelbase_type": null,
        "fuel": "Petrol",
        "fuel_type": "Petrol",
        "engine": "Piston",
        "engine_type": "Piston",
        "drive": "FWD",
        "drive_type": "Front Wheel Drive",
        "num_doors": 5,
        "num_seats": 5,
        "num_gears": 7,
        "num_cylinders": 4,
        "capacity_cc": 1390,
        "power_kw": 63,
        "torque_nm": 132,
        "range": null,
        "options": []
    },
    "upstream_vehicle": "2010 Volkswagen POLO Polo Automatic Petrol Hatchback 1,380cc",
    "vin": "WVWZZZ6RZAU020000",
    "colour": "SILVER",
    "confidence": "standard",
    "additional_vehicles": []
}
```

### Components

**Success** - this denotes the outcome of the lookup, if this is not true there are several possible reasons. The plate does not exist, was entered incorrectly or the registration authority could be experiencing an outage ([refer to our status page](https://status.autograb.com.au/)).

**Vehicle** - this is the array that holds the vehicle data as a result of our matching operation. If `Vehicle:Null` then we have not been able to identify a matching vehicle. If this is powering a front end UX, you should prompt the user to search via [Facets Search](https://devhub.autograb.com/nz-autograb-api-doc/vehicle-search/facet-search) to resolve to an vehicle ID. You can use  the `Upstream_Vehicle` below as a UI guide.

**Upstream\_Vehicle** - this is what the Registration Authority has told us the vehicle is. We use this input to match our catalogue.

**ID** - this is the platform ID of the vehicle, your gateway to leveraging this vehicle in future [Valuation](https://devhub.autograb.com/nz-autograb-api-doc/valuation), [Vehicle Data](https://devhub.autograb.com/nz-autograb-api-doc/vehicle-data) and more requests.

**Summary Data** - you will find basic information about the vehicle that you can use to power your UX. If you require more information that is in the Vehicle array consider usage of [Vehicle Data](https://devhub.autograb.com/nz-autograb-api-doc/vehicle-data) endpoints. 

**Options** - these are fittable (not fitted) options available on this vehicle. If you require fitted (from factory data) use the [Options Data](https://devhub.autograb.com/nz-autograb-api-doc/vehicle-data/factory-build-data) endpoint.

**Confidence** - this is the prediction confidence of the match. There are two types of output for this parameter (Standard and degraded).

**Additional Vehicle** - if there are additional lower confidence matches we will show them to you here. 

### Features

You can pass in features to request additional data to be sent in the response. Refer to the [Features](#features) section for more information.

## **Prefer More Results**

This feature will show you additional results at lower-quality matches. Only use this if you would like to see other vehicles that are not likely to be the one you are requesting. Use header`prefer_more_results=true` to request this response.

<br>