Identity documents (NZL)

Reference for the structured identityDocuments array on New Zealand individual verifications. Each item is one identity document. The shape varies by kind.

Include identityDocuments directly in the POST /v5/verifications request body.

Common shape

identityDocuments item

{
	"kind": "driverLicence" | "passport" | "attachment",
	// ...kind-specific fields
}

kind is a discriminator. Each value below shows the fields for that document type.

identityDocuments carries the structured data for each document (number, version, expiry, etc.). The optional file upload (front/back image, scan) is sent separately in the top-level documents array as a kind: "attachment" upload.

Driver licence

{
	"kind": "driverLicence",
	"number": "AB123456",
	"versionNumber": "123"
}

Field	Type	Required	Description
`kind`	string	Yes	Must be `"driverLicence"`.
`number`	string	Yes	2 letters followed by 6 digits (e.g. `AB123456`).
`versionNumber`	string	Yes	Exactly 3 alphanumeric characters (e.g. `123`, `1A2`).

Passport

{
	"kind": "passport",
	"number": "AA123456",
	"countryOfIssue": "NZL",
	"documentExpiry": "2030-12-31"
}

Field	Type	Required	Description
`kind`	string	Yes	Must be `"passport"`.
`number`	string	Yes	Passport number. Format depends on `countryOfIssue` — see below.
`countryOfIssue`	string	Yes	ISO3 country code. See Countries.
`documentExpiry`	string	Yes	Expiry date. ISO `YYYY-MM-DD` or `DD/MM/YYYY`. Must be in the future.

Passport number validation

Country of issue	Format
`AUS`	1 or 2 letters followed by 7 digits
`NZL`	1 or 2 letters followed by 6 digits
All other countries	1–14 alphanumeric characters

Unlike AUS, NZL passports require an expiry date and accept a foreign passport when its country-specific format matches. New Zealand–issued passports use the NZL regex above.

Attachment

A free-form document upload not tied to a regulated identifier. Use this when none of the structured kinds apply, or to attach a supporting document with arbitrary description text.

{
	"kind": "attachment",
	"description": "Utility bill — Genesis Energy, Mar 2026"
}

Field	Type	Required	Description
`kind`	string	Yes	Must be `"attachment"`.
`description`	string	No	Free-form description. Empty allowed.

The actual file goes in the top-level documents array. See Include documents.

Every subType: "data" submission requires top-level consent: true. The customer must have agreed to the declaration below before you submit the request — display this text next to the consent checkbox on the page where you collect the customer's details:

I confirm that I am authorised to provide the personal details presented in this form, and I consent to this information being checked with the appropriate document issuers, official record holders, credit bureaus, and mobile providers, including superannuation and employment verification, or other third-party systems via bronID (an Identity Service Provider), for the purposes of identity verification and AML/CTF compliance. I consent to the details and results from this identity verification being stored for audit and compliance purposes with the Identity Service Provider (bronID).

{
	"country": "NZL",
	"type": "individual",
	"subType": "data",
	"consent": true
}

See Verify an individual (data) for the full request body shape.

Test values (Development environment only)

In the development environment the values below short-circuit format validation and return a verified outcome. They do not apply in production.

Field	Value
Driver licence number	`11111111`
Passport number	`A111111`

See Test values for the full list.