vSure WebApp API

Integrate with the vSure end-to-end work rights compliance platform using our simple, v1 RESTful API

Documentation

API Key

The API Key An API key for specific IP Address(es) must be requested from vSure support. Please use the "Raise a Support Ticket" above or click here and please include: Your company name; Your product name (if different); The vSure client c...

Self-Onboarding Endpoint

You can manage Self On-boarding via Email/SMS in vSure for a new employee/contractor/candidate via the RESTful API. The vSure API address is: https://api.vsure.com.au/v1/onboarding The Account Key The vSure client must also include the account key pr...

Employee

You can GET existing employee/contractor records and POST to (update) specific employee/contractor fields within the vSure app. https://api.vsure.com.au/employee/v1 NOTE the API key is a parameter in the URL. Account Key ID The vSure client must als...

Retrieve Work Rights Status

You can retrieve existing employee/contractor work rights status via a POST or PUT. https://api.vsure.com.au/v1/getdata The Account Key The vSure client must also include the account key provided on the "My Account" screen in the vSure Web...

Email in lieu of API

Some systems, don't have an API for integrating to vSure, but they do offer email triggers. To allow single data entry onboarding, we have built a "trigger onboard from email" feature. Register for "email to vSure auto-onboarding"...