1. vSure Onboarding API
You can automate the "self on-boarding email" in vSure for a new employee/contractor/candidate from an API POST.
1.1 The vSure API address is:
1.2 The API Key
An API key for specific IP Address(es) must be requested from vSure support. Please use the Zendesk "Submit a Request" above or click here and please include:
- Your company name;
- Your product name (if different);
- The vSure client company name;
- Developer Contact name;
- Developer Contact Email;
- Your Development IP Address(es) for white-listing;
- Your Live environment IP Address(es) for white-listing;
Once an API key has been created, vSure will use this API key to authenticate the API connections.
1.3 The Account Key
The vSure client must also include the account key provided on the My Account Screen (see below) as part of the request data. vSure will use this key to add the employee/contractor/candidate to the account.
2.1 API Onboarding – JSON Structure
Our API onboarding system accepts JSON format:
The following is the details of the data:
key - string
The vSure API key we provided to you
accountkeyid - string
The key id of the account, obtainable from the account table.
given_names - string
The given names of the visa holder.
family_name - string
The family name of the visa holder.
date_of_birth - string (Format: "YYYY-MM-DD")
The date of birth of the visa holder.
email – string
The email address of the visa holder.
employee_id – string
The employee code from an external system such as HRIS, Payroll or Rostering
location – string
An identifier for which venue/location etc the employee might work
group – string
Another identifier for grouping employees. Could be used for Role or Department etc