KYC verification of private companies (NZL)

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

Parameters

Name	Type	Description
`country` (required)	string	3 letter country ISO
`name` (required)	string
`nzbn` (required)	string
`registeredOffice`	string	address
`principalPlaceOfBusiness`	string	address
`companyExtract`	string	base64 Data URI (JPG/PNG/PDF)
`stakeholders`	array	shareholders / directors

Parameters only when verifying from Australia

Name	Type	Description
`ARBN`	string
`registeredInAusOfficeAddress`	string	address
`principalPlaceInAusAddress`	string	address

Stakeholder types

Name	Type	Note
`shareholders`	individual
`directors`	individual

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

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.