PEPs and Sanctions screening of entities

Use this API call to run PEPs and Sanctions screening of entities.

Parameters

NameTypeDescription
name
(required)		string - letters only

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.

Runnable example


// api endpoint
const apiEndpoint = 'https://dev.bronid.com/screen';

// request body
const kycData = {
	"metadata_version": "4",
	"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
	"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",
	"metadata_tags": ["product1", "client1"],
	
	"type": "entity",
	"fields": {
		"name": "The Entity Name"
	},
};

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

// submit the KYC data to the bronID API
const bronIdResult = await axios
	.post(apiEndpoint, kycData)
	.then(res => {
		return res.data;
	})
	.catch(error => {
		console.log('error! click the results to expand them');
		console.log(JSON.stringify(error.response.data, null, 2));
	})

const printResult = 'bronId API response: ' + JSON.stringify(bronIdResult, null, 2);
	
// Click “▶ run” to try this code live and run your first KYC.