NZ Drivers Licence Verification

Request

Method: POST

URL: https://{{environment}}.ridx.io/infolog/nzta/driverLicenseVerification

Headers

Header	Value
Content-Type	application/json
token	{{access_token}}

Request Body

Property	Type	Description
FirstName	String	First name
MiddleName	String	Optional. Middle name
LastName	String	Last name
BirthDate	String	Date of birth
LicenseNumber	String	Driver licence number
LicenseVersion	String	Driver licence version number

Example Requests

Example Request ( Success - License Match )Example Request ( Success - All Fields Match )Example Request ( Error response )

{
  "FirstName": "John",
  "LastName": "Smith",
  "BirthDate": "01-01-1970",
  "LicenseNumber": "DA123456",
  "LicenseVersion": "645"
}

{
  "FirstName": "John",
  "LastName": "Smith",
  "BirthDate": "01-01-1970",
  "LicenseNumber": "11111111",
  "LicenseVersion": "645"
}

{
  "FirstName": "John",
  "BirthDate": "01-01-1970",
  "LicenseNumber": "DA123456",
  "LicenseVersion": "645"
}

Example Responses

Success response ( License Match )Success response ( All Fields Match )Error Response

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "FirstName": "John",
    "MiddleName": [],
    "LastName": "Smith",
    "BirthDate": "1970-01-01T00:00:00",
    "LicenseNumber": "DA123456",
    "LicenseVersion": "645",
    "LicenseMatch": true,
    "FirstNameMatch": false,
    "MiddleNameMatch": false,
    "LastNameMatch": false,
    "BirthDateMatch": false
  }
}

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "FirstName": "John",
    "MiddleName": null,
    "LastName": "Smith",
    "BirthDate": "1970-01-01T00:00:00",
    "LicenseNumber": "11111111",
    "LicenseVersion": "645",
    "LicenseMatch": true,
    "FirstNameMatch": true,
    "MiddleNameMatch": null,
    "LastNameMatch": true,
    "BirthDateMatch": null,
    "rapidID": "check-id"
  }
}

Status: 401 Unauthorized

{
  "status": 400,
  "message": "ok",
  "data": {
    "error": "LastName is required"
  }
}