Australian Data Sources


Title

Webservice Name

Type

Coverage

ACT Driver's Licence

Australian Data Sources#actrego

Driver's Licence

ACT

DVS ACT Driver's Licence

Australian Data Sources#actregodvs

Driver's Licence

ACT

Australian Electoral Roll

Australian Data Sources#aec

Electoral Roll

Australia

DVS Birth Certificate (BDM)

Australian Data Sources#birthcertificatedvs

Certificate - Birth

Australia

DVS Centrelink Concession Card

Australian Data Sources#centrelinkdvs

CentrelinkAustralia

DVS Change of Name Certificate (BDM)

Australian Data Sources#changeofnamecertificatedvs

Certificate - Name Change

Australia

DVS Citizenship Certificate

Australian Data Sources#citizenshipcertificatedvs

Certificate - Citizenship

Australia

illion credit header

Australian Data Sources#dnb

Credit History

Australia

Document Upload

Australian Data Sources#docupload



DVS Immicard

Australian Data Sources#immicarddvs


Australia

DVS Marriage Certificate (BDM)

Australian Data Sources#marriagecertificatedvs

Certificate - Marriage

Australia

Medibank Private

Australian Data Sources#medibank

Health Insurance

Australia

DVS Medicare

Australian Data Sources#medicaredvs

Health Insurance

Australia

NSW driver's licence

Australian Data Sources#nswrego

Driver's Licence

NSW

DVS NSW driver's licence

Australian Data Sources#nswregodvs

Driver's Licence

NSW

DVS NT driver's licence

Australian Data Sources#ntregodvs

Driver's Licence

NT

DVS Australian Passport

Australian Data Sources#passportdvs

Passport

Australia

Queensland driver's licence

Australian Data Sources#qldrego

Driver's Licence

QLD

DVS Queensland driver's licence

Australian Data Sources#qldregodvs

Driver's Licence

QLD

SA driver's licence

Australian Data Sources#sarego

Driver's Licence

SA

DVS SA driver's licence

Australian Data Sources#saregodvs

Driver's Licence

SA

DVS Tasmanian driver's licence

Australian Data Sources#tasregodvs

Driver's Licence

TAS

Victorian electoral roll

Australian Data Sources#vicec

Electoral Roll

VIC

Victorian driver's licence

Australian Data Sources#vicrego

Driver's Licence

VIC

Victorian driver's licence

Australian Data Sources#vicrego_old

Driver's Licence

VIC

DVS Victorian driver's licence

Australian Data Sources#vicregodvs

Driver's Licence

VIC

Work Visa check

Australian Data Sources#visa

Visa

Australia

DVS Visa (foreign passport)

Australian Data Sources#visadvs

Visa

Australia

WA driver's licence

Australian Data Sources#warego

Driver's Licence

WA

DVS WA driver's licence

Australian Data Sources#waregodvs

Driver's Licence

WA


actrego (version 1)

Also known as ACT Driver's Licence or ACT Registration or ACT Registration Licence check


Field name

Description

Required

Restrictions

greenid_actrego_number

The driver's licence number, as it appears on the licence. This field is required. This field must be between 1 and 10 characters long.

Yes

Length between 1 and 10

greenid_actrego_givenname

The person's given name, as it appears on the licence. 

Yes

Length between 1 and 255

greenid_actrego_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255

greenid_actrego_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_actrego_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

actregodvs (version 1)

Also known as DVS ACT Driver's Licence or ACT Registration or ACT Driver Licence check (DVS)


Field name

Description

Required

Restrictions

greenid_actregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Length between 1 and 10 alphanumeric characters, no space or special characters

greenid_actregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length between 1 and 20

greenid_actregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length between 1 and 20

greenid_actregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40

greenid_actregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_actregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_actregodvs_cardnumber

The ACT driver's licence card number.

Located just left of the photo, printed vertically on the front of the licence.

YesLength equal to 10 alphanumeric characters


aec (version 1)

Also known as Australian Electoral Roll or AEC or Electoral Roll

Field name

Description

Required

Restrictions

greenid_aec_givenname

