Documentation
POSTMAN Collection
You can find the vSure v2 API in the POSTMAN marketplace, which you can find via the following direct link: https://www.postman.com/vsure-developers You will need to use POSTMAN environment to set-up the variables and for the vSure v2 API POSTMAN col...
Authentication
The vSure Visa Check API uses OAuth2 to authenticate your application. Applications are issued a client_id and a client_secret, and you exchange these credentials securely to receive an access token. You can then use the access token to make API call...
Customer Authority
vSure acts on your / your client's behalf when performing a visa check. In New Zealand, visa checks MUST BE performed with reference to your/your client's RealMe account details. In Australia, visa checks can optionally record your/your client's Immi...
Visa Check
The Visa Check endpoint is where all the heavy lifting gets done by vSure to submit and return visa check results. vSure checks can be run for Australia and/or New Zealand across various use cases such as: Work Rights check Study Visa enquiry Foreig...
Visa Check Lifecycle
Visa checks happen asynchronously to your API calls, which means you'll need to check the status of a check before acting on any data returned from the API. Simple Sequence The following sequence diagram shows the overall steps involved in performing...
Upgrade from v1 to v2
vSure has offered its v1 Visa Check API in market for close to a decade. We have a large number of clients who will transition from v1 to v2. Here's the key FAQs around v1 vs v2. How long do we have? There are no plans to retire v1 API at this stage....
Resources
It is our goal at vSure to deliver the optimal developer experience. Where it makes sense, we add additional resources to make your life easier and help you deliver an optimal user experience for your customers/users/staff/candidates. Our current add...
Test Cases - Australia | Work Visa Check Type
The following test cases are available within the aus:sandbox scope for 'work' visa checks. Work is the default visa check type and covers most use cases apart from Study Visa and Migration Agent checks. Please note that the family_name and given_nam...
Test Cases - Australia | Study Visa Check Type
The following test cases are available within the aus:sandbox scope for 'Study' Visa checks: Please note that the family_name and given_name (below as John Smith), can be anything you want, without affecting the response. Feel free to use your own na...
Test Cases - New Zealand
The following test cases are available within the nzl:sandbox scope. The request JSON preceding the new_zealand specific array will be consistent: { "jurisdiction": "NZL", "environment": "sandbox",...