...
Common to all the checks is the requirement to pass additional data fields in the "extraData" or "optionalData" element of the web service method. The extraData element The extraData or optionalData element contains a list of name-value pairs, and if the correct entries are present, then additional background checks will be performed.
...
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" or "optionalData" field. The extra fields that can be passed are:
...
To initiate a background DVS driver's licence check, the following fields must be passed in the extraData or optionalData element:
- driversLicenceState - the driver's licence state; must be one of: ACT, NSW, NT, QLD, SA, TAS, VIC or WA. This field is required.
- driversLicenceNumber - the driver's licence number, exactly as it appears on the licence. This field is required. This field must have the value as shown on the drivers licence.
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.
...
To initiate a background DVS Medicare card check, the following fields must be passed in the extraData or optionalData element:
- medicareCardNumber - the Medicare card number. This field is required. This field must have the value as shown on the Medicare card.
- medicareIndividualReferenceNumber - the person's individual reference number on their Medicare card. This field is required. This field must have the value as shown on the Medicare card.
- medicareCardExpiryDate - the Medicare card expiry date. The expected format for regular green Medicare cards is MM/YYYY, and for blue and yellow Medicare cards, the expected format is DD/MM/YYYY. This field is required. This field must have the value as shown on the Medicare card.
- medicareCardColour - the colour of the Medicare card. For regular green Medicare cards, the expected value is "G". For blue Medicare cards, the expected value is "B", and for yellow Medicare cards, the expected value is "Y". This field is required.
- medicareNameOnCard - the person's name as it appears on the Medicare card. This field is optional; if it is not provided, then the person's name details from the other parameters are used, and will be converted the usual Medicare format of given name followed by the first letter of the middle name(s) followed by the surname. This field must have the value as shown on the Medicare card.
Medicare card can only be used as a background source if the name is on one line. Names that wrap across more than one line will not pass as a background check.
...
To initiate a background DVS Australian Passport check, the following fields must be passed in the extraData or optionalData element:
- passportNumber - the Passport number. This field is required. This field must have the value as shown on the passport.
- passportGenderCode - the person's gender. This field is required. Valid values are "M" (male") or "F" (female). This field must have the value as shown on the passport.
...
To initiate a background DVS Visa check, the following fields must be passed in the extraData or optionalData element:
- visaPassportNumber - the Passport number. This field is required. This field must have the value as shown on the passport.
- visaCountryOfIssue - 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. The list of valid country codes is attached to the greenID API DVS Visa Data Source Reference; please look at the attachment in this section to find the list. This field must have the value as shown on the passport.
...
- The default setting is to run the Credit Header for all registrations. This can only be done when all people registered with greenID have given explicit approval for their details to be tested against the Credit header. This consent must be obtained by the customer.
- We can receive a flag via the extraData or optionalData element to indicate that the person has given explicit approval to be run against the Credit Header. Add anextraData element an extraData or optionalData element with the name "dnb-credit-header-consent-given" with the value "true" to indicate that consent has been given. If you require this option, please contact us.
...