New Zealand Data Sources

 

Title
Webservice Name
Type
Coverage

New Zealand Automobile Association Membership

New Zealand Data Sources#nzaa


New Zealand
New Zealand Birth Certificate New Zealand Data Sources#nzbirthcertificateCertificate - BirthNew Zealand
New Zealand Citizenship Certificate New Zealand Data Sources#nzcitizenshipCitizenshipNew Zealand
New Zealand Passport New Zealand Data Sources#nzpassportPassportNew Zealand
New Zealand Driver's Licence New Zealand Data Sources#nztadriverslicenceDriver's LicenceNew Zealand


nzaa (version 1)

Also known as New Zealand Automobile Association Membership or NZAA


Field nameDescriptionRequiredRestrictions
greenid_nzaa_numberThe Automobile Association membership number, as it appears on the membership card.Yes16 numeric digits
greenid_nzaa_givennameThe person's given name, as it appears on the membership card.YesLength not exceeding 255 characters
greenid_nzaa_surnameThe person's surname, as it appears on the membership card.YesLength not exceeding 255 characters
greenid_nzaa_flatnumberThe flat number component of the person's address.Yes (if present)Between 1 and 255 characters
greenid_nzaa_streetnumberThe street number component of the person's address.YesBetween 1 and 255 characters
greenid_nzaa_streetnameThe street name component of the person's address.YesBetween 1 and 255 characters
greenid_nzaa_streettypeThe street type component of the person's address.YesThis 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_suburbThe suburb component of the person's address.NoBetween 1 and 255 characters
greenid_nzaa_postcodeThe postcode component of the person's address.YesFour digits
greenid_nzaa_dobThe person's date of birth.YesDD/MM/YYYY
greenid_nzraa_tandcAn indication that the person agrees to the terms and conditions of the licence check.Yes"on"
greenid_nzaa_towncityThe town or city component of the person's addressYesBetween 1 and 255 characters

nzbirthcertificate (version 1)

Also known as New Zealand Birth Certificate or NZ Birth Certificate

Field nameDescriptionRequiredRestrictions
greenid_nzbirthcertificate_dobThe person's date of birth, as it appears on the birth certificate.YesDD/MM/YYYY
greenid_nzbirthcertificate_givennameThe person's given name, as it appears on the birth certificate.YesLength not exceeding 255 characters
greenid_nzbirthcertificate_issuedateThe issue date, as it appears on the birth certificate.No*DD/MM/YYYY
greenid_nzbirthcertificate_middlenameThe person's middle name, as it appears on the birth certificate.No**Length not exceeding 255 characters
greenid_nzbirthcertificate_regnoThe registration number, as it appears on the birth certificate.No***Length not exceeding 255 characters
greenid_nzbirthcertificate_surnameThe person's surname, as it appears on the birth certificate.YesLength not exceeding 255 characters
greenid_nzbirthcertificate_tandcAn 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 nameDescriptionRequiredRestrictions
greenid_nzcitizenship_givennameThe person's given name, as it appears on the citizenship certificate.YesLength not exceeding 255 characters
greenid_nzcitizenship_middlenameThe person's middle name, as it appears on the citizenship certificate.No*Length not exceeding 255 characters
greenid_nzcitizenship_surnameThe person's surname, as it appears on the citizenship certificate.

Yes

Length not exceeding 255 characters
greenid_nzcitizenship_dobThe person's date of birth, as it appears on the citizenship certificate.YesDD/MM/YYYY
greenid_nzcitizenship_issuedateThe issue date, as it appears on the citizenship certificate.No**DD/MM/YYYY
greenid_nzcitizenship_certnoThe certificate number, as it appears on the citizenship certificate.No***Length not exceeding 255 characters
greenid_nzcitizenship_tandcAn indication that the person agrees to the terms and conditions of the citizenship check.Yes"on"

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

**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.

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

nzpassport (version 1)

Also known as New Zealand Passport or NZ Passport

Field nameDescriptionRequiredRestrictions
greenid_nzpassport_numberThe passport number as it appears on the passport
YesLength between 7 - 9 alphanumeric characters
greenid_nzpassport_expiryThe passport expiry date, as it appears on the passport.
YesDD/MM/YYYY
greenid_nzpassport_givennameThe person's given name as it appears on the passport.YesLength not exceeding 255 characters
greenid_nzpassport_middlenameThe person's middle name, as it appears on the passport.YesLength not exceeding 255 characters
greenid_nzpassport_surnameThe person's surname, as it appears on the passport.YesLength not exceeding 255 characters
greenid_nzpassport_dobThe person's date of birth, as it appears on the passport.YesDD/MM/YYYY
greenid_nzpassport_tandcAn indication that the person agrees to the terms and conditions of the passport check.Yes"on" 

nztadriverslicence (version 1)

Also known as New Zealand Driver's Licence or NZTADriversLicence or NZTA Drivers Licence check

Field nameDescriptionRequiredRestrictions
greenid_nztadriverslicence_numberThe driver's licence number, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nztadriverslicence_versionnumberThe driver's licence version number, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nztadriverslicence_givennameThe person's given name, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nztadriverslicence_middlenameThe person's middle name, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nztadriverslicence_surnameThe person's surname, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nztadriverslicence_dobThe person's date of birth, as it appears on the licence.YesDD/MM/YYYY
greenid_nztadriverslicence_tandcAn indication that the person agrees to the terms and conditions of the licence check.Yes"on"