KYC with flat structure (AUS)

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

Webhook responses for stakeholders (sub-verifications)

When the entity contains stakeholders, webhooks are also sent for each stakeholder in the verification. In the example bellow, aside from the target entity webhook, you will also receive two webhooks for each (sub-verification) of the stakeholders, for a total of 3 webhooks. You can see that those webhooks are sub-verification because they will contain a parentVerificationUuid parameter, which will be equal to the verificationUuid of the main (target) verification. In most cases it is safe to ignore these webhooks. The successful verification status of stakeholders does not mean a successful target entity verification.

For details regarding the webhooks of the target entity itself, you can go here.

Runnable example

// api endpoint const apiEndpoint = ''; // request body const kycData = { "metadata_version": "4", "metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2", "metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314", "metadata_userId": "yourUniqueUserId", "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": "", "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": "", "country": "AUS" } } ] }; console.log('Running request...') // submit the KYC data to the bronID API const bronIdResult = await axios .post(apiEndpoint, kycData) .then(res => { return; }) .catch(error => { console.log('error! click the results to expand them'); console.log(JSON.stringify(, null, 2)); }) const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2); // Click “▶ run” to try this code live and run your first KYC.