...
- passportNumber - the passport number, exactly as it appears on the document. This field is required. This field must have the value as shown on the NZ issued passport.
- passportExpiryDate - the expiry date, exactly as it appears on the document. This field is required. This field must have the value as shown on the NZ issued passport.
The person's name details, as provided in the other parameters to the registration web service method, are used, so passing an additional name is not required.
Legacy Background Driver's Licence Checks (non-DVS)
To perform background driver's license checks, greenID needs to know the driver's license information, which can be passed along with the rest of the information sent in registration web service call. The extra driver's licence information is passed in the list of name-value pairs in the extraData element. The extra fields that can be passed are:
driversLicenceNumberdriversLicenceStatedriversLicenceExpiryDatedriversLicenceRTANumber
The first two fields, namely driversLicenceNumber and driversLicenceState are mandatory; if either or both are missing, then the check will not be performed. The driversLicenceExpiryDate field is optional for all states except Western Australian driver's licenses. The {{driversLicenceRTANumber}} field is mandatory for NSW drivers licence checks only.
The driversLicenceNumber field is used directly for the check, it is not modified in any way, so it must be provided exactly as it appears on the licence.
The driversLicenceState fields must be one of:
- NSW
- VIC
- ACT
- QLD
- SA
- WA
Any other values are ignored; if a valid state is not present, then a driver's licence check will not be performed.
The driversLicenceExpiryDate field is also used directly for the check, and is not modified in any way. It is expected that it will be a string of the form DD/MM/YYYY. If a valid date is not found, then none will be used, which may cause the check to fail.
...
Visa Entitlement Check
To initiate a background a Visa Entitlement Check, the following fields must be passed in the extraData element:
visaEntitlementPassportNumber- the Passport number. This field is required. This field must have the value as shown on the passport.visaEntitlementPassportCountry- the country that issued the Passport - the 3 letter country code of the country that issued the passport, except Germany, which is denoted by the single character "D". This field is required. This field must have the value as shown on the passport.