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"
abnstring
acnstring
namestring
registeredOfficestringaddress
principalPlaceOfBusinessstringaddress

Stakeholder types

NameTypeNote
shareholdersindividual
directorsindividual

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

1
2
3
4
5
6
{
    "source": "bronid",
    "bronLink": "https://preview.bronid.com/idForm/5af132d1-a456-4e72-adf4-92aa4fsp39a3",
    "verificationUuid": "5af132d1-a456-4e72-adf4-92aa4fsp39a3",
    "status": "success"
}

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';

// request body
const kycData = {
	// authorization
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "dev_secret_key",
	"metadata_version": "4",
	
	"bronLink_dataAccessType": "idForm",
	
	// entity details
	"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.error(error)
	})
	
// Click “▶ run” to try this code live and run your first KYC.