The person’s given names, exactly as it appears on the Electoral Roll.

Any middle names should be entered in the ‘Given Name’ field as per the user’s enrolment on the Electoral Roll.

Yes

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 25 characters.

greenid_aec_surname

The person’s surname, exactly as it appears on the Electoral Roll.

Yes

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 25 characters.

greenid_aec_dob

The person’s date of birth, as registered on the Electoral Roll.

Yes

DD/MM/YYYY

Must be a valid date in the past.

greenid_aec_propertyname

The  property name component of the person’s address, as it appears on the Electoral Roll.

Yes - if present on the Electoral Roll*

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 25 characters.

greenid_aec_flatnumber

The flat or unit number component of the person’s address, as it appears on the Electoral Roll.

Yes – if present on the Electoral Roll*

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 6 characters.

greenid_aec_streetnumber

The street number component of the person’s address, as it appears on the Electoral Roll

Yes

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 6 characters.

greenid_aec_streetname

The street name component of the person’s address, as it appears on the Electoral Roll.

Yes

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 25 characters.

greenid_aec_streettype

The street type component of the person’s address, as it appears on the Electoral Roll.


Yes - if present on the Electoral Roll*

Must contain only upper or lower case alphabetic characters, or spaces.

Maximum of 18 characters.

greenID is supporting an expanded list of street types to validation against the DVS list - Street Types .

greenid_aec_suburb

The suburb component of the person’s address, as it appears on the Electoral Roll.

Yes

Must contain only upper or lower case alphabetic characters, spaces, apostrophes, or hyphens.

Maximum of 25 characters.

greenid_aec_state

The suburb component of the person’s address, as it appears on the Electoral Roll.

Yes

Must be one of:

·      ACT

·      NSW

·      NT

·      QLD

·      SA

·      TAS

·      VIC

·      WA

greenid_aec_postcode

The postcode component of the person’s address, as it appears on the Electoral Roll.

Yes

Must be four digits.

greenid_aec_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

Must be the value “on”.

*The field is a not a required / mandatory field in greenID but a value should be provided to achieve a match on the Electoral Roll if the user is registered with those details.


birthcertificatedvs (version 1)

Also known as DVS Birth Certificate (BDM) or Birth Certificate or Birth Certificate check (DVS)


Field name

Description

Required

Restrictions

greenid_birthcertificatedvs_givenname

 The person's given name, as printed on the Birth Certificate.

No

Length no more than 60 characters
May be blank

greenid_birthcertificatedvs_middlename

The person's middle names, as printed on the Birth Certificate.

No

Together with given name, length no more than 60 characters
May be blank

greenid_birthcertificatedvs_surname

The person's surname, as printed on the Birth Certificate.

Yes

Length no more than 50 characters

greenid_birthcertificatedvs_dob

The person's date of birth, as printed on the Birth Certificate.

Yes

DD/MM/YYYY

greenid_birthcertificatedvs_registration_number

The registration number, as printed on the Birth Certificate.

Yes

Length between 1 and 10 characters

greenid_birthcertificatedvs_registration_date

The registration date, as printed on the Birth Certificate.

No except for QLD and TAS certificates

DD/MM/YYYY

greenid_birthcertificatedvs_registration_year

The registration year, as printed on the Birth Certificate.

Required for NSW, VIC, QLD 
Required for WA, and TAS 

YYYY

greenid_birthcertificatedvs_registration_state

The state that issued the Birth Certificate.

Yes

One of ACT, NSW, NT, SA, QLD, TAS, VIC or WA.

greenid_birthcertificatedvs_certificate_number

The certificate number, as printed on the Birth Certificate.

Required for NSW (only for certificates issued after 1/7/2010)
Required for SA (only for certificates issued after 1/11/1999)
Required for ACT and NT.

Length between 1 and 11 characters

greenid_birthcertificatedvs_certificate_printed_date

The date the certificate was printed, as printed on the Birth Certificate. This field is required in conjunction with the greenid_birthcertificatedvs_certificate_number field, therefore the same restrictions apply.

Yes

DD/MM/YYYY

greenid_birthcertificatedvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"

centrelinkdvs (version 0)


