Configuring vSure

vSure is a data provider that you can use to run the Visa check.

How it works

This is the behaviour of a variant of the Visa check with vSure as the data provider.

The 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

The check passes when the individual’s details are associated with a valid visa in vSure’s database 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, an error is displayed.

If the country of address in the individual’s profile is anything other than Australia, an error is displayed.

Configuration options

Visa type to check (required): This option determines whether the search returns matches with work visas or study visas. Can be WORK or STUDY.

To search for work visas and study visas

If you want to use vSure to search for work and study visas, we’ll add one check variant with the Visa type to check option set to WORK and a second check variant with the Visa type to check option set to STUDY.

With two check variants, you have two additional options for the Visa check:

  1. To learn whether individuals have work AND study visas: We’ll create two tasks. On the first task, we’ll add the check variant for work visas. On the second task, we’ll add the check variant for study visas.
  2. To learn whether individuals have work OR study visas: We’ll create a single task with both check variants. If the task is configured to run automatically, you can specify that the variants waterfall, which means that the second variant runs automatically if the first one fails.

What we’ll need

Let us know that you’d like to use vSure for the Visa check.

We'll need your vSure API token.

We'll also need to know whether you want to configure the check variant for work visas or study visas.

If you'd like to configure two check variants, please let us know whether you'd like to add them as two separate tasks or add them to a single task, and whether you'd like to configure the check variants to waterfall.

If you're not sure, we'll be happy to speak to you more about your use case to help you make a decision.

Testing your configuration

Once the check variant(s) are configured, follow these steps in your demo environment to test whether they're 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 a check variant. 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 a check variant. 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 a check variant. 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 a check variant. 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 a check variant. If the check fails, it’s working as expected.
In the live environment, an error is displayed when the check variant is run on a profile with a country of address that isn't Australia. This error is not displayed in the demo environment.
The test words are case-sensitive.

Body parameters

When you make the request to run the check, include the following parameters in the body. They'll be searched in vSure’s records.

Key

Value

Description

personal_details.name.given_names

Required

Sample value: Alex

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

personal_details.name.family_name

Required

Sample value: Wheeler

The individual’s last name.

personal_details.dob

Required

Sample value: 1975-04-19

The individual’s date of birth.

address_history.address.country

Required

Australia

The individual’s current country of address.

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

Key

Value

Description

document_metadata.document_type

Required

PASSPORT

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

document_metadata.number

Required

Sample value: 12345678

The individual’s passport number.

Document_metadata.country_ code

Required

The country is provided as an ISO3 code.

Sample value: GBR

The individual’s passport issuing country.

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?


Powered by HelpDocs