...
Title | Webservice Name | Version | UI Name | Alternative UI Name | Type | Coverage | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
New Zealand Automobile Association Membership | 1 | NZAA | NZAA | New Zealand | ||||||||||
| New Zealand Birth Certificate | nzbirthcertificate30441525 | 1 | NZ Birth Certificate | NZ Birth Certificate | Certificate - Birth | New Zealand | ||||||||
| New Zealand Citizenship Certificate | nzcitizenship | 130441525 | NZ Citizenship | NZ Citizenship | Citizenship | New Zealand | ||||||||
| New Zealand Passport | nzpassport | 1 | NZ Passport | NZ Passport30441525 | Passport | New Zealand | ||||||||
| New Zealand Driver's Licence | nzrego | 1 | New Zealand | New Zealand Driver's Licence | nztadriverslicence | 1 | NZTADriversLicence | NZTA Drivers Licence check | 30441525 | Driver's Licence | New Zealand | |||
| New Zealand White Pages | nzwp | 1 | NZ Phone Book | NZ White Pages check | Telephone Directory | New Zealand |
| Anchor | ||||
|---|---|---|---|---|
|
...
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. | YesNo | 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 |
| Anchor | ||||
|---|---|---|---|---|
|
Field name
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.
| Anchor | ||||
|---|---|---|---|---|
|
Field name
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" |
*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.
| Anchor | ||||
|---|---|---|---|---|
|
Also known as New Zealand Passport or NZ Passport
| Field name | Description | Required | Restrictions |
|---|---|---|---|
| greenid_nzpassport_number | The passport number as it appears on the passport | Yes | Length between 7 - 9 alphanumeric characters |
| greenid_nzpassport_expiry | The passport expiry date, as it appears on the passport. | Yes | DD/MM/YYYY |
| greenid_nzpassport_givenname | The person's given name as it appears on the passport. | Yes | Length not exceeding 255 characters |
| greenid_nzpassport_middlename | The person's middle name, as it appears on the passport. | Yes | Length not exceeding 255 characters |
| greenid_nzpassport_surname | The person's surname, as it appears on the passport. | Yes | Length not exceeding 255 characters |
| greenid_nzpassport_dob | The person's date of birth, as it appears on the passport. | Yes | DD/MM/YYYY |
| greenid_nzpassport_tandc | An indication that the person agrees to the terms and conditions of the passport check. | Yes | "on" |
| Anchor | ||
|---|---|---|
|
...
|
...
nztadriverslicence (version 1)
...
nztadriverslicence (version 1)
Also known as New Zealand Driver's Licence or NZTADriversLicence or NZTA Drivers Licence check
| Field name | Description | Required | Restrictions |
|---|---|---|---|
| greenid_nztadriverslicence_number | The driver's licence number, as it appears on the licence. | Yes | Length not exceeding 255 characters |
| greenid_nztadriverslicence_versionnumber | The driver's licence version number, as it appears on the licence. | Yes | Length not exceeding 255 characters |
| greenid_nztadriverslicence_givenname | The person's given name, as it appears on the licence. | Yes | Length not exceeding 255 characters |
| greenid_nztadriverslicence_middlename | The person's middle name, as it appears on the licence. | Yes | Length not exceeding 255 characters |
| greenid_nztadriverslicence_surname | The person's surname, as it appears on the licence. | Yes | Length not exceeding 255 characters |
| greenid_nztadriverslicence_dob | The person's date of birth, as it appears on the licence. | Yes | DD/MM/YYYY |
| greenid_nztadriverslicence_tandc | An indication that the person agrees to the terms and conditions of the licence check. | Yes | "on" |
nzwp (version 1)
| Field name | Description | Required | Restrictions |
|---|---|---|---|
| greenid_nzwp_phonenumber | The person's phone number, as it appears in the NZ White Pages listing. | Yes | 10 digits |
| greenid_nzwp_givenname | The person's given name, as it appears in the NZ White Pages listing. | Yes | Length between 1 and 255 characters |
| greenid_nzwp_surname | The person's surname, as it appears in the NZ White Pages listing. | Yes | Length between 1 and 255 characters |
| greenid_nzwp_flatnumber | The flat number component of the person's address. | No | Length between 1 and 255 characters |
| greenid_nzwp_streetnumber | The street number component of the person's address. | Yes | Length between 1 and 255 characters |
| greenid_nzwp_streetname | The street name component of the person's address. | Yes | Length between 1 and 255 characters |
| greenid_nzwp_streettype | The 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. | Yes | Must be one of the select options |
| greenid_nzwp_suburb | The suburb, Rural Delivery (RD) number, town or city component of the person's address. | Yes | Length between 1 and 255 characters |
| greenid_nzwp_tandc | An indication that the person agrees to the terms and conditions of the NZ White Pages check. | Yes | "on" |