Australian ID Documents

Driver’s Licences

This guide explains how to verify Australian driver’s licences across different states and territories.

Required Fields

Implementation Example

Example Request
1{
2  "identityDocs": [
3    {
4      "idType": "DRIVERS_LICENCE",
5      "country": "AUS",
6      "region": "NSW",
7      "idNumber": "N49187",
8      "extraData": [
9        {
10          "kvpKey": "document_number",
11          "kvpType": "general.string",
12          "kvpValue": "21631234"
13        }
14      ]
15    }
16  ]
17}

Format Requirements

StateFormatLengthExample
ACTNumericUp to 10123456789
NTNumericUp to 10123456789
QLDNumeric8-912345678
NSWAlphanumeric6-8N49187
SAAlphanumeric6ABC123
TASAlphanumeric6-8A12345
VICNumericUp to 10123456789
WANumeric71234567
Victorian Licence Verification - Important Update

As of July 1st, 2023, Victorian card number verification has special handling:

  • For compromised licenses (e.g., Optus breach): DVS verifies current card number
  • For non-compromised licenses: Card number isn’t verified (can match license number)
  • Always capture card numbers as historical compromises may affect verification
  • Direct DVS users will see audit log entry: “Successful Match - Card Number hasn’t been checked”

DVS Response Handling

To receive expanded verification details: 1. Enable the “full check results” flag 2. Access results in: entityResult.nameCheck.checkResult[x].checkProcessResults

Sample License Images

Australian Passports & Visas

This guide covers verification requirements for both Australian passports and visas. Both document types use similar verification fields but have some key differences.

Document Types Overview

Passport Verification

Australian passport verification for citizens and permanent residents.

Visa Verification

Australian visa verification for temporary residents and visitors.

Required Fields

Important Considerations

When verifying visas, ensure you’re using the correct passport number that the visa is associated with. Using an incorrect or expired passport number will result in verification failure.

For visa holders from countries with different name formats, always use the name order and format exactly as shown

Medicare Cards

The Australian Medicare Card is a government-issued healthcare card that comes in three colors: Green, Blue, and Yellow. Each card type has specific validation requirements and data formats. This guide explains how to integrate Australian Medicare Card verification into your application.

Required Fields

Implementation Example

Sample Medicare Card Request
1{
2    "entity": {
3        "entityType": "INDIVIDUAL",
4        "entityProfile": "safe_harbour_id",
5        "gender": "M",
6        "name": {
7            "givenName": "BRUCE",
8            "middleName": "TWOPASS",
9            "familyName": "TESTTHIRTYNINE"
10        },
11        "dateOfBirth": {
12            "dateOfBirth": "1988-01-01"
13        },
14        "addresses": [
15            {
16                "addressType": "RESIDENTIAL1",
17                "streetNumber": "287",
18                "streetName": "Gooyong",
19                "streetType": "St",
20                "town": "WOOMERA",
21                "postalCode": "5720",
22                "state": "SA",
23                "country": "AUS"
24            }
25        ],
26        "identityDocs": [
27            {
28                "idType": "NATIONAL_HEALTH_ID", // Medicare Card Identifier
29                "idSubType": "G",              // G = Green Medicare Card
30                "idNumber": "5156598231",      // Full card number
31                "idExpiry": "2030-01-01",      // Expiry date with appended day
32                "extraData": [
33                    {
34                        "kvpKey": "reference",
35                        "kvpValue": "1"        // Reference number (1-5)
36                    },
37                    {
38                        "kvpKey": "display_middle_name",
39                        "kvpValue": "X"        // Middle initial (optional)
40                    }
41                ],
42                "country": "AUS"
43            }
44        ]
45    }
46}

Use this checklist to ensure your Medicare Card implementation is correct:

  • Card type is specified correctly (G/B/Y)
  • Full name matches card exactly
  • Date formats follow YYYY-MM-DD
  • Reference number is between 1 and 5
  • Country is set to “AUS”
  • Middle initial is included if present on card

Name Change Certificates

The Name Change Certificate is an official document that verifies a person’s legal name change in Australia. Each state and territory maintains its own registry for name changes, but the verification process is standardized across the country.

Required Fields

Implementation Example

