KYC verification for individuals (NZL)

Use this API call to perform KYC verification of individuals.

Parameters

NameTypeDescription
country
(required)		string3 letter country ISO
firstName
(required)		string - letters only
middleName
(required, if present)		string - letters only
lastName
(required)		string - letters only
gender
(required)		stringmale/female
dateOfBirth
(required)		stringDD/MM/YYYY
unitNumber
(required, if present)		string
streetNumber
(required)		string
streetName
(required)		string
streetType
(required)		stringStreet 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

NameTypeDescription
driversLicenceNumber
(required, if submitting)		string
driversLicenceVersionNumber
(required, if submitting)		string3 characters
driversLicenceImageFront
stringbase64 document (JPG/PNG/PDF)
driversLicenceImageBack
stringbase64 document (JPG/PNG/PDF)

Passport

NameTypeDescription
passportNumber
(required, if submitting)		stringIncluding any letters
passportCountryOfIssue
(required, if submitting)		string3 letter country ISO
passportDocumentExpiry
(required, if submitting)		stringDD/MM/YYYY
passportImage
stringbase64 document (JPG/PNG/PDF)

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"
	}
};

// submit the KYC data to the bronID API
axios
	.post(apiEndpoint, kycData)
	.then(res => {
		// print the verification results
		console.log('click the results to expand them');
		console.log(JSON.stringify(res.data, null, 2));
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})
	
// Click “▶ run” to try this code live and run your first KYC.