Distributor re-screening PEPs and Sanctions
Use this API call to re-screen your existing verifications for PEPs and Sanctions.
This API has the same format as the regular re-screening for PEPs and Sanctions of individuals
or entities, but it includes one extra
parameter (
metadata_onBehalf
) which is the UserId value of your onBehalf customer. Verifications submitted with
this parameter will also be visible to your customers through their portal account.
You can additionally use the
metadata_tags
param if you want to group the verifications.
The onBehalf and tags parameters can be used for filtering the verification and billing history.
Parameters
Name | Type | Description |
---|
metadata_onBehalf (required) | string | the UserId of your customer |
metadata_tags
| string array | grouping tags |
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_onBehalf": "your_customers_user_id",
"metadata_tags": ["tag1", "tag2"],
"type": "individual",
"trace": "your-unique-verification-uuid",
};
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.