Configuring vSure

vSure is a data provider that enables you to run the Visa check for Australian work or study visas.

How it works

This check is performed by searching vSure’s database for the following information taken from the individual’s profile:

  • The individual’s name
  • The individual’s date of birth
  • The individual’s passport number
  • The individual’s passport issuing country

When you configure this check, you choose whether it uses vSure only or whether it checks multiple data providers.

If you choose vSure only, the check passes when the individual’s details are associated with a valid visa in vSure’s database and that visa hasn’t expired.

If you choose multiple data providers, the check passes when the individual’s details are associated with a valid visa in any of the data providers’ databases and that visa hasn’t expired.

When the check passes, the following information is displayed:

  • Date of grant
  • Date of expiry
  • Work rights and visa conditions

If the individual’s details do not match the data in vSure’s records, the check fails.

If the individual’s profile doesn’t have data for the required fields, the check returns an error.

If the country of address in the individual’s profile isn’t covered by vSure, the check returns an error.

Configuration options

Visa type (required): Can be Work visas or Study visas.

This option specifies whether the search returns work visas or study visas.

If you want to use vSure to search for work and study visas, we’ll add one instance of vSure configured to search for work visas, and then add a second instance configured to search for study visas.

When there are two instances of vSure configured (one for work visas and one for study visas), you have two additional options for how the Visa check set up, depending on what you want to learn from the check:

  1. To learn whether individuals have work AND study visas: We’ll create two tasks. On the first task, we’ll add a Visa check that uses the instance of vSure configured to search for work visas. On the second task, we’ll add a Visa check that uses the instance of vSure configured to search for study visas.
  2. To learn whether individuals have work OR study visas: We’ll create a single task with one Visa check. Configure the Visa check to use both instances of vSure, treating the two instances as two different data providers. Learn more about configuring the Visa check.

What we’ll need

Let us know that you’d like to run this check with vSure and which configuration options you’d like to use. Please also send us your vSure API token.

Testing your configuration

Once the check is configured, follow these steps in your demo environment to test whether the check is working as expected.

  1. Does the check pass when the individual has a valid temporary work/study visa? To run the test, create any individual profile and run the check. If the check passes, it’s working as expected.
  2. Does the check pass when the individual has a valid indefinite work/study visa? To run the test, create an individual profile with ‘NO_EXPIRY’ as a given name or surname (e.g. ‘Alex NO_EXPIRY Wheeler’) and run the check. If the check passes, it’s working as expected.
  3. Does the check fail when the individual does not have any work/study visa? To run the test, create an individual profile with ‘NO_VISA’ as a given name or surname (e.g. ‘Alex NO_VISA Wheeler’) and run the check. If the check fails, it’s working as expected.
  4. Does the check fail when the individual has an expired work/study visa? To run the test, create an individual profile with ‘EXPIRED’ as a given name or surname (e.g. ‘Alex EXPIRED Wheeler’) and run the check. If the check fails, it’s working as expected.
  5. Does the check fail when the data provider has no record of the individual? To run the test, create an individual profile with ‘NOT_FOUND’ as a given name or surname (e.g. ‘Alex NOT_FOUND Wheeler’) and run the check. If the check fails, it’s working as expected.
The test words are case-sensitive.

vSure’s records are searched using the following fields from the individual profile’s personal_details:

API field name

Description

Notes

personal_details.name.given_names

The individual’s first and, if applicable, middle names.

Required

personal_details.name.family_name

The individual’s last name.

Required

personal_details.dob

The individual’s date of birth.

Required

address_history.address.country

The individual’s current country of address.

Required

The Visa check also uses the following fields from the visa check’s documents:

API field name

Description

Note

document_metadata.document_type

The document’s type. This field is only used by the API and is not displayed in the portal.

Required

Must equal “PASSPORT” for the check to pass.

document_metadata.number

The individual’s passport number.

Required

Document_metadata.country_ code

The individual’s passport issuing country.

Required

The country is provided as an ISO3 code. Learn more.

By default, the check passes when on a 2+2 result, which means that the individual’s identity is matched in two distinct sources. If the individual can only be matched in one source, the check returns a partial match.


How did we do?