KYC verification for 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
`streetNumber` (required)	string
`streetName` (required)	string
`streetType` (required)	string	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 document (JPG/PNG/PDF)
`driversLicenceImageBack`	string	base64 document (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 document (JPG/PNG/PDF)

Runnable example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// api endpoint
const apiEndpoint = 'https://sandbox.bronid.com/verify';

// request body
const kycData = {
	// authorization
	"metadata_version": "4",
	"metadata_serviceUid": "RnbEhVfoQsec7mzehN4xgNA9uoi2",
	"metadata_secretKey": "dev_secret_key",
	"metadata_userId": "yourUniqueUserId",
	
	// individual details
	"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.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.