> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vehicle registration check

> This endpoint checks a vehicle registration against official records and returns detailed vehicle information including make, model, colour, body style, registration expiry, and insurance details.

### Headers

**X-API-Version** `string` *required* (default: 1.2)

The API version to use. Supported versions are `1.1` and `1.2`.

### Request Body Parameters

**registration\_number** `string` *required*

The vehicle registration plate number (e.g. "S306CPS").

**state** `string` *required*

The Australian state where the vehicle is registered (e.g. "SA", "VIC", "NSW", "QLD").

### Response Body

| Field | Type | Description |
| - | - | - |
| `status` | string | A message describing the response status (e.g. "Verification Result"). |
| `data`object | object | The vehicle registration verification result data. |
| ↳`Description` | string | A description of the vehicle (e.g. "GREY KIA STATION WAGON"). |
| ↳`CarMake` | string | The make/manufacturer of the vehicle (e.g. "KIA", "TOYOTA"). |
| ↳`CarModel` | string\|null | The model of the vehicle. May be null if not available. |
| ↳`RegistrationYear` | string\|null | The year of registration. May be null if not available. |
| ↳`BodyStyle` | string | The body style of the vehicle (e.g. "STATION WAGON", "SEDAN"). |
| ↳`Colour` | string | The colour of the vehicle. |
| ↳`Expiry` | string | The registration expiry date (DD/MM/YYYY format). |
| ↳`VIN` | string\|null | The Vehicle Identification Number. May be null if not available. |
| ↳`InsuranceCompany` | string | The name of the insurance company covering the vehicle. |
| ↳`ImageUrl` | string | URL for a reference image of the vehicle make. |
| ↳`State` | string | The state of registration. |

### Response Codes

| Code | Description |
| - | - |
| 200 | The vehicle registration was successfully verified and the vehicle details are returned. |
| 400 | Bad Request. Missing or invalid registration number or state. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 500 | Internal Server Error. |

```bash cURL theme={null}
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json" \
  -d '{
  "registration_number": "S306CPS",
  "state": "SA"
}'
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration", {
  method: "POST",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "X-API-Version": "1.2",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "registration_number": "S306CPS",
    "state": "SA"
  }),
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.post(
    "https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "X-API-Version": "1.2",
    },
    json={
        "registration_number": "S306CPS",
        "state": "SA",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration")
request = Net::HTTP::Post.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
request["X-API-Version"] = "1.2"
request["Content-Type"] = "application/json"
request.body = <<~JSON
  {
    "registration_number": "S306CPS",
    "state": "SA"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "X-API-Version: 1.2",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "registration_number": "S306CPS",
  "state": "SA"
}
JSON,
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("YOUR_UUID:YOUR_SECRET".getBytes());

        String body = String.join("\n",
            "{",
            "  \"registration_number\": \"S306CPS\",",
            "  \"state\": \"SA\"",
            "}"
        );

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration"))
            .header("Authorization", "Basic " + credentials)
            .header("X-API-Version", "1.2")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "registration_number": "S306CPS",
  "state": "SA"
}`)

	req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration", body)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("YOUR_UUID", "YOUR_SECRET")
	req.Header.Set("X-API-Version", "1.2")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://qa-payments.mygigsters.com.au/api/v1/verify/vehicle-registration");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("YOUR_UUID:YOUR_SECRET")));
request.Headers.Add("X-API-Version", "1.2");
request.Content = new StringContent(@"{
  ""registration_number"": ""S306CPS"",
  ""state"": ""SA""
}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "status": "Verification Result",
  "data": {
    "Description": "GREY KIA STATION WAGON",
    "CarMake": "KIA",
    "CarModel": null,
    "RegistrationYear": null,
    "BodyStyle": "STATION WAGON",
    "Colour": "GREY",
    "Expiry": "18/08/2026",
    "VIN": null,
    "InsuranceCompany": "YOUI",
    "ImageUrl": "http://www.carregistrationapi.com/image.aspx/@S0lBIA==",
    "State": "SA"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.