KYC forms for private companies (AUS)

Use this API call to generate KYC forms for private companies.

Parameters

NameTypeDescription
country
(required)
string3 letter country ISO
type
(required)
string"privateCompany"
abn
string
acn
string
name
string
registeredOffice
stringaddress
principalPlaceOfBusiness
stringaddress

Stakeholder types

NameTypeNote
shareholders
individual
directors
individual

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.

Response format

{ "source": "bronid", "bronLink": "https://preview.bronid.com/idForm/5ae132d1-a4f6-4e72-adf4-92aa4faa39a3", "verificationUuid": "5ae132d1-a4f6-4e72-adf4-92aa4faa39a3", "status": "success" }

Restrictions

  • URL is accessible for a 31 days after generation (reduced prefilled data after 30 minutes)
  • URL can be opened maximum 10 times without being saved
  • 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": "privateCompany", "fields": { "country": "AUS", "abn": "123456789", "acn": "16123456789", "name": "Pass My Company", "registeredOffice": "125 York Street", "principalPlaceOfBusiness": "250 York Street" }, // stakeholder details "stakeholders": [ { "type": "individual", "role": "shareholders", "fields": { "firstName": "Jane", "middleName": "ok", "lastName": "Citizen", "gender": "female", "dateOfBirth": "11/10/1980", "address": "125 York st", "email": "email@gmail.com", "country": "AUS" } }, { "type": "individual", "role": "directors", "fields": { "firstName": "Dave", "middleName": "ok", "lastName": "Citizen", "gender": "male", "dateOfBirth": "20/10/1980", "address": "125 Pitt st", "email": "email@gmail.com", "country": "AUS" } } ] }; // 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.