Guide to the APICountry Specific ID Document Requirements

New Zealand ID Documents

This guide covers the verification requirements for official New Zealand identity documents including passports and birth certificates.

New Zealand Drivers Licence

Driver License Verification

Verify New Zealand licenses using the following required fields and format specifications.

Required Fields

  • Full Name: Must match passport exactly
    • Given name(s)
    • Family name(s)
  • Date of Birth: Format: YYYY-MM-DD
  • ID Type: Must be DRIVERS_LICENSE
  • Country: Must be NZL
  • License Number: Provided in idNumber field
  • License version: 
    1{
    2  "kvpKey": "license_version",
    3  "kvpValue": "version as shown on licence"
    4}
  • Expiry Date: Format: YYYY-MM-DD

Implementation Example

Example Driver License Request
1{
2  "identityDocs": [
3    {
4      "idType": "DRIVERS_LICENSE",
5      "country": "NZL",
6      "idNumber": "DL123456",
7      "extraData": [
8        {
9          "kvpKey": "license_version",
10          "kvpValue": "version as shown on licence"
11        }
12      ],
13      "idExpiry": "2028-01-31"
14    }
15  ]
16}

New Zealand Passport

Passport Verification

Verify New Zealand passports using the following required fields and format specifications.

Required Fields

  • Full Name: Must match passport exactly
    • Given name(s)
    • Middle name(s)
    • Family name(s)
  • Date of Birth: Format: YYYY-MM-DD
  • ID Type: Must be PASSPORT
  • Country: Must be NZL
  • Passport Number: Provided in idNumber field
  • Expiry Date: Format: YYYY-MM-DD

Implementation Example

Example Passport Request
1{
2  "identityDocs": [
3    {
4      "idType": "PASSPORT",
5      "country": "NZL",
6      "idNumber": "LN123456",
7      "idExpiry": "2028-01-31"
8    }
9  ]
10}

Birth Certificate

Birth Certificate Verification

Verify New Zealand birth certificates using these specifications.

Contact your customer success manager to enable New Zealand Birth Certificate verification for your account.

Required Fields

  • Full Name: Must match certificate exactly
    • Given name(s)
    • Middle name(s)
    • Family name(s)
  • Date of Birth: Format: YYYY-MM-DD
  • ID Type: Must be BIRTH_CERT
  • Country: Must be NZL
  • Registration Number: Provided in idNumber field

Country of birth must be included in extraData:

1{
2  "kvpKey": "country_of_birth",
3  "kvpValue": "COUNTRY_NAME"
4}

Implementation Example

Example Birth Certificate Request
1{
2  "identityDocs": [
3    {
4      "idType": "BIRTH_CERT",
5      "country": "NZL",
6      "idNumber": "BC987654",
7      "extraData": [
8        {
9          "kvpKey": "country_of_birth",
10          "kvpValue": "New Zealand"
11        }
12      ]
13    }
14  ]
15}

When verifying New Zealand identity documents: 1. Ensure all names match exactly as shown on the document 2. Use correct date formats (YYYY-MM-DD) 3. Include all required extra data fields 4. Verify document numbers are entered correctly