Document Types
Supported identity documents and required fields
VeroID supports twelve Australian identity document types, verified against official government record holders.
Driver's Licence
{
"documentType": "drivers_licence",
"givenName": "John",
"familyName": "Smith",
"dateOfBirth": "1990-01-15",
"licenceNumber": "1234567",
"stateOfIssue": "NSW",
"cardNumber": "1234567890"
}States: NSW, VIC, QLD, WA, SA, TAS, ACT, NT
Card Number: Required for all states as of December 2022 (DL Match Spec v15.0). Max 10 characters.
Field limits: givenName max 20 chars, familyName max 40 chars, licenceNumber max 10 chars.
Passport
{
"documentType": "passport",
"givenName": "Jane",
"familyName": "Doe",
"dateOfBirth": "1985-06-20",
"passportNumber": "PA1234567",
"gender": "F"
}passportNumber: 1–2 letters followed by 7 digits (e.g. PA1234567 or N1234567).
givenName: Optional — omit only for single-name passport holders.
Gender: Optional. M (Male), F (Female), X (Indeterminate/non-binary).
Date of birth: Partial dates accepted — YYYY, YYYY-MM, or YYYY-MM-DD.
Field limits: givenName and familyName max 31 chars each.
Medicare Card
Medicare uses the name as printed on the card rather than a given/family split. Use fullName for the name on line 1 of the card. Lines 2–4 (fullName2–fullName4) are optional and used when the card lists multiple people.
{
"documentType": "medicare",
"fullName": "JOHN SMITH",
"medicareNumber": "2123456701",
"individualReferenceNumber": 1,
"cardColour": "G",
"expiryDate": "2027-11"
}Card Colours: G (Green/standard), B (Blue/interim), Y (Yellow/reciprocal health care)
Expiry format: Green cards use YYYY-MM (month/year printed on card). Blue and Yellow cards use YYYY-MM-DD.
Date of birth: Optional. If provided, must be a full YYYY-MM-DD date.
Field limits: fullName max 27 chars, fullName2 max 25 chars, medicareNumber exactly 10 digits.
Visa
Checks a visa grant against the Department of Home Affairs. Uses the passport number and country associated with the visa application.
{
"documentType": "visa",
"givenName": "John",
"familyName": "Smith",
"dateOfBirth": "1990-01-15",
"passportNumber": "PA1234567"
}Country of issue: Optional. ISO 3166-1 alpha-3 code (e.g. GBR, USA).
Date of birth: Partial dates accepted — YYYY, YYYY-MM, or YYYY-MM-DD.
Birth Certificate
{
"documentType": "birth_certificate",
"givenName": "Jane",
"familyName": "Doe",
"dateOfBirth": "1985-06-20",
"registrationNumber": "12345678",
"registrationState": "VIC",
"registrationYear": 1985
}givenName: Optional — omit only for single-name birth certificates.
registrationNumber: Max 10 characters (max 7 for NSW). Provide either registrationNumber or certificateNumber (max 12 chars). ACT certificates require certificateNumber.
Date of birth: Partial dates accepted — YYYY, YYYY-MM, or YYYY-MM-DD.
registrationYear: Integer (e.g. 1985), not a string.
Citizenship Certificate
{
"documentType": "citizenship",
"givenName": "John",
"familyName": "Smith",
"dateOfBirth": "1990-01-15",
"stockNumber": "12345678901",
"acquisitionDate": "2020-07-01"
}stockNumber: Max 11 characters, alphanumeric and forward slashes only (e.g. ACC123456 or CAS/1234).
givenName: Optional — omit only for single-name individuals.
acquisitionDate: Required. Full date YYYY-MM-DD.
Date of birth: Partial dates accepted — YYYY, YYYY-MM, or YYYY-MM-DD.
ImmiCard
{
"documentType": "immicard",
"givenName": "John",
"familyName": "Smith",
"dateOfBirth": "1990-01-15",
"immiCardNumber": "EAB123456"
}immiCardNumber: 3 uppercase letters followed by 6 digits (e.g. EAB123456).
givenName: Required (max 49 chars). Use a hyphen if the individual has no given name.
familyName: Required (max 49 chars).
Date of birth: Partial dates accepted — YYYY, YYYY-MM, or YYYY-MM-DD.
Marriage Certificate
{
"documentType": "marriage_certificate",
"familyName": "Smith",
"givenName": "John",
"familyName2": "Jones",
"givenName2": "Jane",
"dateOfMarriage": "2015-03-21",
"registrationState": "NSW",
"registrationYear": 2015
}Participant 1: familyName required (max 50), givenName optional (max 60).
Participant 2: familyName2 required (max 50), givenName2 optional (max 60).
dateOfMarriage: Required. Full date YYYY-MM-DD.
certificateNumber: Optional max 11 chars. Required for ACT certificates.
registrationNumber: Optional max 10 chars.
Change of Name Certificate
{
"documentType": "change_of_name_certificate",
"familyName": "Smith",
"givenName": "John",
"oldFamilyName": "Jones",
"oldGivenName": "Jonathan",
"dateOfBirth": "1990-01-15",
"registrationState": "NSW",
"registrationYear": 2020
}New name: familyName required (max 50), givenName optional (max 60).
Previous name: oldFamilyName optional (max 50), oldGivenName optional (max 60).
dateOfBirth: Required. Full date YYYY-MM-DD.
certificateNumber: Optional max 11 chars. Required for ACT certificates.
Death Certificate
{
"documentType": "death_certificate",
"familyName": "Smith",
"givenName": "John",
"dateOfDeath": "2024-11-30",
"registrationState": "NSW"
}givenName: Optional — omit for single-name individuals. Max 60 chars.
familyName: Required (max 50 chars).
dateOfDeath: Required. Full date YYYY-MM-DD.
certificateNumber: Optional max 12 chars.
registrationNumber: Optional max 10 chars (max 7 for NSW).
Centrelink Concession Card
{
"documentType": "centrelink",
"name": "JOHN SMITH",
"customerReferenceNumber": "123456789A",
"cardExpiry": "2027-06-30",
"cardType": "PCC"
}name: Name as printed on the card, max 32 chars.
customerReferenceNumber: 9 digits followed by 1 letter, no spaces (e.g. 123456789A).
cardExpiry: Required. Full date YYYY-MM-DD.
cardType: PCC (Pensioner Concession), HCC (Health Care), or SHC (Seniors Health).
dateOfBirth: Optional. Full date YYYY-MM-DD if provided.
ASIC / MSIC
Aviation Security Identification Card (ASIC) and Maritime Security Identification Card (MSIC).
{
"documentType": "asic_msic",
"nameOnCard": "JOHN SMITH",
"dateOfBirth": "1990-01-15",
"cardNumber": "ASIC1234567",
"cardExpiry": "2027-06",
"cardType": "ASIC"
}nameOnCard: Name as printed on the card, max 128 chars.
dateOfBirth: Required. Full date YYYY-MM-DD.
cardNumber: Required, max 50 chars.
cardExpiry: Required. Month/year format YYYY-MM (not a full date).
cardType: ASIC or MSIC.