Create KYC users

Use this API call to create KYC user accounts.

If your business does is not using the KYC results directly (e.g. if you're not the reporting entity), and act as an agent on behalf of your clients, then you need to group the verification requests by specific client. To group the verifications, you will first need to create an account for them, and then include their userId (through the onBehalf parameter) when submitting the verifications.

We are required to perform due diligence of the users that you create, and confirm they have a legitimate legal requirement to perform KYC verifications. If your client does not satisfy these requirements their user account can be blocked.

Parameters

NameTypeDescription
country (required)string3 letter country ISO
email (required)stringAccount email address
companyName (required)stringThe name of your client's legal entity
companyNumber (required)stringThe number of your client's legal entity
firstName (required)string - letters onlyFirst name of your client's contact
lastName (required)string - letters onlyLast name of your client's contact
FCL (required)numbersFinancial or Credit licence
regulatoryNumbernumbersRegulatory body enrollment number

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

// request body
const createUserData = {
	// authorization
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "dev_secret_key",
	
	// user details
	"fields": {
		"country": "AUS",
		"email": "yourUserEmailAccount@email.com",
		"companyName": "Company Pty Ltd",
		"companyNumber": "123456789",
        "firstName": "Contact",
        "lastName": "Person",
        "FCL": "123456789",
        "regulatoryNumber": "123456789"
	}
};

// submit the user data to the bronID API
axios
	.post(apiEndpoint, createUserData)
	.then(res => {
		// save the userId
		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.