Screen Compliance Lists
Overview
The instruction will present how to check if targeted Business Partner or person is listed on any compliance list.
info
This instruction is based on Screen Compliance Lists documentation published in Developer Portal.
Scenario
In this instruction you will learn how to:
- Check targeted Business Partner based on provided example
- Interpret received data
- Modify the request to screen person.
Prerequisites
Authorization
Before trying CDQ APIs, user must be authenticated:
- Paste the API Key in the console's security bar into the
X-API-KEY
field.
![auth7 auth7](/static/ff6738eb5a811d20ec05a4dfd53c578c/a58fe/auth7.png)
- After pasting the API Key, the green padlock will appear.
![auth8 auth8](/static/11c93eafb5a324ab337bd26033aea925/2d920/auth8.png)
Be careful
Green padlock doesn't mean that the API Key was pasted correctly.
- Check your API key for missing characters or extra space before trying.
No API Key?
- Check how to get one on authentication page
- Follow the steps above.
Step 1: Business Partner screening based on provided example.
To screen concrete Business Partner:
- Use the Screen Compliance Lists endpoint to send the below request.
- Payload
- curl
{- "entry": {
- "names": [
- {
- "value": "Klaus"
}
], - "addresses": [
- {
- "country": {
- "shortName": "DE"
}
}
]
}, - "dataSources": [
- {
- "technicalKey": "SANCTION_LIST"
}
], - "lists": [
- {
- "technicalKey": "INFO4C_SL_22"
}
]
}
- Check the above example in the Try It Console now!
- Select the Find a fuzzy candidate provided example.
- Click Send button.
limit
parameter:{
"entry": {},
"dataSources": [],
"limit": "100"
}
Congratulations
Your Business Partner is screened!
Step 2: Interpret received data
The response contains the list of items that match the provided Business Partner. Each item contains the following information:
values
The list of items that match the provided Business Partner name .
Field | Description |
---|---|
cdqId | The unique identifier of the item. |
entry | The item's data such as externalId , names , addresses , list , additionalInformation . |
matchingProfile | The item's matching profile with matchingScores to rate screened data. |
dataSource | The item's compliance data source. |
- Change the
lists
parameter and fulfill with needed compliance lists.
info
Full list of available compliance lists is available in Compliance Lists documentation.
externalId
externalId
is a unique identifier of the item in the data source used by customers in their own database.names
names
is a list of names of the searched person or business partner.addresses
addresses
is a list of addresses of the searched person or business partner.list
list
is a list of compliance lists that the person or business partner is listed on.additionalInformation.
additionalInformation
is a list of additional information about the item.Step 3: Modify the request.
Now you will prepare the request to screen person against compliance lists.
info
Thoraya Barzan Ibrahim Hasan Al-Tikriti
) was chosen as an example based on official european sanction list.To modify the request body to screen chosen person:
- Change the
entry
parameter to the person details provided above:
{
"names": [
{
"value": "Thoraya Barzan Ibrahim Hasan Al-Tikriti"
}
]
}
- Change the
dataSources
parameter technical key to theSANCTION_LIST
.
{
"dataSources": [
{
"technicalKey": "SANCTION_LIST"
}
]
}
attention
You can choose only one compliance list at a time.
Data Source | Description |
---|---|
SANCTION_LIST | List of people who are sanctioned by the government. |
WATCHLIST | List of people who are wanted by the police. |
PEP | Politically Exposed Person. |
- Remove the
lists
parameter form the request body. - Add the
matchingThreshold
parameter to the request to limit the screening results.
{
"matchingThreshold": 0.85
}
- Check the below example in the Try It Console:
{
"entry": {
"names": [{
"value": "Thoraya Barzan Ibrahim Hasan Al-Tikriti"
}]
},
"dataSources": [{
"technicalKey": "SANCTION_LIST"
}],
"matchingThreshold": 0.85
}
- Expand the results to see which sanction lists the person you are looking for has been placed on.