Field name

Description

Required

Restrictions

greenid_centrelinkdvs_cardType

The Centrelink Card Type

Yes

"PCC" (Pensioner concession card), "HCC" (Health care card) and "SHC" (Seniors health card)

greenid_centrelinkdvs_number

The person's CRN, as it appears on the Centreliink card (no spaces).

Yes 

9 digits followed by 1 letter

greenid_centrelinkdvs_nameOnCard

The person's name, as it appears on the Centrelink card (as a single field).

Yes 

Length between 1 and 32

greenid_centrelinkdvs_dob

The person's date of birth, as it appears on the card.

Yes

DD/MM/YYYY

greenid_centrelinkdvs_expiry

The card expiry date, as it appears on the card.

Yes

DD/MM/YYYY

greenid_centrelinkdvs_tandc

An indication that the person agrees to the terms and conditions of the centrelink check.

Yes

"on"


changeofnamecertificatedvs (version 1)

Also known as DVS Change of Name Certificate (BDM) or Change of Name Certificate (DVS) or Change of Name Certificate (DVS)


Field name

Description

Required

Restrictions

greenid_changeofnamecertificatedvs_givenname

The person's given name, as printed on the Change of Name Certificate.

Yes (if present)

Length no more than 60 characters.
May be blank

greenid_changeofnamecertificatedvs_middlename

The person's middle names, as printed on the Change of Name Certificate.

Yes (if present)

Together with given name, length no more than 60 characters
May be blank

greenid_changeofnamecertificatedvs_surname

The person's surname, as printed on the Change of Name Certificate.

Yes

Length no more than 50 characters.

greenid_changeofnamecertificatedvs_old_givennameThe person's original given name, as printed on the Change of Name Certificate.

Yes (if present) for ACT, NT, SA and TAS.

Not required for NSW, QLD, VIC or WA.

Length no more than 20 characters when required.
greenid_changeofnamecertificatedvs_old_middlenameThe person's original middle names, as printed on the Change of Name Certificate.NoMay be blank
greenid_changeofnamecertificatedvs_old_surnameThe person's original surname, as printed on the Change of Name Certificate.

Yes (if present) for ACT, NT, SA and TAS.

Not required for NSW, QLD, VIC or WA.

Length no more than 20 characters when required.

greenid_changeofnamecertificatedvs_dob

The person's date of birth, as printed on the Change of Name Certificate.

Yes

DD/MM/YYYY

greenid_changeofnamecertificatedvs_registration_number

The registration number, as printed on the Change of Name Certificate.

Yes, except for TAS certificates issued before 1/11/2000

Between 1 and 10 alphanumeric characters

greenid_changeofnamecertificatedvs_registration_date

The registration date, as printed on the Change of Name Certificate.

No, except for QLD and TAS certificates.

DD/MM/YYYY

greenid_changeofnamecertificatedvs_registration_year

The registration year, as printed on the Change of Name Certificate.

No, except for NSW, VIC, WA and TAS (if date of registration is on or after 1/11/1999) certificates

YYYY

greenid_changeofnamecertificatedvs_registration_state

The state that issued the Change of Name Certificate.

Yes

One of ACT, NSW, NT, SA, QLD, TAS, VIC or WA.

greenid_changeofnamecertificatedvs_certificate_number

The certificate number, as printed on the Change of Name Certificate.

No, except for NSW (only for certificates issued after 1/7/2010), SA (only for certificates issued after 1/11/1999), ACT (only for certificates issued on or after 1/5/2002) and NT

Between 1 and 11 alphanumeric characters

greenid_changeofnamecertificatedvs_certificate_issued_date

The date the certificate was issued, as printed on the Change of Name Certificate.

Required in conjunction with the certificate number field, so the same restrictions apply

DD/MM/YYYY

greenid_changeofnamecertificatedvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"


citizenshipcertificatedvs (version 1)

Also known as DVS Citizenship Certificate or Citizenship Certificate (DVS) or Citizenship Certificate (DVS). Does not contain the descent certifcate - refer to version 2.


Field name

Description

Required

Restrictions

greenid_citizenshipcertificatedvs_givenname

