The vSure API provides a simple REST Web Services API for interacting with the New Zealand Immigration system. vSure client can use this API to request to and get New Zealand visa check information.
All API access is over HTTPS, and accessed via the https://api.vsure.com.au/nz. The vSure API uses JSON, so that it can be used from many languages and platforms.
1.2 Requirements for logging Visa Checks
The New Zealand government has requested that vSure log Visa Checks against the company performing the check (preferably to logging vSure as the company performing the check).
NOTE: VisaView also allows registered employers to confirm New Zealand passport information provided by a New Zealand citizen candidate. You will need to complete and return the "VisaView Employer Disclosure Agreement" to the Department of Internal Affairs.
1.3 Using vSure API
The vSure API is accessible at https://api.vsure.com.au/nz
You must include the API key provided by vSure Admin as part of the request parameter. These keys are locked to nominated IP address(es) or ranges. Once an API key has been created, vSure will use this API key to authenticate the API connections.
If you already have an API key for Australian visa checks, it will also work for this endpoint.
All functions sent and data received are using the following URL:
2.1 vSure NZ Visa Checks request parameters
Your system will need to send a POST or GET request to our URL:
The format of the request is as follows:
$_REQUEST['key'] = "XXXXXXXXXXXXXXX";
$_REQUEST['username'] = "XXXXXXXXXXXXXXX";
$_REQUEST['password'] = "XXXXXXXXXXXXXXX";
$_REQUEST['family_name'] = "Smith";
$_REQUEST['date_of_birth'] = "DD MMM YYYY";
$_REQUEST['nationality'] = "XXX";
$_REQUEST['passport_id'] = "XXXXXXXXX";
$_REQUEST['gender'] = "X";
$_REQUEST['visa_start_date'] = "DD MMM YYYY";
The following is the details of the request data:
key - string
The vSure API key we provided to you
username - string
Your NZ RealMe username. Case-insensitive.
password - string
Your NZ RealMe password.
If no username and password are supplied, the system will use vSure account to run the visa check.
family_name - string
The family names of the visa holder. Case-insensitive.
date_of_birth – string (Format: "DD MMM YYYY")
The birth date of the visa holder. Case-insensitive.
nationality – string
The name of the country listed in the passport. Case-insensitive.
Please refer to 3. Reference section below for the country list.
passport_id - string
The passport ID of the visa holder.
gender - string ("M" or "F")
The gender of the visa holder. Case-insensitive.
visa_start_date – string (Format: "DD MMM YYYY")
The visa start date of the visa holder. Case-insensitive.
2.2 NZ Check Response Parameters
The following is the sample response data:
"time_of_check":"23 Feb, 2018 16:48:36",
"date_of_birth":"DD MMM YYYY",
"visa_start_date":"DD MMM YYYY",
"first_entry_before":"DD MMM YYYY",
"expiry_date_travel":"DD MMM YYYY",
The following is the details of the response data:
time_of_check - string
The time when the check is done.
output - array
The array that contains the result data. Returns empty if error.
person - array
The array that contains the person details data.
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: "DD MMM YYYY")
The date of birth of the visa holder.
gender – string ("M" or "F")
The gender 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.
visa - array
The array that contains the visa details data.
visa_type - string
The type of the visa.
visa_start_date - string (Format: "DD MMM YYYY")
The start date of the visa.
visa_expiry - string (Format: "DD MMM YYYY")
The expiry date of the visa.
Returns empty if Indefinite.
first_entry_before - string (Format: "DD MMM YYYY")
The required date for the visa holder to make an entry to New Zealand or the visa will be invalid.
number_of_entries - string
The number of entries to New Zealand.
Returns "Single" or "Multiple".
expiry_date_travel - string (Format: "DD MMM YYYY")
The required date for the visa holder to re-enter New Zealand.
Returns empty if not applicable.
visa_conditions - string
The visa conditions of the visa.
inz_client_number - string
The immigration New Zealand client number.
token - string
The token id of this check, used to retrieve the security licence check result data.
status - string
The status of the check.
error_code - string
The error code of the error message.
error - string
The error message
A web-page front-end has been developed for testing the NZ API and is available for your account upon request:
4.1 Country List
Bosnia & Herzegovina
Central African Republic
Democratic Republic of Congo
Federated States of Micronesia
Guinea - Bissau
Kosovo - Republic of
Kosovo - UN Mission in
Northern Mariana Islands
Papua New Guinea
Sao Tome & Principe
Serbia & Montenegro
South Pacific commission
St Kitts - Nevis
St Vincent and the Grenadines
Trinidad and Tobago
United Arab Emirates
United States of America
You will be billed for the number of visa checks done monthly.
You will not be billed for visa checks where there is a failed check.