Create KYC users

Use this API call to create KYC user accounts.

If your system uses sub-accounts to segregate the submissions, you need to create a KYC user for each sub-account. Once you create a KYC user for each sub-account, you can include the sub-account userId (through the onBehalf parameter) when submitting for verification so the submissions are grouped accordingly.

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
regulatoryNumber
numbersRegulatory body enrollment number

Runnable example

const apiEndpoint = 'https://dev.bronid.com/createUser';

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

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

// Create the user and save the newly generated userId to your database
try {
	const response = await fetch(apiEndpoint, {
		method: 'POST',
		headers: {
			'Content-Type': 'application/json',
		},
		body: JSON.stringify(createUserData),
	});

	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 bronIdResult = await response.json();
		const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
		console.log(printResult);
	}
} catch (error) {
	console.log('Fetch error: ', error);
}

	
// Click “▶ run” to try this code live and run your first KYC.