The person's given name, as printed on the Citizenship Certificate.

Yes (if present)

Length no more than 100 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_citizenshipcertificatedvs_middlename

The person's middle names, as printed on the Citizenship Certificate.

Yes (if present)

Together with given name, length no more than 100 characters

greenid_citizenshipcertificatedvs_surname

The person's surname, as printed on the Citizenship Certificate.

Yes

Length less than 100 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_citizenshipcertificatedvs_dob

The person's date of birth, as printed on the Citizenship Certificate.

Yes

DD/MM/YYYY

greenid_citizenshipcertificatedvs_stock_number

The stock number, as printed on the Citizenship Certificate.

Yes

Between 4 and 11 characters

greenid_citizenshipcertificatedvs_acquisition_date

The acquisition date as printed on the Citizenship Certificate.

Yes

DD/MM/YYYY

greenid_citizenshipcertificatedvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"

citizenshipcertificatedvs (version 2)

Version 2 includes the descent certificate.


Field name

Description

Required

Restrictions

greenid_citizenshipcertificatedvs_givenname

The person's given name, as printed on the Citizenship Certificate.

Yes (if present)

Length no more than 100 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_citizenshipcertificatedvs_middlename

The person's middle names, as printed on the Citizenship Certificate.

Yes (if present)

Together with given name, length no more than 100 characters

greenid_citizenshipcertificatedvs_surname

The person's surname, as printed on the Citizenship Certificate.

Yes

Length less than 100 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_citizenshipcertificatedvs_dob

The person's date of birth, as printed on the Citizenship Certificate.

Yes

DD/MM/YYYY

greenid_citizenshipcertificatedvs_stock_number

The stock number or Client Id, as printed on the Citizenship Certificate.

Yes

Between 4 and 11 characters for stock number, 11 digits for Client Id

greenid_citizenshipcertificatedvs_register_numberThe Register No., as printed on the Citizenship by descent (pre-July 2005) certificate.Yes (if present)Between 1 and 4 digits
greenid_citizenshipcertificatedvs_entry_numberThe Entry No., as printed on the Citizenship by descent (pre-July 2005) certificate.Yes (if present)Between 1 and 5 digits

greenid_citizenshipcertificatedvs_acquisition_date

The acquisition date as printed on the Citizenship Certificate.

Yes

DD/MM/YYYY

greenid_citizenshipcertificatedvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"


dnb (version 1)

Also known as illion credit header


Field name

Description

Required

Restrictions

greenid_dnb_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"


docupload (version 1)

Also known as Document Upload or Uploading a document for manual review by an administrator

Field name

Description

Required

Restrictions

greenid_docupload_type

The type of document being uploaded, for example "Telephone Bill". This type is not used to enforce any restriction on the document itself, it's used to provide information to the administrator who will be reviewing the document.

Yes

Length less than 256 characters

greenid_docupload_filename

A name for the document being uploaded. This is also used to provide information to the administrator who will be reviewing the document. 
The filename is also used to determine the type of the file, which is when the administrator is viewing the file. The valid extensions are bmp, jpg, gif, png and pdf. If one of these is not present, then the file type is set to "unknown", and browsers may not be able to render the document properly.

Yes

Length less than 256 characters

greenid_docupload_data

The actual image file data. This field must be base64 encoded data. If the image data cannot be decoded properly, then the image will not display correctly.
There is currently a size restriction of 10Mb on the amount of data that can be passed for a single file.

Yes

Base64 encoded image data


immicarddvs (version 1)

Also known as DVS Immicard or Immi Card (DVS)


Field name

Description

Required

Restrictions

greenid_immicarddvs_givenname

The person's given name

Yes (if not present use a hyphen)

Length between 1 and 49 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_immicarddvs_middlename

The person's middle names

No

Together with given name, length between 1 and 49 characters

greenid_immicarddvs_surname

The person's surname

Yes

Length between 1 and 49 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_immicarddvs_dob

The person's date of birth

Yes

DD/MM/YYYY

greenid_immicarddvs_card_number

The card number, as it appears on their immicard.

Yes

3 letters followed by 6 digits

