KYC verification of individuals (NZL)

Use this API call to perform KYC verification of individuals.

Parameters

Name	Type	Description
`country` (required)	string	3 letter country ISO
`firstName` (required)	string - letters only
`middleName` (required, if present)	string - letters only
`lastName` (required)	string - letters only
`gender` (required)	string	male/female
`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
`postcode` (required)	string
`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
`driversLicenceVersionNumber` (required, if submitting)	string	3 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	Including any letters
`passportCountryOfIssue` (required, if submitting)	string	3 letter country ISO
`passportDocumentExpiry` (required, if submitting)	string	DD/MM/YYYY
`passportImage`	string	base64 Data URI (JPG/PNG/PDF)

Note

Base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:

data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...

Runnable example


// api endpoint
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",
		"gender": "female",
		"dateOfBirth": "20/10/1982",
		"unitNumber": "1",
		"streetNumber": "20",
		"streetName": "Karamu",
		"streetType": "Street",
		"suburb": "Taupo",
		"postcode": "3330",
		"email": "email@gmail.com"
	}
};

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

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.