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
`type` (required)	string	"individual" or "entity"
`metadata_onBehalf` (required)	string	the UserId of your customer
`metadata_tags`	string array	grouping tags
`trace` (required)	string	The verification UUID from the webhook
`isStandaloneScreening` (only for standalone screening)	boolean	Include for standalone screening

Standalone Screening

When the original screening was done as a standalone screening (not as part of a KYC/KYB), you must include the parameter isStandaloneScreening in the request body.

Runnable example

POST

/screen

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

// request body
const data = {
"metadata_version": "4",
"metadata_serviceUid": "XL7ULiU6B4QE9Y2iWFZnhtMDKFN2",
"metadata_secretKey": "api_sec_NJAtNcRtUrPlf7xYDrMNP9URI-ZfN314",

  "metadata_onBehalf": "0cZ7Iz04oecZ7nNweGXHvoERjSk2", // replace with your customer service uid
  "metadata_tags": ["tag1", "tag2"],

  "type": "individual", // or "entity"
  "trace": "your-unique-verification-uuid"
  // IN CASE OF STANDALONE SCREENING, ADD THE FOLLOWING PARAMETER
  // "isStandaloneScreening": true

};

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

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