New Zealand Data Sources

New Zealand Data Sources

 

Title

Webservice Name

Type

Coverage

New Zealand Automobile Association Membership

nzaa

 

New Zealand

New Zealand Birth Certificate

nzbirthcertificate

Certificate - Birth

New Zealand

New Zealand Citizenship Certificate

nzcitizenship

Citizenship

New Zealand

New Zealand Passport

nzpassport

Passport

New Zealand

New Zealand Driver's Licence

nztadriverslicence

Driver's Licence

New Zealand

 

nzaa (version 1)

Also known as New Zealand Automobile Association Membership or NZAA

 

Field name

Description

Required

Restrictions

greenid_nzaa_number

The Automobile Association membership number, as it appears on the membership card.

Yes

16 numeric digits

greenid_nzaa_givenname

The person's given name, as it appears on the membership card.

Yes

Length not exceeding 255 characters

greenid_nzaa_surname

The person's surname, as it appears on the membership card.

Yes

Length not exceeding 255 characters

greenid_nzaa_flatnumber

The flat number component of the person's address.

Yes (if present)

Between 1 and 255 characters

greenid_nzaa_streetnumber

The street number component of the person's address.

Yes

Between 1 and 255 characters

greenid_nzaa_streetname

The street name component of the person's address.

Yes

Between 1 and 255 characters

greenid_nzaa_streettype

The street type component of the person's address.

Yes

This field is a select field, please refer to the output from a call to getFields with the sourceId "nzaa" for the available options.

greenid_nzaa_suburb

The suburb component of the person's address.

No

Between 1 and 255 characters

greenid_nzaa_postcode

The postcode component of the person's address.

Yes

Four digits

greenid_nzaa_dob

The person's date of birth.

Yes

DD/MM/YYYY

greenid_nzraa_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_nzaa_towncity

The town or city component of the person's address

Yes

Between 1 and 255 characters

nzbirthcertificate (version 1)

Also known as New Zealand Birth Certificate or NZ Birth Certificate

Field name

Description

Required

Restrictions

greenid_nzbirthcertificate_dob

The person's date of birth, as it appears on the birth certificate.

Yes

DD/MM/YYYY

greenid_nzbirthcertificate_givenname

The person's given name, as it appears on the birth certificate.

Yes

Length not exceeding 255 characters

greenid_nzbirthcertificate_issuedate

The issue date, as it appears on the birth certificate.

No*

DD/MM/YYYY

greenid_nzbirthcertificate_middlename

The person's middle name, as it appears on the birth certificate.

No**

Length not exceeding 255 characters

greenid_nzbirthcertificate_regno

The registration number, as it appears on the birth certificate.

No***

Length not exceeding 255 characters

greenid_nzbirthcertificate_surname

The person's surname, as it appears on the birth certificate.

Yes

Length not exceeding 255 characters

greenid_nzbirthcertificate_tandc

An indication that the person agrees to the terms and conditions of the birth certificate check.

Yes

"on"

*The issue date is not used for matching by the source provider. This field has been made optional so customers' current configurations are not impacted. It is recommended that this field is not used.

**This is an optional field and should be supplied if a middle name is on the certificate.

***If supplied, it will be used by the provider for matching.

nzcitizenship (version 1)

Also known as New Zealand Citizenship Certificate or NZ Citizenship

Field name

Description

Required

Restrictions

greenid_nzcitizenship_givenname

The person's given name, as it appears on the citizenship certificate.

Yes

Length not exceeding 255 characters

greenid_nzcitizenship_middlename

The person's middle name, as it appears on the citizenship certificate.

No*

Length not exceeding 255 characters

greenid_nzcitizenship_surname

The person's surname, as it appears on the citizenship certificate.

Yes

Length not exceeding 255 characters

greenid_nzcitizenship_dob

The person's date of birth, as it appears on the citizenship certificate.

Yes

DD/MM/YYYY

greenid_nzcitizenship_issuedate

The issue date, as it appears on the citizenship certificate.

No**

DD/MM/YYYY

greenid_nzcitizenship_certno

The certificate number, as it appears on the citizenship certificate.

No***

Length not exceeding 255 characters

greenid_nzcitizenship_tandc

An indication that the person agrees to the terms and conditions of the citizenship check.

Yes

"on"