Australian Visa Entitlement Check Results

One of the checks you can perform as part of a recipe is a Visa Entitlement Check (checkType = visa)

This will check a non-Australian passport to see if there is a known Australian visa issued to the holder, and the details of that visa, such as class/sub-class, issue and expiry dates, onshore/offshore processing and any work entitlements.

The summary results can be found in the entityProfileResult → checkResults section

The details of the visa entitlement can be found in the individual results for the relevant identityDocument, in this case a non-Australian PASSPORT or VISA type document.

In that result, there will be a number of Key Value Pairs in the resultNotes ProcessResultObject. Those keys will include the following:

Key Name

Value Description

visa.applicant

Whether this entity is the “Primary” or “Secondary” applicant on the visa

visa.class

The visa class. Will be one of the values found here:
https://immi.homeaffairs.gov.au/visas/getting-a-visa/visa-listing

visa.subclass

The visa subclass. Will be one of the values found here
See above list at the Home Affairs website for the complete list

visa.grantDate

The date the visa was granted in YYYY-MM-DD format.

If blank, then the visa has rotentially be expired or not yet granted. See visa.expiryDate for more

visa.expiryDate

Will be one of the following:

  • NO EXPIRY or blank - visa has no expiry
  • EXPIRED - visa has expired and is no longer valid
  • A date in YYYY-MM-DD format

visa.location

The location the visa was awarded. One of:

  • onshore - the visa was granted whilst the person was in Australia
  • A country name - if available, the country where the visa was applied for
  • offshore - if the exact country of application is not given, then “offshore” will be returned.

entitlement.summary

A short, human readable description of the working and residential rights of the visa grantee.

Example

An example set would look like the following:

"checkProcessResults": {
    "checkDate": "2021-06-30T04:16:25.568Z",
    "checkId": "9d46205b-5f23-6156-2d5e-b97adb0a390a",
    "checkPerformedBy": "datazoo",
    "checkSource": "au-vevo",
    "checkType": "two_plus,id",
    "confidenceLevel": 84,
    "providerCheckID": "ccgnujhk4iz3",
    "resultNotes": [
      {
        "kvpKey": "document_matched",
        "kvpType": "general.string",
        "kvpValue": "Australian Visa Entitlement"
      },
      {
        "kvpKey": "visa.applicant",
        "kvpType": "general.string",
        "kvpValue": "Primary"
      },
      {
        "kvpKey": "visa.class",
        "kvpType": "general.string",
        "kvpValue": "B"
      },
      {
        "kvpKey": "visa.subclass",
        "kvpType": "general.string",
        "kvpValue": "143"
      },
      {
        "kvpKey": "visa.grantDate",
        "kvpType": "general.string",
        "kvpValue": "2019-06-05"
      },
      {
        "kvpKey": "visa.expiryDate",
        "kvpType": "general.string",
        "kvpValue": "2024-06-06"
      },
      {
        "kvpKey": "visa.location",
        "kvpType": "general.string",
        "kvpValue": "onshore"
      },
      {
        "kvpKey": "entitlement.summary",
        "kvpType": "general.string",
        "kvpValue": "The visa holder has unlimited right to work in Australia"
      },
      {
        "kvpKey": "document_idtype",
        "kvpType": "general.string",
        "kvpValue": "PASSPORT"
      },
      {
        "kvpKey": "original_checksource",
        "kvpType": "general.string",
        "kvpValue": "Australian Visa Entitlement"
      }
    ],
    "resultState": "CHECKED_SUCCESS_CLEAR"
  },

Did this page help you?