KYC forms for regulated trusts (AUS)
Use this API call to generate KYC forms for regulated trusts.
Parameters
| Name | Type | Description |
|---|---|---|
country (required) | string | 3 letter country ISO |
type (required) | string | "regulatedTrust" |
name | string | |
abn | string | 11 digits |
regulatedTrustType | string | asic / mis / regulatedUnderCommonwealthStatutoryRegulator / governmentSuperannuationFund |
registeredOffice | string | address |
businessNameTrustee | string | |
uploadTrustDeed | string | base64 Data URI (JPG/PNG/PDF) |
stakeholders | array | trustee |
regulatedTrustTypes options
| Option | Description |
|---|---|
asic | Registered Managed Investment Scheme |
mis | Unregistered Managed Investment Scheme |
regulatedUnderCommonwealthStatutoryRegulator | Regulated under a Commonwealth statutory regulator |
governmentSuperannuationFund | Government Superannuation Fund |
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
Tags
You can add tags to your verification requests to help you organise your verifications by using the metadata_tags parameter. Read more about tags here.
Note on uploading documents: base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:
data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...
Runnable example
POST
/idform// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';
// request body
const data = {
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
"metadata_version": "4",
"metadata_userId": "yourUniqueUserId",
"bronLink_dataAccessType": "idForm",
"type": "regulatedTrust",
"fields": {
"country": "AUS",
"name": "Pass My Trust",
"abn": "16123456789",
"regulatedTrustType": "asic",
"registeredOffice": "125 York Street, SYDNEY NSW 2000",
"businessNameTrustee": "Trustee business name",
"uploadTrustDeed": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
},
"stakeholders": [
{
"type": "privateCompany",
"role": "trustee",
"fields": {
"country": "AUS",
"abn": "16123456789",
"acn": "123456789",
"name": "Pass my stakeholder",
"registeredOffice": "125 York Street, SYDNEY NSW 2000",
"principalPlaceOfBusiness": "250 York Street, SYDNEY NSW 2000",
"companyExtract": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
}
}
]
};
try {
const response = await fetch(apiEndpoint, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(data),
});
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 result = await response.json();
const printResult = 'bronId API response: ' + JSON.stringify(result, null, 2);
console.log(printResult);
}
} catch (error) {
console.log('Fetch error: ', error);
}