KYC verification of individuals (NZL)

Use this API call to perform KYC verification of individuals.

Parameters

Name	Type	Description
`country` (required)	string	NZL
`firstName` (required)	string - letters, apostrophes, spaces, hyphens	Less than 80 characters
`middleName` (required, if present)	string - letters, apostrophes, spaces, hyphens	Less than 80 characters
`lastName` (required)	string - letters, apostrophes, spaces, hyphens	Less than 80 characters
`dateOfBirth` (required)	string	DD/MM/YYYY
`unitNumber` (required, if present)	string or null*
`streetNumber` (required)	string
`streetName` (required)	string
`streetType` (required, if present)	string or null*	Street types
`suburb` (required)	string	New Zealand suburb name
`postcode` (required)	string	4 digits
`gender`	string	male/female/other/preferNotToSay
`email`	string

ID documents

Submitting ID documents is optional. You can use ID documents as a verification source to improve the likelihood of a successful verification.

Driver licence

Name	Type	Description
`driversLicenceNumber` (required, if submitting)	string	2 letters followed by 6 digits
`driversLicenceVersionNumber` (required, if submitting)	string	3 alphanumeric characters
`driversLicenceImageFront`	string	base64 Data URI (JPG/PNG/PDF)
`driversLicenceImageBack`	string	base64 Data URI (JPG/PNG/PDF)

Passport

Name	Type	Description
`passportNumber` (required, if submitting)	string	1 or 2 letters followed by 6 digits
`passportCountryOfIssue` (required, if submitting)	string	NZL
`passportDocumentExpiry` (required, if submitting)	string	DD/MM/YYYY
`passportImage`	string	base64 Data URI (JPG/PNG/PDF)

Note on NZL passports

Passports submitted for NZL individuals must have been issued by New Zealand.

Note on uploading documents

Base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format: "data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i..."

Runnable example

const apiEndpoint = 'https://dev.bronid.com/verify';

// request body
const kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_userId": "yourUniqueUserId",
	
	"type": "individual",
	"fields": {
	"country": "NZL",
		"firstName": "Jane",
		"middleName": "ok",
		"lastName": "Citizen",
		"dateOfBirth": "20/10/1982",
		"unitNumber": "1",
		"streetNumber": "20",
		"streetName": "Karamu",
		"streetType": "Street",
		"suburb": "Taupo",
		"postcode": "3330",
		"email": "email@gmail.com"
	}
};

console.log('Running request. Please wait...')

// submit the KYC data to the bronID API
try {
	const response = await fetch(apiEndpoint, {
		method: 'POST',
		headers: {
			'Content-Type': 'application/json',
		},
		body: JSON.stringify(kycData),
	});

	if (!response.ok) {
		const errorData = await response.json();
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(errorData, null, 2));
	} else {
		const bronIdResult = await response.json();
		const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
		console.log(printResult);
	}
} catch (error) {
	console.log('Fetch error: ', error);
}

	
// Click “▶ run” to try this code live and run your first KYC.