Example Request
1{
2  "identityDocs": [
3    {
4      "idType": "NAME_CHANGE",
5      "country": "AUS",
6      "region": "NSW",
7      "idNumber": "NC123456789",
8      "extraData": [
9        {
10          "kvpKey": "certificate_number",
11          "kvpValue": "CERT123456"
12        },
13        {
14          "kvpKey": "certificate_date_of_print",
15          "kvpValue": "2023-06-15"
16        },
17        {
18          "kvpKey": "certificate_date_of_registration",
19          "kvpValue": "2023-06-01"
20        },
21        {
22          "kvpKey": "registered_name_family",
23          "kvpValue": "SMITH"
24        },
25        {
26          "kvpKey": "registered_name_first_given",
27          "kvpValue": "JOHN"
28        },
29        {
30          "kvpKey": "registered_name_other_given",
31          "kvpValue": "MICHAEL"
32        }
33      ]
34    }
35  ]
36}

Extra Data Fields Reference

1{
2  "kvpKey": "certificate_number",
3  "kvpValue": "your_certificate_number"
4}

Ensure all names match exactly as shown on the certificate, including: - Capitalization - Spacing - Special characters - Middle names/initials

When verifying a name change certificate along with other ID documents: 1. Use the new legal name in the main entity object 2. Include the original name details only in the name change certificate’s extraData 3. Ensure all dates are in ISO format (YYYY-MM-DD)

Birth Certificates

Birth certificates are primary identity documents issued by Australian state and territory Registry of Births, Deaths and Marriages. Verification requirements may vary based on the issuing jurisdiction and year of issue.

Required Fields

Implementation Example

Example Request
1{
2  "identityDocs": [
3    {
4      "idType": "BIRTH_CERT",
5      "country": "AUS",
6      "region": "NSW",
7      "idNumber": "1234567890",
8      "extraData": [
9        {
10          "kvpKey": "registration_date",
11          "kvpValue": "1990-03-15"
12        },
13        {
14          "kvpKey": "registration_district",
15          "kvpValue": "SYDNEY"
16        },
17        {
18          "kvpKey": "certificate_number",
19          "kvpValue": "CERT123456"
20        },
21        {
22          "kvpKey": "certificate_date_of_print",
23          "kvpValue": "2023-01-10"
24        },
25        {
26          "kvpKey": "registered_name_family",
27          "kvpValue": "SMITH"
28        },
29        {
30          "kvpKey": "registered_name_first_given",
31          "kvpValue": "JOHN"
32        },
33        {
34          "kvpKey": "registered_name_other_given",
35          "kvpValue": "MICHAEL"
36        }
37      ]
38    }
39  ]
40}

Extra Data Fields Reference

1{
2  "kvpKey": "registration_date",
3  "kvpValue": "YYYY-MM-DD"  // or "YYYY"
4},
5{
6  "kvpKey": "registration_district",
7  "kvpValue": "DISTRICT_NAME"  // Optional
8}

Match requirements vary by jurisdiction and certificate age. Ensure you provide:

  • All available registration details
  • Exact name matching as shown on certificate
  • Correct date formats
Registration Requirements

The requirements for registration number and date matching vary based on:

  • Certificate’s issuing State/Territory
  • Year of issue
  • Registry’s historical record format

Always provide as much information as available for the most accurate verification.

When handling birth certificates:

  1. Collect all available fields, even optional ones
  2. Pay special attention to historical date formats
  3. Note any discrepancies between registered name and current legal name
  4. Verify registration district spelling where applicable

Citizenship Certificates

Australian Citizenship Certificates are official documents that prove Australian citizenship. They contain unique identifiers and can be used to verify both acquired and birth-right citizenship status.

Required Fields

Implementation Example

Example Request
1{
2  "identityDocs": [
3    {
4      "idType": "CITIZENSHIP",
5      "country": "AUS",
6      "idNumber": "ABC123456",  // Stock number
7      "extraData": [
8        {
9          "kvpKey": "acquisition_date",
10          "kvpValue": "2020-03-15"
11        },
12        {
13          "kvpKey": "primary_country",
14          "kvpValue": "GBR"  // Original citizenship
15        },
16        {
17          "kvpKey": "secondary_country",
18          "kvpValue": "AUS"  // New citizenship
19        }
20      ]
21    }
22  ]
23}

Extra Data Fields Reference

1{
2  "kvpKey": "acquisition_date",
3  "kvpValue": "YYYY-MM-DD"
4}

When verifying citizenship certificates: - Ensure the stock number is entered exactly as shown - Use correct ISO country codes (3-letter format) - Match names precisely as they appear on the certificate

Common ISO country codes for citizenship verification:

  • AUS - Australia
  • GBR - United Kingdom
  • NZL - New Zealand
  • USA - United States
  • CHN - China
  • IND - India

For dual citizenship cases:

  • Primary country typically represents original citizenship
  • Secondary country should be ‘AUS’ for Australian citizenship certificates
  • You must provide both country codes to verify successfully

ImmiCard

