Work Rights Checks
Your system will need to send a POST or GET request to our URL: https://api.vsure.com.au/v1/visacheck
The format of the request is as follows (JSON):
Source view:
type=json&json=
{
"key":"XXXXXXXXXXXXXXX",
"visachecktype":"work",
"document_type":"xxxxxxxx",
"visaholder":{
"given_names":"John",
"family_name":"Smith",
"date_of_birth":"1980-01-01",
"passport_id":"P12345678",
"country":"New Zealand",
},
}
Parsed view:
type=json&json={"key":"XXXXXXXXXXXXXXX","visaholder":{"given_names":"John","family_name":"Smith","date_of_birth":"1980-01-01","passport_id":"P12345678","country":"New Zealand"}}
The following is the details of the request data:
key - string The vSure API key we provided to you
document_type – string (optional) The travel document type used to do the visa check Options: “passport” (default), “immicard”
visachecktype – string (optional) The visa check type. If this attribute is not set or empty, the system will set “work” as default
given_names - string The first names of the visa holder
family_name - string The last name of the visa holder
date_of_birth – string (Format: "YYYY-MM-DD", "DD MMMM YYYY", "DD/MM/YYYY") The birth date of the visa holder
passport_id - string The passport ID of the visa holder
country - string The name of the country listed in the passport
The following is the sample response data (JSON):
{
"output":{
"id":"XXXXX",
"Time of Check":"Tuesday February 23, 2016 16:48:36 (EST) Canberra, Australia (GMT +1100)",
"Person Checked":{
"Name":"John Smith",
"DOB":"DD MMMM YYYY",
"Passport ID":"XXXXXXXXX",
"Nationality":"XXXXX",
"VEVO_givennames":"John",
"VEVO_familyname":"Smith"
},
"status":"",
"result":"OK",
"Visa Details":{
"Visa Details":"Primary",
"Visa Class":XX,
"Visa Type":573,
"Visa Type Name":"Higher Education Sector",
"Grant Date":"DD MMMM YYYY",
"Expiry Date":"DD MMMM YYYY",
"Visa Type Details":"XXXXXXXXXXX"
},
"Work Entitlement":"The visa holder has unlimited right to work in Australia.",
"Visa Conditions":"8501,8502",
"conditions":"XXXXX",
"haspdf":1,
"token":"XXXXXXXXXXXXXXX",
"location":"XXXXXXXXXXXXXXX"
},
"error":""
}
The following is the details of the response data:
output: array The array that contains the result data. Returns null if there is error.
id - integer The visa check id
Time of Check - string The time of the visa check
**Person Checked **- json A json containing the details of the visa holder
Name - string The name of the visa holder
DOB - string (Format: "DD MMMM YYYY") The date of birth of the visa holder
Passport ID - string The passport ID of the visa holder
Nationality - string The name of the country listed in the passport
VEVO_givenname - string The given name of the visa holder returned by VEVO or null if no given name is returned by VEVO
VEVO_familyname - string The family name of the visa holder returned by VEVO or null if no family name is returned by VEVO
status - string
This is the visa check error status. It returns one of the following possible values:
(empty string) This means that VEVO can identify the person, with the following possible visa status: - Has a visa with work rights - Has a visa with no or restricted work rights
No visa – The Department is able to identify the person, however the person has no visa.
Check DOB and passport data – The Department has not been able to identify the person. This means that the person was not found in the Department of Home Affairs records. This would mean either: - The passport details were entered incorrectly, or - The person has not used this passport to enter Australia or apply for a visa, or - The person has not updated the passport details with Immigration.
VEVO unavailable - Your query cannot be processed as VEVO has encountered an error. This is produced for any visa check done during VEVO web maintenance.
VEVO Login Error - This means that you supply an incorrect VEVO username and password
VEVO Password Reset required - This means that VEVO requests to reset the VEVO password, which happens periodically around once in 3 months.
VEVO is unavailable - This means that the VEVO system is currently unavailable.
VEVO requires you to accept Terms and Conditions - This means that the VEVO requires your VEVO account to accept the new VEVO Terms and Conditions to use their system. Log manually into the VEVO system to accept the terms of usage with Home Affairs.
result - string The visa check result whether it has error or not. Returns either "OK" or "Error"
"OK" means that VEVO can identify the person, with the following possible visa status: - No visa - Has a visa with work rights - Has a visa with no or restricted work rights
"Error" means that the visa check cannot be done, which might be caused by: - VEVO is unable to identify the person (which might be caused by typo) - VEVO Login Error (Incorrect VEVO username and password) - VEVO Password Reset required - VEVO is unavailable (VEVO website is down) - VEVO requires you to accept Terms and Conditions
Visa Details - json
A json containing the active visa details of the visa holder
Visa Applicant – string
The visa applicant type of the visa holder
Returns “Primary” or “Secondary”
Visa Class – string (Format: XX)
The visa class of the visa
Visa Type - integer
The visa type id of the visa holder
Visa Type Name - string
The visa type name of the visa holder
Grant Date - string (Format: "DD MMMM YYYY")
The date when the visa is granted.
Expiry Date - string (Format: "DD MMMM YYYY")
The date when the visa will expire.
Visa Type Details - string
The visa type information
Work Entitlement - string
The work entitlement details of the visa
Visa Conditions - integer, separated by comma
The visa condition ids of the current visa
conditions - string
The visa condition details
haspdf – boolean
This indicates if there is a pdf version of the visa check result.
Returns 1 if there is a pdf version or 0 otherwise.
token - string
The token used to get the PDF file of the visa check result
location - string
The current location of the visa holder. It returns one of the following possible values:
Onshore This means that the person is in Australia
Offshore This means that the person is not in Australia
Error: string
If there is an error with the API process, this will display the error message. Returns empty string if there is no error.
2.4 getdata
Your system will need to send a POST or GET request to our URL: https://api.vsure.com.au/v1/getdata
The format of the request is as follows (PHP):
$_REQUEST['key'] = "XXXXXXXXXXXXXXX"; $_REQUEST['token'] = "XXXXXXXXXXXXXXX"; $_REQUEST['type'] = "pdf";
The following is the details of the request data:
key - string The vSure key we provided to you
token - string The token used to get the PDF file of the visa check result
type - string The type of the requested data
The response data will be the content of the requested pdf file. Your system might need to handle the content.
For instance, to display the PDF in the browser for a PHP system:
header("Content-Disposition:attachment;filename='visacheckresult.pdf'"); echo $pdfcontentresult;