vSure Visa Checks API v2

The following test cases are available within the nzl:sandbox scope.

NOTE: data must match the NZ Immigration database exactly to return a verfiy a visa.

The "Employer" CheckType requires exact match of:

• Family Name
• Passport Country
• Passport Number

Date of birth is not part of the cross match for NZ employer checks (does not have to be accurate), but is required for ALL vSure visa check types and must be YYYY-MM-DD format. Given Name is not part of the cross match either, but parameter must be present (though can be blank).

The Employment Start Date must not be in the past or more than 2 weeks in the future.

The request JSON preceding the new_zealand specific array will be consistent:

{
    "jurisdiction": "NZL",
    "environment": "sandbox",
    "mode": "fastcheck",
    "customer_authority_id": "{{recently_created_ca_id}}",
    "visa_check_schema": "new_zealand",

Passport Details

The following passports and visa approval letter details cover the various scenarios associated with visa checks for New Zealand:

Successful - YES, is entitled to work

    "new_zealand": {
		"visa_check_type": "employer",
        "employment_start_date": "2024-08-04"
    },
    "document": {
        "type": "passport",
        "identifier": "10987654",
        "country": "FJI",
        "family_name": "Ravalawa",
        "given_name": "Mikaele",
        "date_of_birth": "1997-11-09"				
    }
}

Successful - Student - YES, is entitled to work with 25 hours limitation

    "new_zealand": {
		"visa_check_type": "employer",
        "employment_start_date": "2024-08-04"
    },
    "document": {
        "type": "passport",
        "identifier": "N0123456",
        "country": "KHM",
        "family_name": "Mam",
        "given_name": "Somaly",
        "date_of_birth": "1999-11-30"
    }
}

Successful - No Given Name on Passport - YES, is entitled to work with limitations

    "new_zealand": {
		"visa_check_type": "employer",
        "employment_start_date": "2025-07-04"
    },
    "document": {
        "type": "passport",
        "identifier": "W9123456",
        "country": "IND",
				"given_name": "",
        "family_name": "Sania Mirza",
        "date_of_birth": "1986-09-15"
    }
}

Successful - Permanent Resident Visa - YES, is entitled to work

    "new_zealand": {
		"visa_check_type": "employer",
        "employment_start_date": "2024-08-04"
    },
    "document": {
        "type": "passport",
        "identifier": "P8011111B",
        "country": "PHL",
				"given_name": "Anne",
        "family_name": "Curtis",
				"date_of_birth": "1985-02-17"
    }
}

Error with Client Authority - RealMe credentials not valid

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212126",
        "country": "AUS",
        "family_name": "Bradman",
        "given_name": "Donald",
        "date_of_birth": "1908-08-27"
    }
}

Error - visa cannot be verified

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212127",
        "country": "DEU",
        "family_name": "Merkel",
        "given_name": "Angela",
        "date_of_birth": "1954-07-17"
    }

Successful - Resident - YES, is entitled to work

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212121",
        "country": "PHL",
        "family_name": "Chui",
        "given_name": "Kim",
        "date_of_birth": "1990-04-19"
    }
		

Successful - YES, is entitled to work

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212122",
        "country": "LKA",
        "family_name": "Jayasuriya",
        "given_name": "Sanath",
        "date_of_birth": "1969-06-30"
    }	

Successful - YES, is entitled to work

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212123",
        "country": "IND",
        "family_name": "Kohli",
        "given_name": "Virat",
        "date_of_birth": "1988-11-05"
    }

Successful - YES, is entitled to work

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212124",
        "country": "NPL",
        "family_name": "Norgay",
        "given_name": "Tenzing",
        "date_of_birth": "1986-09-05"
    }
}

Successful - Student YES, is entitled to work max 20 hours

    "new_zealand": {
				"visa_check_type": "employer"
    },
		"document": {
        "type": "passport",
        "identifier": "V1212128",
        "country": "CHN",
        "family_name": "Bingbing",
        "given_name": "Fan ",
        "date_of_birth": "1981-09-16"
    }

Successful - Resident

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "P3456789A",
        "country": "PHL",
        "family_name": "Pacquiao",
        "given_name": "Emmanuel",
        "date_of_birth": "1978-12-31"
    }

Successful - REFER to Immigration Contact Centre

    "new_zealand": {
				"visa_check_type": "employer"
    },
    "document": {
        "type": "passport",
        "identifier": "V1212129",
        "country": "IND",
        "family_name": "Khan",
        "given_name": "Shah Rukh",
        "date_of_birth": "1965-11-02"
    }
		```