The ImmiCard is an official immigration credential issued by the Department of Home Affairs to eligible visa holders and other non-citizens. It serves as an official photo identification document for accessing services in Australia.

Required Fields

Implementation Example

1{
2  "entity": {
3    "entityProfile": "gov_id",
4    "name": {
5      "familyName": "Jones",
6      "middleName": "",
7      "givenName": "Matthew Test"
8    },
9    "dateOfBirth": {
10      "dateOfBirth": "1980-01-01"
11    },
12    "identityDocs": [
13      {
14        "idType": "IMMIGRATION",
15        "country": "AUS",
16        "idNumber": "PRE123456",
17        "region": ""
18      }
19    ]
20  }
21}

ImmiCard Number Format

Format Requirements

ImmiCard numbers must follow this pattern:

  • First 3 characters: Letters (A-Z, case insensitive)
  • Last 6 characters: Numbers (0-9)
  • Total length: 9 characters
  • Example: PRE123456

Common validation issues:

  • Incorrect ImmiCard number format
  • Missing or incorrect name format for single-name individuals
  • Incorrect date format (must be YYYY-MM-DD)
Name Handling

When dealing with names on ImmiCards:

  1. Use exact spelling and format as shown on the card
  2. For single names, use hyphen (-) in given name field
  3. Include middle names if present on the card 4. Maintain case sensitivity
Address Requirements

While the example includes address information, it’s not required for ImmiCard verification. However, if provided, ensure:

  • All address components are accurate
  • State codes are valid Australian states/territories
  • Postal codes match the state/territory

Marriage Certificates

Australian Marriage Certificates are official documents that verify a legal marriage. Following the Marriage Amendment (Definition and Religious Freedoms) Act 2017, certificates support various formats for recording participant details.

Required Fields

Partner Information

1// Bride Details
2{
3  "kvpKey": "bride_name_family",
4  "kvpValue": "SMITH"
5},
6{
7  "kvpKey": "bride_name_first_given",
8  "kvpValue": "JANE"
9},
10{
11  "kvpKey": "bride_name_other_given",
12  "kvpValue": "MARIE"
13},
14
15// Groom Details
16{
17  "kvpKey": "groom_name_family",
18  "kvpValue": "JONES"
19},
20{
21  "kvpKey": "groom_name_first_given",
22  "kvpValue": "JOHN"
23},
24{
25  "kvpKey": "groom_name_other_given",
26  "kvpValue": "MICHAEL"
27}

Implementation Example

Complete Example
1{
2  "identityDocs": [
3    {
4      "idType": "MARRIAGE_CERT",
5      "country": "AUS",
6      "region": "VIC",
7      "idNumber": "1234567890",
8      "extraData": [
9        {
10          "kvpKey": "registration_year",
11          "kvpValue": "2023"
12        },
13        {
14          "kvpKey": "marriage_date",
15          "kvpValue": "2023-06-15"
16        },
17        {
18          "kvpKey": "certificate_number",
19          "kvpValue": "CERT123456"
20        },
21        {
22          "kvpKey": "certificate_date_of_print",
23          "kvpValue": "2023-06-20"
24        },
25        {
26          "kvpKey": "certificate_date_of_registration",
27          "kvpValue": "2023-06-16"
28        },
29        {
30          "kvpKey": "partner1_name_family",
31          "kvpValue": "SMITH"
32        },
33        {
34          "kvpKey": "partner1_name_first_given",
35          "kvpValue": "JANE"
36        },
37        {
38          "kvpKey": "partner1_name_other_given",
39          "kvpValue": "MARIE"
40        },
41        {
42          "kvpKey": "partner2_name_family",
43          "kvpValue": "JONES"
44        },
45        {
46          "kvpKey": "partner2_name_first_given",
47          "kvpValue": "SARAH"
48        },
49        {
50          "kvpKey": "partner2_name_other_given",
51          "kvpValue": "ELIZABETH"
52        }
53      ]
54    }
55  ]
56}
State-Specific Requirements

Victoria (VIC) has specific requirements for field mapping:

  • Enter the left-hand column/first row details as Name 2
  • This applies regardless of the order on the certificate
  • Consult state-specific DVS specifications for other jurisdictions
Marriage Equality Support

Certificates support multiple format combinations:

  • Traditional: Bride/Groom format
  • Modern: Partner 1/Partner 2 format
  • Use the appropriate format based on the certificate layout
Best Practices

When verifying marriage certificates:

  1. Check the certificate format before choosing field names
  2. Ensure all dates are in correct ISO format
  3. Verify state-specific requirements
  4. Include all available optional fields
  5. Match names exactly as shown on certificate
Built with