KYC forms for individuals (AUS)

Use this API call to generate KYC forms for individuals.

NOTE: We are upgrading this API. Please contact us for details.

Parameters

Name	Type	Description
`country` (required)	string	3 letter country ISO
`entityType` (required)	string	"individual"
`firstName`	string - letters only
`middleName`	string - letters only
`lastName`	string - letters only
`gender`	string	male/female
`dateOfBirth`	string	DD/MM/YYYY
`address`	string

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 the complete the verification you will receive a webhook with the verification status.

Response format

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

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
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/idform';

// request body
const kycData = {
	// authorization
    "metadata": {
        "serviceUuid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
        "secretKey": "dev_secret_key",
        "version": "1"
    },
    "bronLink": {
        "dataAccessType": "idForm",
        "dataAccessFields": [
            { "fieldType": "country", "value": "AUS" },
            { "fieldType": "entityType", "value": "individual" },
            { "fieldType": "firstName", "value": "Jane" },
            { "fieldType": "middleName", "value": "ok" },
            { "fieldType": "lastName", "value": "Doe" },
            { "fieldType": "gender", "value": "male" },
            { "fieldType": "email", "value": "jane@email.com" },
            { "fieldType": "dateOfBirth", "value": "20/01/1980" },
            { "fieldType": "address", "value": "125 York Street" }
        ]
    }
};

// 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.