greenid_immicarddvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"


marriagecertificatedvs (version 1)

Also known as DVS Marriage Certificate (BDM) or Marriage Certificate (DVS)


Field name

Description

Required

Restrictions

greenid_marriagecertificatedvs_givenname

The person's given name, as printed on the Marriage Certificate.

Yes (if present)

Length less than 60 characters

greenid_marriagecertificatedvs_middlename

The person's middle names, as printed on the Marriage Certificate.

Yes (if present)

Together with given name, length no more than 60 characters

greenid_marriagecertificatedvs_surname

The person's surname, as printed on the Marriage Certificate.

Yes

No more than 50 characters

greenid_marriagecertificatedvs_spouse_givenname

The spouse's given name, as printed on the Marriage Certificate.

Yes (if present)

Length no more than 60 characters

greenid_marriagecertificatedvs_spouse_middlename

The spouse's middle names, as printed on the Marriage Certificate.

Yes (if present)

Together with spouse's given name, length no more than 60 characters

greenid_marriagecertificatedvs_spouse_surname

The spouse's surname, as printed on the Marriage Certificate.

Yes

No more than 50 characters

greenid_marriagecertificatedvs_marriage_date

The date of the marriage, as printed on the Marriage Certificate.

Yes

DD/MM/YYYY

greenid_marriagecertificatedvs_registration_number

The registration number, as printed on the Marriage Certificate.

Yes, except for TAS certificates issued before 1/11/2000

Between 1 and 10 alphanumeric characters

greenid_marriagecertificatedvs_registration_year

The registration year, as printed on the Marriage Certificate.

No, except for NSW, VIC, WA and TAS certificates

YYYY

greenid_marriagecertificatedvs_registration_state

The state that issued the Marriage Certificate.

Yes

One of ACT, NSW, NT, SA, TAS, VIC or WA.

greenid_marriagecertificatedvs_certificate_number

The certificate number, as printed on the Marriage Certificate.

No except for certificates issued in SA, ACT (only for certificates issued on or after 1/5/2002) and NT.

Between 1 and 11 alphanumeric characters

greenid_marriagecertificatedvs_certificate_issued_date

The date the certificate was issued, as printed on the Marriage Certificate.

Required in conjunction with certificate number, so the same restrictions apply

DD/MM/YYYY

greenid_marriagecertificatedvs_party

An indication of which party the person was at the wedding.

Yes

"bride" or "groom"

greenid_marriagecertificatedvs_tandc

An indication that the person agrees to the terms and conditions of the check.

Yes

"on"


medibank (version 1)

Also known as Medibank Private or Medibank Membership

Field name

Description

Required

Restrictions

greenid_medibank_number

The person's Medibank membership number.

Yes

Length no longer than 10 characters

greenid_medibank_givenname

The person's given name, as it appears on the Medibank membership card.

Yes

Length between 1 and 255 characters

greenid_medibank_surname 

The person's surname, as it appears on their Medibank membership card.

Yes

Length between 1 and 255 characters

greenid_medibank_dob

The person's date of birth, as it appears on their Medibank membership card.

Yes

DD/MM/YYYY

greenid_medibank_tandc

An indication that the person has agreed to the terms and conditions of using this data source.

Yes

"on"


medicaredvs (version 1)

Also known as DVS Medicare or Medicare (DVS)

Field name

Description

Required

Restrictions

greenid_medicaredvs_number

The person's Medicare number, as it appears on the Medicare card (no spaces).

Yes

Must be a valid Australian Medicare number, 10 digits long.

greenid_medicaredvs_individualReferenceNumber

The person's individual reference number on their Medicare card, usually one of 1, 2, 3, 4, 5, or 6.

Yes

A single digit

greenid_medicaredvs_expiry

The expiry date, as it appears on the Medicare card. Depending on the card, this date may be in the format MM/YYYY or DD/MM/YY.

Yes

MM/YYYY for green Medicare cards
DD/MM/YY for other colours

greenid_medicaredvs_nameOnCard

The person's name, as it appears on the Medicare card (as a single field).

Yes

