Document Definitions

definitions of the data fields able to be supplied and retrieved for the varying documents available

For more information about documents and how they work see the documentation

Click here to download the following data in json format

Note: Validators of type date will have a +/- number in them this is the number of days old which it must be at least(+) or at most(-)

Passport - Global

Fields

• Label: Passport number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z0-9]{6,9}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

Australian passport - AU

Fields

• Label: Passport number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^[A-Za-z0-9]{6,9}$

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Gender
• Name: gender

• Type: SELECT

• Validations:

  Type	Value
  REQUIRED	``

• Selection values:

  Type	Value
  Female	Female
  Male	Male
  Other	Indeterminate

---

New Zealand passport - NZ

Fields

• Label: Passport number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^[A-Za-z0-9]{6,9}$

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

Driver licence - Global

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{2,20}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

Australian driver licence - AU

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^[A-Za-z0-9]{1,10}$

---

• Label: Driver licence card number (optional)
• Name: document_number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z0-9]{0,10}$

---

• Label: State
• Name: state

• Type: SELECT

• Validations:

  Type	Value
  REQUIRED	``

• Selection values:

  Type	Value
  Australian Capital Territory	ACT
  Queensland	QLD
  New South Wales	NSW
  Northern Territory	NT
  South Australia	SA
  Tasmania	TAS
  Victoria	VIC
  Western Australia	WA

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

United Kingdom driving licence - GB

Fields

• Label: Driving licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{2,18}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

New Zealand driver licence - NZ

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z]{2}\d{6,7}$
  REQUIRED	``

---

• Label: Version number
• Name: version

• Type: NUMBER

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^\d{1,4}$

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

Certified Passport - Global

Fields

• Label: Passport number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z0-9]{6,9}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

Certified Passport - AU

Fields

• Label: Passport number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^[A-Za-z0-9]{6,9}$

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Gender
• Name: gender

• Type: SELECT

• Validations:

  Type	Value
  REQUIRED	``

• Selection values:

  Type	Value
  Female	Female
  Male	Male
  Other	Indeterminate

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

Certified Driver Licence - Global

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{2,20}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

Certified Driver Licence - AU

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^[A-Za-z0-9]{1,10}$

---

• Label: Driver licence card number (optional)
• Name: document_number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z0-9]{0,10}$

---

• Label: State
• Name: state

• Type: SELECT

• Validations:

  Type	Value
  REQUIRED	``

• Selection values:

  Type	Value
  Australian Capital Territory	ACT
  Queensland	QLD
  New South Wales	NSW
  Northern Territory	NT
  South Australia	SA
  Tasmania	TAS
  Victoria	VIC
  Western Australia	WA

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

Certified Driver Licence - GB

Fields

• Label: Driving licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{2,18}$
  REQUIRED	``

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

Certified Driver Licence - NZ

Fields

• Label: Driver licence number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[A-Za-z]{2}\d{6,7}$
  REQUIRED	``

---

• Label: Version number
• Name: version

• Type: NUMBER

• Validations:

  Type	Value
  REQUIRED	``
  REGEX	^\d{1,4}$

---

• Label: Expiry date
• Name: expiry

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-3652
  REQUIRED	``

---

• Label: Certification date
• Name: certification-date

• Type: DATE

• Validations:

  Type	Value
  DATE_COMPARISON	-36525
  DATE_LESS_THAN	1
  REQUIRED	``

---

National ID - Global

Fields

• Label: National ID number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9().-]{2,20}$
  REQUIRED	``

---

National ID - CN

Fields

• Label: National ID number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{7,18}$
  REQUIRED	``

---

• Label: 姓名 (Full name as shown on ID)
• Name: home-country-fullname

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``

---

National ID - MX

Fields

• Label: National ID number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{15,18}$
  REQUIRED	``

---

• Label: Maternal family name
• Name: maternal-family-name

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``

---

• Label: Paternal family name
• Name: paternal-family-name

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``

---

National ID - TH

Fields

• Label: National ID number
• Name: number

• Type: TEXT

• Validations:

  Type	Value
  REGEX	^[a-zA-Z0-9]{13,17}$
  REQUIRED	``

---

• Label: Laser code
• Name: laser-code

• Type: TEXT

• Validations:

  Type	Value
  REQUIRED	``

---

---

Related Docs