KYC verification of private companies (AUS)

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

Parameters

NameTypeDescription
country
(required)		string3 letter country ISO
acn
(required)		string
abn
string
name
(required)		string
registeredOffice
stringaddress
principalPlaceOfBusiness
stringaddress
companyExtract
stringbase64 Data URI (JPG/PNG/PDF)
stakeholders
arrayshareholders / directors

Stakeholder types

NameTypeNote
shareholders
individual
directors
individual

Tags

You can add tags to your verification requests to help you organise your verifications by using the

metadata_tags
parameter. Read more about tags here.

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",
	"metadata_tags": ["product1", "client1"],
	
	"type": "privateCompany",
	"fields": {
		"country": "AUS",
		"acn": "123456789",
		"abn": "16123456789",
		"name": "My Company",
		"registeredOffice": "125 York Street, SYDNEY NSW 2000",
		"principalPlaceOfBusiness": "250 York Street, SYDNEY NSW 2000",
		"companyExtract": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
	},
	"stakeholders": [
		{
			"type": "individual",
			"role": "shareholders",
			"fields": {
				"firstName": "Jane",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "female",
				"dateOfBirth": "20/10/1980",
				"unitNumber": "1",
				"streetNumber": "95",
				"streetName": "Lennox",
				"streetType": "Street",
				"suburb": "CASINO",
				"postcode": "2470",
				"state": "NSW",
				"email": "email@gmail.com",
				"country": "AUS"
			}
		},
			{
			"type": "individual",
			"role": "directors",
			"fields": {
				"firstName": "Dave",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "male",
				"dateOfBirth": "20/10/1980",
				"unitNumber": "1",
				"streetNumber": "95",
				"streetName": "Lennox",
				"streetType": "Street",
				"suburb": "CASINO",
				"postcode": "2470",
				"state": "NSW",
				"email": "email@gmail.com",
				"country": "AUS"
			}
		}
	]
};

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.