KYC forms for unregulated trusts (AUS)

Use this API call to generate KYC forms for unregulated trusts.

Parameters

NameTypeDescription
country
(required)		string3 letter country ISO
type
(required)		string"unRegulatedTrust"
name
string
abn
string
registeredOffice
stringaddress
unRegulatedTrustType
stringfamilyTrust / charitableTrust / testamentaryTrust / unitTrust / otherType
uploadTrustDeed
stringbase64 Data URI (JPG/PNG/PDF)
stakeholders
arraybeneficiaries / trustee / settlors

unRegulatedTrustType options

OptionDescription
familyTrust
Family Trust
charitableTrust
Charitable Trust
testamentaryTrust
Testamentary Trust
unitTrust
Unit Trust
otherType
Other Type

Stakeholder types

NameTypeNote
beneficiaries
individual
trustee
(required)		individual, private company, public company, government body
settlors
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": "unRegulatedTrust",
	"fields": {
		"country": "AUS",
		"name": "Pass My Trust",
		"unRegulatedTrustType": "unitTrust",
		"abn": "16123456789",
        "registeredOffice": "125 York Street, SYDNEY NSW 2000",
		"uploadTrustDeed": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
	},
    "stakeholders": [
		{
			"type": "individual",
			"role": "beneficiaries",
			"fields": {
				"country": "AUS",
				"firstName": "Jane",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "female",
				"dateOfBirth": "11/10/1980",
				"address": "125 York st",
				"email": "email@gmail.com",
				"medicareCardColour": "green",
				"medicareCardNumber": 2428778132,
				"medicareIndividualReferenceNumber": 1,
				"medicareNameOnCard": "Jane Citizen",
				"medicareExpiryDate": "12/2030",
				"medicareImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
			}
		},
		{
			"type": "individual",
			"role": "settlors",
			"fields": {
				"country": "AUS",
				"firstName": "Dave",
				"middleName": "ok",
				"lastName": "Citizen",
				"gender": "male",
				"dateOfBirth": "20/10/1980",
				"address": "125 Pitt st",
				"email": "email@gmail.com",
				"driversLicenceNumber": "11111111",
				"driversLicenceCardNumber": "1234567890",
				"driversLicenceState": "NSW",
				"driversLicenceImageFront": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
				"driversLicenceImageBack": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
				"passportNumber": "A1111111",
				"passportCountryOfIssue": "AUS",
				"passportImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
			}
		},
		{
			"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=="
			}
		}
	]
};

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

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.