Australian Document Verification Service (DVS) Check
The Australian Document Verification Service (DVS) check validates identity data against official government records in real time. This capability ensures that customer credentials (such as Passports, Driver licences, or Medicare Cards) are authentic and belong to a living person.
Customers can either upload this data directly as Prepared Data or have it automatically extracted by an upstream capability (such as OCR/document scan) within the workflow.
- Workflow key for Prepared Data is 10020
- Workflow key for Extraction with ID Verification is 10054
Supported Credentials
The following values can be uploaded as Prepared Data. Alternatively, they can be extracted by an upstream capability in a workflow.
- Driver licence (DRIVING_LICENCE)
- Passport (PASSPORT)
Request
Example Prepared Data Body (Passport Example)
When triggering an Australian DVS check with a Passport, use the country code AUS and set the document type to PASSPORT.
{
"firstName": "May Lee",
"address": {
"country": "AUS"
},
"dateOfBirth": "1985-02-08",
"id": {
"idNumber": "949XXX000",
"type": "PASSPORT"
}
}
Example Prepared Data Body (Passport Example)
When verifying an Australian Driver licence, you must include both the licence number (idNumber) and the card number or state-specific identifier (secondaryIdNumber) inside the id block.
Here the document type should be DRIVING_LICENCE.
{
"firstName": "JOHN CITIZEN",
"lastName": "SMITH",
"dateOfBirth": "1990-01-15",
"address": {
"line1": "123 George St",
"postalCode": "2000",
"city": "Sydney",
"subdivision": "NSW",
"country": "AUS"
},
"id": {
"idNumber": "2XXXXX71",
"secondaryIdNumber": "20XXXXX138",
"type": "DRIVING_LICENCE"
}
}
Data
| Field | |
|---|---|
| idNumber | The primary Driver licence number. |
| secondaryIdNumber | The Card Number found on the physical driver's licence (varies by Australian state or territory). This value is required by the Australian DVS registry to help prevent fraud. |
| subdivision | The abbreviation of the issuing Australian state or territory (for example, NSW, VIC, QLD, WA, SA, TAS, ACT, or NT). This must match the jurisdiction that issued the driver's licence. |
Response
Response data is available for transactions that include the risk signal. For information on transaction data see Viewing or Retrieving Workflow Transactions.
Example Response
"govtIdVerification": [
{
"id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
"credentials": [
{
"id": "z9y8x7w6-v5u4-3t2s-1r0q-p9o8n7m6l5k4",
"category": "ID"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "LOW_RISK"
}
},
"data": {
"country": "AUS",
"type": "DRIVER_LICENCE",
"completeNameMatch": "MATCH",
"initialNameMatch": "MATCH",
"firstNameMatch": "MATCH",
"lastNameMatch": "MATCH",
"nationalIdMatch": "MATCH",
"dobDayMatch": "MATCH",
"dobMonthMatch": "MATCH",
"dobYearMatch": "MATCH",
"dobMatch": "MATCH",
"addressMatch": "MATCH",
"score": 10
}
}
]
Decision Details Labels
| Decision Type | Label | Description |
|---|---|---|
| PASSED | LOW_RISK | No significant risk associated with the provided data. The identity details successfully match the Australian DVS registry. |
| REJECTED | HIGH_RISK | High risk associated with the provided data. The identity details are mismatched or potentially invalid. |
| WARNING | MEDIUM_RISK | Moderate risk associated with the provided data. A partial match or minor discrepancies were found. |
| NOT_EXECUTED | PERMISSION_DENIED | The verification could not be performed because the required permissions or credentials are missing. Verify your API key and Australian DVS access rights. |
| NOT_EXECUTED | BAD_REQUEST | The verification could not be performed because the request is malformed or required parameters are missing (for example, mandatory card numbers or names). |
| NOT_EXECUTED | PRECONDITION_NOT_FULFILLED | The verification could not be performed because one or more preconditions were not met. |
| NOT_EXECUTED | TECHNICAL_ERROR | The verification could not be performed due to an unexpected server-side error or an issue communicating with the external DVS registry. |
Data
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
| country | string | AUS | Country where the Government Check is performed. |
| type | string | DRIVER_LICENCE, PASSPORT, MEDICARE_CARD | Type of identity document used for the verification. |
| completeNameMatch | string | MATCH, NOT_MATCH | Indicates whether the complete name matches the government record. |
| initialNameMatch | string | MATCH, NOT_MATCH | Indicates whether the initials match the government record. |
| firstNameMatch | string | MATCH, NOT_MATCH | Indicates whether the first name matches the government record. |
| lastNameMatch | string | MATCH, NOT_MATCH | Indicates whether the last name matches the government record. |
| nationalIdMatch | string | MATCH, NOT_MATCH | Indicates whether the document or licence number matches the government record. |
| dobDayMatch | string | MATCH, NOT_MATCH | Indicates whether the day of birth matches the government record. |
| dobMonthMatch | string | MATCH, NOT_MATCH | Indicates whether the month of birth matches the government record. |
| dobYearMatch | string | MATCH, NOT_MATCH | Indicates whether the year of birth matches the government record. |
| dobMatch | string | MATCH, NOT_MATCH | Overall result of the date of birth comparison. |
| addressMatch | string | MATCH, NOT_MATCH | Indicates whether the address matches the government record. |
| score | integer | 10, 20, 30 | Summary verification score (10 = Pass, 20 = Warning, 30 = Reject). |