KYC verification of individuals (China)

Use this API call to perform KYC verification of individuals.

Parameters

NameTypeDescriptionValidation
country
(required)		stringCHN
completeName
(required)		Complete Name (Latin alphabet - PIN)Less than 80 characters
completeNameChinese
(required)		Complete Name (Simplified Chinese alphabet)Less than 80 characters
dateOfBirth
(required)		stringDD/MM/YYYY
unitNumber
(required, if present)		string or null*
addressLine1
(required)		string
locality
(required)		string
province
(required)		string
postcode
(required)		string6 digits
phone
(required)		string11 digits
nationalId
(required)		string18 characters
bankCardNumber
(required)		string16-19 digits
gender
stringmale/female
email
string

Tags

You can add tags to your verification requests to help you organise your verifications by using the metadata_tags parameter. Read more about tags here.

ID documents

Submitting ID documents is optional. You can use ID documents as a verification source to improve the likelihood of a successful verification.

Runnable example

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

// request body
const kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_userId": "yourUniqueUserId",
	"metadata_tags": ["product1", "client1"],
	
	"type": "individual",
	"fields": {
		"country": "CHN",
		"completeName": "LATIN NAME",
		"completeNameChinese": "简化字",
		"dateOfBirth": "20/10/1980",
		"bankCardNumber": "8171999900000000021",
		"nationalId": "911124198108030024",
		"gender": "female",
		"unitNumber": "88号",
		"addressLine1": "南山区科技南十二路",
		"locality": "深圳市南山区",
		"postcode": "518057",
		"province": "广东省",
		"email": "email@qq.com",
		"phone": "15898765432"
	}
};

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

// submit the KYC data to the bronID API
try {
	const response = await fetch(apiEndpoint, {
		method: 'POST',
		headers: {
			'Content-Type': 'application/json',
		},
		body: JSON.stringify(kycData),
	});

	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.