KYC forms for public companies (AUS)

In this example, we are going to generate a form for verification of a public company without stakeholders. If there is any incorrect information, the customer can correct the structure when the open the form.

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

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.

Response

The response of the forms API contains the bronLink parameter. You can share this link with you customers via email, SMS or redirect them to the link from your app. The information you have submitted will be prefilled for them on the form. After they complete the verification you will receive a webhook with the verification status.

Restrictions

  • URL is only accessible for a limited time (30 minutes) after generation
  • URL can only be opened 3 times
  • URL can be used for a maximum of 5 verification attempts

Runnable example

// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';

// request body
const kycData = {
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_version": "4",
	"metadata_userId": "yourUniqueUserId",
	
	"bronLink_dataAccessType": "idForm",
		
	"type": "publicCompany",
	"fields": {
		"country": "AUS",
		"name": "Pass My Company",
		"abn": "123456789",
		"acn": "16123456789",
		"ticker": "TCK",
		"exchangeListedOn": "InternationalExchange"
	}
};

// 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.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.