KYC verification of regulated trusts (AUS)

This page contains only params relevant for the specific example. For a complete list of params for this API call visit this page.

API response vs Webhook response

Processing of the entity verifications is asynchronous. This means that when you submit an entity through the API, in most cases you will receive a default "pending" response to the call itself. When the verification status changes (e.g. to "verified"), you will receive a verification status update webhook. The final verification response time can range from a few seconds up to 48 hours depending on 3rd party register access and availability.

Note: Aside from the API response, you will also receive a "pending" webhook at the moment you submit the entity. Because of this behaviour, in most cases you can use the API response as an "error/validation indicator", ignore the non-error API responses and rely on the webhooks for status updates.

Test values

In the test environment, you can trigger (fake) a successful verification if the name of the entity you are trying to verify starts with "Pass". You can find all test values here.

Runnable example

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

// request body
const kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	
	"type": "regulatedTrust",
	"fields": {
		"country": "AUS",
		"abn": "16123456789",
		"name": "Pass My Regulated Trust",
		"regulatedTrustType": "governmentSuperannuationFund"
	}
};

console.log('Running request...')

// submit the KYC data to the bronID API
try {
	const response = await fetch(apiEndpoint, {
		method: 'POST',
		headers: {
			'Content-Type': 'application/json',
		},
		body: JSON.stringify(kycData),
	});

	if (!response.ok) {
		const errorData = await response.json();
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(errorData, null, 2));
	} else {
		const bronIdResult = await response.json();
		const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
		console.log(printResult);
	}
} catch (error) {
	console.log('Fetch error: ', error);
}

	
// Click “▶ run” to try this code live and run your first KYC.