KYC verification for private companies (NZL)

Use this API call to perform KYC verification of private companies.

Parameters

NameTypeDescription
country (required)string3 letter country ISO
name (required)string
nzbn (required)string
registeredOfficestringaddress
principalPlaceOfBusinessstringaddress
companyExtractstringbase64 document (JPG/PNG/PDF)
stakeholdersarrayshareholders / directors

Parameters only when verifying from Australia

NameTypeDescription
ARBNstring
registeredInAusOfficeAddressstringaddress
principalPlaceInAusAddressstringaddress

Stakeholder types

NameTypeNote
shareholdersindividual
directorsindividual

Runnable example

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

// request body
const kycData = {
	// authorization
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "dev_secret_key",
	"metadata_userId": "yourUniqueUserId",
	
	// entity details
	"type": "privateCompany",
	"fields": {
		"country": "NZL",
		"name": "My Company",
		"nzbn": "123456789",
		"registeredOffice": "1/20 Karamu Street, Taupo 3330",
		"principalPlaceOfBusiness": "2/40 Karamu Street, Taupo 3330",
		"companyExtract": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
	},
	"stakeholders": [
		{
			"type": "individual",
			"role": "shareholders",
			"fields": {
				"firstName": "Jane",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "female",
				"dateOfBirth": "20/12/1982",
				"unitNumber": "1",
				"streetNumber": "20",
				"streetName": "Karamu",
				"streetType": "Street",
				"suburb": "Taupo",
				"postcode": "3330",
				"email": "email@gmail.com",
				"country": "NZL"
			}
		},
		{
			"type": "individual",
			"role": "directors",
			"fields": {
				"firstName": "Dave",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "male",
				"dateOfBirth": "20/12/1982",
				"unitNumber": "1",
				"streetNumber": "20",
				"streetName": "Karamu",
				"streetType": "Street",
				"suburb": "Taupo",
				"postcode": "3330",
				"email": "email@gmail.com",
				"country": "NZL"
			}
		}
	]
};

// 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.