Length between 1 and 27 characters, spaces, digits, hyphens and apostrophes permitted

greenid_medicaredvs_nameLine2

The second line of the name, if the person's name wraps over more than one line. This must appear exactly as it does on the Medicare card.

No

Length cannot be longer than 25 characters, spaces, digits, hyphens and apostrophes

greenid_medicaredvs_nameLine3

The third line of the name, if the person's name wraps over more than one line. This must appear exactly as it does on the Medicare card.

No

Length cannot be longer than 23 characters, spaces, digits, hyphens and apostrophes

greenid_medicaredvs_nameLine4

The fourth line of the name, if the person's name wraps over more than one line. This must appear exactly as it does on the Medicare card.

No

Length cannot be longer than 21 characters, spaces, digits, hyphens and apostrophes

greenid_medicaredvs_cardColour

The Medicare card colour.

Yes

"G" (green cards), "B" (blue cards) and "Y" (yellow cards)

greenid_medicaredvs_dob

The person's date of birth. Note that this is not shown on the card.

No

DD/MM/YYYY (if present)

greenid_medicaredvs_tandc

An indication that the person agrees to the terms and conditions of the Medicare card check.

Yes

"on"


Note: Checking the date of birth is an improvement to the existing medicaredvs source implemented in September 2015. If your greenID account was established before this date, then you will need to contact greenID to update your account configuration to include the date of birth field.

nswrego (version 1)

Also known as NSW driver's licence or NSW Registration or NSW Driver Licence check

Field name

Description

Required

Restrictions

greenid_nswrego_number

The person's drivers licence number, as it appears on the licence.

Yes

Length between 1 and 10 characters

greenid_nswrego_cardnumber

The NSW driver's licence card number.

Located in the top right hand corner, just above the photo on the front of the licence.

Yes

Length not exceeding 8 characters

greenid_nswrego_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_nswrego_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"


nswregodvs (version 1)

Also known as DVS NSW driver's licence or NSW Registration (DVS) or NSW Driver's Licence check (DVS)


Field name

Description

Required

Restrictions

greenid_nswregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_nswregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_nswregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_nswregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_nswregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_nswregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_nswregodvs_cardnumber

The NSW driver's licence card number.

Located in the top right hand corner, just above the photo on the front of the licence.

YesLength equal to 10 numeric characters


ntregodvs (version 1)

Also known as DVS NT driver's licence or NT Registration (DVS) or NT Driver's Licence check (DVS)

Field name

Description

Required

Restrictions

greenid_ntregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_ntregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_ntregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_ntregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_ntregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_ntregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_ntregodvs_cardnumber

The NT driver's licence card number.

Located at the bottom on the back of the licence.

YesLength between 6 and 8 numeric characters

passportdvs (version 1)

Also known as DVS Australian Passport or Passport (DVS) check


Field name

Description

Required

Restrictions

greenid_passportdvs_number

The person's passport number, as it appears on their passport (no spaces).

Yes

between 8 and 9 alphanumeric characters, must be one or two alphas followed by 7 digits

greenid_passportdvs_givenname

The person's given name, as it appears on their passport.

Yes (if not present use a hyphen)

Length between 1 and 31 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_passportdvs_middlename

The person's middle name, as it appears on the passport.

Yes (if present)

Together with given name, length between 1 and 31 characters

greenid_passportdvs_surname

The person's surname as it appears on their passport.

Yes

Length between 1 and 31 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_passportdvs_dob

The person's date of birth, as it appears on their passport.

Yes

DD/MM/YYYY

