Skip to main content
One of the checks that can be performed 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, 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 NameValue Description
visa.applicantWhether this entity is the “Primary” or “Secondary” applicant on the visa.
visa.classThe visa class. Will be one of the values found here: <https://immi.homeaffairs.gov.au/visas/getting-a-visa/visa-listing>
visa.subclassThe visa subclass. Will be one of the values found here: See the above list at the Home Affairs website for the complete list.
visa.grantDateThe date the visa was granted in YYYY-MM-DD format. If blank, then the visa has potentially been expired or not yet granted. See visa.expiryDate for more.
visa.expiryDateWill 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.locationThe 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 isn’t given, then “offshore” will be returned.
entitlement.summaryA short, human readable description of the working and residential rights of the visa grantee.

​
Example

An example set would look like the following:
Example CheckProcessResult
    "checkProcessResults": {  
        "checkDate": "2021-06-30T04:16:25.568Z",  
        "checkId": "9d46205b-5f23-6156-2d5e-b97adb0a390a",  
        "checkPerformedBy": "ncc",  
        "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"  
      },
This is how the results will look like in the FrankieOne Portal.