Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Also known as New Zealand Birth Certificate or NZ Birth Certificate

Field nameDescriptionRequiredRestrictions
greenid_nzbirthcertificate_givennameThe person's given name, as it appears on the birth certificate.YesLength not exceeding 255 characters
greenid_nzbirthcertificate_middlenameThe person's middle name, as it appears on the birth certificate.YesLength not exceeding 255 characters
greenid_nzbirthcertificate_surnameThe person's surname, as it appears on the birth certificate.YesLength not exceeding 255 characters
greenid_nzbirthcertificate_dobThe person's date of birth, as it appears on the birth certificate.YesDD/MM/YYYY
greenid_nzbirthcertificate_tandcAn indication that the person agrees to the terms and conditions of the birth certificate check.Yes"on"


Anchor
nzcitizenship
nzcitizenship
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.YesLength not exceeding 255 characters
greenid_nzcitizenship_surnameThe person's surname, as it appears on the citizenship certificate.YesLength not exceeding 255 characters
greenid_nzcitizenship_dobThe person's date of birth, as it appears on the citizenship certificate.YesDD/MM/YYYY
greenid_nzcitizenship_tandcAn indication that the person agrees to the terms and conditions of the citizenship check.Yes"on"


Anchor
nzpassport
nzpassport
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" 


Anchor
nzrego
nzrego
nzrego (version 1)

Also known as New Zealand Driver's Licence

Field nameDescriptionRequiredRestrictions
greenid_nzrego_numberThe driver's licence number, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nzrego_codeThe driver's licence version, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nzrego_surnameThe person's surname, as it appears on the licence.YesLength not exceeding 255 characters
greenid_nzrego_dobThe person's date of birth, as it appears on the licence.YesDD/MM/YYYY
greenid_nzrego_tandcAn indication that the person agrees to the terms and conditions of the licence check.Yes"on"


Anchor
nztadriverslicence
nztadriverslicence
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"


Anchor
nzwp
nzwp
nzwp (version 1)

Also known as New Zealand White Pages or NZ Phone Book or NZ White Pages check

Field nameDescriptionRequiredRestrictions
greenid_nzwp_phonenumberThe person's phone number, as it appears in the NZ White Pages listing.Yes10 digits
greenid_nzwp_givennameThe person's given name, as it appears in the NZ White Pages listing.YesLength between 1 and 255 characters
greenid_nzwp_surnameThe person's surname, as it appears in the NZ White Pages listing.YesLength between 1 and 255 characters
greenid_nzwp_flatnumberThe flat number component of the person's address.NoLength between 1 and 255 characters
greenid_nzwp_streetnumberThe street number component of the person's address.YesLength between 1 and 255 characters
greenid_nzwp_streetnameThe street name component of the person's address.YesLength between 1 and 255 characters
greenid_nzwp_streettypeThe street type component of the person's address; this field is a select field, please refer to the output from a call to getFields with the sourceId "nzwp" for the available options. YesMust be one of the select options
greenid_nzwp_suburbThe suburb, Rural Delivery (RD) number, town or city component of the person's address.YesLength between 1 and 255 characters
greenid_nzwp_tandcAn indication that the person agrees to the terms and conditions of the NZ White Pages check.Yes"on"