Must be a full DOB (partial DOB's i.e. year only are not supported)

greenid_passportdvs_gender

The person's gender, as it appears on their passport; valid values are "M" (male) or "F" (female).

No

This field is optional.

If gender matching on DVS passport is not a key requirement of your verification process it is recommended that this is not added as an input field.

If you want to pass through gender and have it count to the DVS check, please discuss this with your GBG account representative so appropriate changes to your account can be made.

greenid_passportdvs_tandc

An indication that the person agrees to the terms and conditions of the passport check.

Yes

"on"


qldrego (version 1)

Also known as Queensland driver's licence or QLD Registration or QLD Registration Licence check


Field name

Description

Required

Restrictions

greenid_qldrego_number

The person's driver's licence number, as it appears on the licence.

Yes

Length between 1 and 12 characters

greenid_qldrego_givenname

The person's given name, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_qldrego_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_qldrego_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_qldrego_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"


qldregodvs (version 1)

Also known as DVS Queensland driver's licence or QLD Registration (DVS) or QLD Driver's Licence check (DVS)

Field name

Description

Required

Restrictions

greenid_qldregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_qldregodvs_givenname

The person's given name, as it appears on the licence.

Yes

Length not exceeding 20 characters

greenid_qldregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_qldregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_qldregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_qldregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_qldregodvs_cardnumber

The QLD driver's licence card number.

Located at the bottom, either on the front or back of the licence.

YesLength equal to 10 alphanumeric characters 


sarego (version 1)

Also known as SA driver's licence or SA Registration or SA Registration Licence check

Field name

Description

Required

Restrictions

greenid_sarego_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters

greenid_sarego_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_sarego_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_sarego_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"


saregodvs (version 1)

Also known as DVS SA driver's licence or SA Registration (DVS) or SA Driver's Licence check (DVS)

Field name

Description

Required

Restrictions

greenid_saregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_saregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_saregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_saregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_saregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_saregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_saregodvs_cardnumber

The SA driver's licence card number.

Located in the top right hand corner on the back of the licence.

YesLength equal to 9 alphanumeric characters

tasregodvs (version 1)

Also known as DVS Tasmanian driver's licence or TAS Registration (DVS) or TAS Driver's Licence check (DVS)


Field name

Description

Required

Restrictions

greenid_tasregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_tasregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_tasregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_tasregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_tasregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_tasregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_tasregodvs_cardnumber

The TAS driver's licence card number.

Located in the top right hand corner on the back of the licence.

YesLength equal to 9 alphanumeric characters

vicec (version 1)

Also known as Victorian electoral roll or VIC EC or Victorian Electoral Roll Database check

Field name

Description

Required

Restrictions

greenid_vicec_givenname

The person's given name, as it appears on the electoral roll.

Yes

Length between 1 and 255 characters

greenid_vicec_middlename

The person's middle name, as it appears on the electoral roll.

Yes (if present)

Length between 1 and 255 characters

greenid_vicec_surname

The person's surname, as it appears on the electoral roll.

Yes

Length between 1 and 255 characters

greenid_vicec_dob

The person's date of birth, as it appears on the electoral roll.

Yes

DD/MM/YYYY

greenid_vicec_streetnumber

The street number component of the person's address.

Yes

Only digits
Should not contain unit/flat number

greenid_vicec_streetname

The street name component of the person's address.

Yes

Length between 1 and 255 characters

greenid_vicec_streettype

The street name 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 "vicec" for the available options. Note that the list is quite long. Also note that the "value" component must be supplied as input to setFields, i.e. "211" is the value that corresponds to "Street", so "255" should be supplied, not "Street".

greenid_vicec_suburb

The suburb component of the person's address.

Yes

Length between 1 and 255 characters

greenid_vicec_tandc

An indication that the person agrees to the terms and conditions of the Victorian electoral roll check.

Yes

"on"


vicrego (version 1)

A more comprehensive check than the vicrego_old. Also known as Victorian driver's licence or Vic Registration or Vic Registration Licence check

Field name

Description

Required

Restrictions

greenid_vicrego_number

The person's driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, i.e. no special characters or spaces

greenid_vicrego_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_vicrego_addressLine1

The first line of the person's address, as it appears on their licence.

Yes

Length between 1 and 255 characters

greenid_vicrego_addressLine2

The second line of the person's address, as it appears on their licence.

No

Length between 0 and 255 characters

greenid_vicrego_addressLine3

The third line of the person's address, as it appears on their licence.

No

Length between 0 and 255 characters

greenid_vicrego_dob

The person's date of birth, as it appears on their licence.

Yes

DD/MM/YYYY

greenid_vicrego_tandc

An indication that the person agrees to the terms and conditions of the Victorian driver's licence check.

Yes

"on"


vicrego_old (version 1)

Also known as Victorian driver's licence or Vic Driver Licence or VicDL


Field name

Description

Required

Restrictions

greenid_vicrego_old_number

The person's driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, i.e. no special characters or spaces

greenid_vicrego_old_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 255 characters

greenid_vicrego_old_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_vicrego_old_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"


vicregodvs (version 1)

Also known as DVS Victorian driver's licence or VIC Registration (DVS) or VIC Driver's Licence check (DVS)

Field name

Description

Required

Restrictions

greenid_vicregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_vicregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_vicregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_vicregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_vicregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_vicregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_vicregodvs_cardnumber

The VIC driver's licence card number.

Located either in the top right hand corner or in the middle right hand corner, on the back of the licence.

YesLength equal to 8 alphanumeric characters


visa (version 1)

Also known as work Visa check

Field name

Description

Required

Restrictions

greenid_visa_number

The person's visa number, as it appears on their passport.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_visa_surname

The person's surname, as it appears on their passport.

Yes

Length between 1 and 255 characters

greenid_visa_dob

The person's date of birth, as it appears on their passport.

Yes

DD/MM/YYYY

greenid_visa_country

The country that issued the passport.

Yes

This field is a select field, please refer to the output from a call to getFields with the sourceId "visa" for the available options

greenid_visa_tandc

An indication that the person agrees to the terms and conditions of the visa check.

Yes

"on"


visadvs (version 1)

Also known as DVS Visa (foreign passport) or Visa (DVS) check

Field name

Description

Required

Restrictions

greenid_visadvs_passport_number

The person's passport number, as it appears on their passport.

Yes

Between 1 and 14 alphanumeric characters, no space or special characters

greenid_visadvs_givenname

The person's given name, as it appears on their passport.

Yes (if not present use a hyphen)

Length between 1 and 49 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_visadvs_middlename

The person's middle name, as it appears on their passport.

Yes (if present)

Together with given name, length between 1 and 49 characters

greenid_visadvs_surname

The person's surname as it appears on their passport.

Yes

Length between 1 and 49 characters, only alpha characters (upper and lowercase), hyphens, apostrophes and spaces accepted.

greenid_visadvs_dob

The person's date of birth, as it appears on their passport.

Yes

DD/MM/YYYY

greenid_visadvs_country_of_issue

The 3 letter country code of the country that issued the passport, except Germany, which is denoted by the single character "D".

Yes

The list of valid country codes is attached to this page; please look at the attachments section to find the list.


greenid_visadvs_tandc

An indication that the person agrees to the terms and conditions of the Visa check.

Yes

"on"


warego (version 1)

Also known as WA driver's licence or WA Registration or WA Registration Licence check

Field name

Description

Required

Restrictions

greenid_warego_number

The person's driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 characters

greenid_warego_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_warego_expiry

The expiry date of the licence.

Yes

DD/MM/YYYY

greenid_warego_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

waregodvs (version 1)

Also known as DVS WA driver's licence or WA Driver's Licence check (DVS)

Field name

Description

Required

Restrictions

greenid_waregodvs_number

The driver's licence number, as it appears on the licence.

Yes

Between 1 and 10 alphanumeric characters, no space or special characters

greenid_waregodvs_givenname

The person's given name, as it appears on the licence.

Yes (if not present use a fullstop)

Length not exceeding 20 characters

greenid_waregodvs_middlename

The person's middle name, as it appears on the licence.

No

Length not exceeding 20 characters

greenid_waregodvs_surname

The person's surname, as it appears on the licence.

Yes

Length between 1 and 40 characters

greenid_waregodvs_dob

The person's date of birth, as it appears on the licence.

Yes

DD/MM/YYYY

greenid_waregodvs_tandc

An indication that the person agrees to the terms and conditions of the licence check.

Yes

"on"

greenid_waregodvs_cardnumber

The WA driver's licence card number.

Located generally in the middle right hand corner, on the back of the licence.

YesBetween 8 and 10 alphanumeric characters