Distributor KYC API

Use this API call to perform KYC verification on behalf of your customers.

This API has the same format as the regular KYC API, but it includes one extra parameter (

metadata_onBehalf
) which is the UserId value of your onBehalf customer. Verifications submitted with this parameter will also be visible to your customers through their portal account.

You can additionally use the

metadata_tags
param if you want to group the verifications.

The onBehalf and tags parameters can be used for filtering the verification and billing history.

Parameters

NameTypeDescription
metadata_onBehalf
(required)		stringthe UserId of your customer
metadata_tags
string arraygrouping tags

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_onBehalf": "your_customers_user_id",
	"metadata_tags": ["tag1", "tag2"],
	
	"type": "individual",
	"fields": {
		"country": "AUS",
		"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"
	}
};

// 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.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})
	
// Click “▶ run” to try this code live and run your first KYC.