curl -X POST https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license \
-u "YOUR_UUID:YOUR_SECRET" \
-H "X-API-Version: 1.2" \
-H "Content-Type: application/json" \
-d '{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}'
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", {
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({
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}),
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
"https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license",
auth=("YOUR_UUID", "YOUR_SECRET"),
headers={
"X-API-Version": "1.2",
},
json={
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license")
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
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license");
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'
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON,
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
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",
"{",
" \"birth_date\": \"1965-01-01\",",
" \"given_name\": \"john\",",
" \"family_name\": \"smith\",",
" \"licence_number\": \"94977000\",",
" \"card_number\": \"99999999\",",
" \"state_of_issue\": \"VIC\"",
"}"
);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license"))
.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());
}
}
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}`)
req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", 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))
}
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/driving-license");
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(@"{
""birth_date"": ""1965-01-01"",
""given_name"": ""john"",
""family_name"": ""smith"",
""licence_number"": ""94977000"",
""card_number"": ""99999999"",
""state_of_issue"": ""VIC""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"message": "Verification Result",
"data": {
"documentResult": {
"attributes": {
"i:type": "DriverLicenceResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "Y"
},
"documentDetails": {
"GivenName": "Full Match",
"MiddleName": "Full Match",
"FamilyName": "Full Match",
"LicenceNumber": "Full Match",
"CardNumber": "Full Match",
"BirthDate": "Full Match",
"BirthDay": "Full Match",
"BirthMonth": "Full Match",
"BirthYear": "Full Match",
"StateOfIssue": "Full Match",
"CountryOfIssue": "Full Match",
"ImmiCardNumber": "Full Match",
"CardType": "Full Match",
"ExpiryDay": "Full Match",
"RegistrationState": "Full Match"
},
"status": "Y"
}
}
Document verification
Verify driving licence
This endpoint verifies an Australian driving licence against official government records. It performs a field-by-field comparison and returns match results for each submitted detail.
POST
/
verify
/
driving-license
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license \
-u "YOUR_UUID:YOUR_SECRET" \
-H "X-API-Version: 1.2" \
-H "Content-Type: application/json" \
-d '{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}'
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", {
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({
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}),
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
"https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license",
auth=("YOUR_UUID", "YOUR_SECRET"),
headers={
"X-API-Version": "1.2",
},
json={
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license")
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
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license");
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'
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON,
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
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",
"{",
" \"birth_date\": \"1965-01-01\",",
" \"given_name\": \"john\",",
" \"family_name\": \"smith\",",
" \"licence_number\": \"94977000\",",
" \"card_number\": \"99999999\",",
" \"state_of_issue\": \"VIC\"",
"}"
);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license"))
.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());
}
}
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}`)
req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", 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))
}
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/driving-license");
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(@"{
""birth_date"": ""1965-01-01"",
""given_name"": ""john"",
""family_name"": ""smith"",
""licence_number"": ""94977000"",
""card_number"": ""99999999"",
""state_of_issue"": ""VIC""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"message": "Verification Result",
"data": {
"documentResult": {
"attributes": {
"i:type": "DriverLicenceResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "Y"
},
"documentDetails": {
"GivenName": "Full Match",
"MiddleName": "Full Match",
"FamilyName": "Full Match",
"LicenceNumber": "Full Match",
"CardNumber": "Full Match",
"BirthDate": "Full Match",
"BirthDay": "Full Match",
"BirthMonth": "Full Match",
"BirthYear": "Full Match",
"StateOfIssue": "Full Match",
"CountryOfIssue": "Full Match",
"ImmiCardNumber": "Full Match",
"CardType": "Full Match",
"ExpiryDay": "Full Match",
"RegistrationState": "Full Match"
},
"status": "Y"
}
}
Headers
string
default:"1.2"
required
The API version to use. Supported versions are
1.1 and 1.2.Request Body Parameters
string
required
Date of birth of the licence holder. Format: YYYY-MM-DD.
string
required
The first name of the licence holder.
string
required
The last name of the licence holder.
string
required
The driving licence number to verify.
string
required
The card number associated with the licence.
string
required
The state where the licence was issued. Must be one of: NSW, QLD, SA, TAS, VIC, WA, ACT, NT.
Response Body
| Field | Type | Description |
|---|---|---|
message | string | A message describing the response status (e.g. “Verification Result”). |
dataobject | object | The driving licence verification result data. |
↳documentResult | object | Contains the overall verification result including ActivityId, OriginatingAgencyCode, VerificationRequestNumber, and VerificationResultCode (“Y” for verified, “N” for not verified). |
↳documentDetails | object | Field-by-field match results. Each field (GivenName, FamilyName, LicenceNumber, CardNumber, BirthDate, StateOfIssue, etc.) will have a value of “Full Match”, “Partial Match”, or “No Match”. |
↳status | string | Overall verification status. “Y” indicates the document is verified, “N” indicates it is not verified. |
Response Codes
| Code | Description |
|---|---|
| 200 | The driving licence was successfully verified and the match results are returned. |
| 400 | Bad Request. Missing or invalid parameters. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 500 | Internal Server Error. |
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license \
-u "YOUR_UUID:YOUR_SECRET" \
-H "X-API-Version: 1.2" \
-H "Content-Type: application/json" \
-d '{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}'
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", {
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({
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}),
});
const data = await response.json();
console.log(data);
import requests
response = requests.post(
"https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license",
auth=("YOUR_UUID", "YOUR_SECRET"),
headers={
"X-API-Version": "1.2",
},
json={
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC",
},
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license")
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
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license");
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'
{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}
JSON,
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
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",
"{",
" \"birth_date\": \"1965-01-01\",",
" \"given_name\": \"john\",",
" \"family_name\": \"smith\",",
" \"licence_number\": \"94977000\",",
" \"card_number\": \"99999999\",",
" \"state_of_issue\": \"VIC\"",
"}"
);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license"))
.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());
}
}
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"birth_date": "1965-01-01",
"given_name": "john",
"family_name": "smith",
"licence_number": "94977000",
"card_number": "99999999",
"state_of_issue": "VIC"
}`)
req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/verify/driving-license", 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))
}
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/driving-license");
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(@"{
""birth_date"": ""1965-01-01"",
""given_name"": ""john"",
""family_name"": ""smith"",
""licence_number"": ""94977000"",
""card_number"": ""99999999"",
""state_of_issue"": ""VIC""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"message": "Verification Result",
"data": {
"documentResult": {
"attributes": {
"i:type": "DriverLicenceResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "Y"
},
"documentDetails": {
"GivenName": "Full Match",
"MiddleName": "Full Match",
"FamilyName": "Full Match",
"LicenceNumber": "Full Match",
"CardNumber": "Full Match",
"BirthDate": "Full Match",
"BirthDay": "Full Match",
"BirthMonth": "Full Match",
"BirthYear": "Full Match",
"StateOfIssue": "Full Match",
"CountryOfIssue": "Full Match",
"ImmiCardNumber": "Full Match",
"CardType": "Full Match",
"ExpiryDay": "Full Match",
"RegistrationState": "Full Match"
},
"status": "Y"
}
}
Last modified on November 10, 2026
Was this page helpful?
