KYC verification of partnerships (AUS)

Use this API call to perform KYC verification of partnerships.

Parameters

NameTypeDescription
country
(required)		string3 letter country ISO
name
(required)		string
abnRequired
(required)		string
principalPlaceOfBusinessRequired
(required)		stringaddress
partnershipAgreement
(required)		stringbase64 Data URI (JPG/PNG/PDF)
stakeholders
(required)		arraypartners (*)

Stakeholder types

NameTypeNote
partners
individual

Note

Base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:

data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...

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.

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": "partnership",
	"fields": {
		"country": "AUS",
		"name": "My Partnership",
		"abnRequired": "123456789",
		"principalPlaceOfBusinessRequired": "125 York Street, SYDNEY NSW 2000",
		"partnershipAgreement": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
	},
	"stakeholders": [
		{
			"type": "individual",
			"role": "partners",
			"fields": {
				"firstName": "Jane",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "female",
				"dateOfBirth": "20/12/1982",
				"unitNumber": "1",
				"streetNumber": "95",
				"streetName": "Lennox",
				"streetType": "Street",
				"suburb": "CASINO",
				"postcode": "2470",
				"state": "NSW",
				"email": "email@gmail.com",
				"country": "AUS"
			}
		},
		{
			"type": "individual",
			"role": "partners",
			"fields": {
				"firstName": "Dave",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "male",
				"dateOfBirth": "20/12/1982",
				"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.