Distributor PEPs and Sanctions screening

Use this API call to run PEPs and Sanctions screening on behalf of your customers.

This API has the same format as the regular PEPs and Sanctions Screening, 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

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",
  "fields": {
  	"firstName": "John",
  	"lastName": "Person"
  }

};

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);
}