# Screen Compliance Lists

**Overview**

The instruction will present how to check if targeted Business Partner or person is listed on any compliance list.

This instruction is based on [Screen Compliance Lists](/apis/data-compliance-api/api-v2/compliance-lists/paths/~1v2~1compliancelists~1screen/post) documentation published in Developer Portal.

**Scenario**

In this instruction you will learn how to:

1. Check targeted Business Partner based on provided example
2. Interpret received data
3. Modify the request to screen person.


## Prerequisites

### Authorization

Before trying CDQ APIs, user must be authenticated:

1. Paste the API Key in the console's security bar into the `X-API-KEY` field.


![](/assets/auth7.0d4fb05fa55bc16d828c76e9976f979930ffadb949cfc149a6617cc6518ab57d.6fde6558.png)

1. After pasting the API Key, the green padlock will appear.


![](/assets/auth8.28e02515b78db57ec32c07fd6bd7d296484e64f65ef6a3bc5296520cb1da8d65.6fde6558.png)

Be careful
Green padlock doesn't mean that the API Key was pasted correctly.

1. Check your API key for missing characters or extra space before trying.


#### No API Key?

1. Check how to get one on [authentication page](/documentation/instructions/authentication).
2. Follow the steps above.


## Step 1: Business Partner screening based on provided example.

To screen concrete Business Partner:

1. Use the **[Screen Compliance Lists](https://developer.cdq.com/reference-docs/data-compliance/V2/tag/Compliance-Lists/#tag/Compliance-Lists/paths/~1v2~1compliancelists~1screen/post)** endpoint to send the below request.
2. Check the above example in the **Try It Console** now!
3. Select the **Find a fuzzy candidate** provided example.
4. Click **Send** button.


To extend the response's item list modify the request with `limit` parameter:


```json
{
  "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.


Full list of available compliance lists is available in [Compliance Lists](https://developer.cdq.com/reference-docs/data-compliance/V2/tag/Compliance-Lists/#tag/Compliance-Lists/paths/~1v2~1compliancelists~1screen/post!path=lists&t=request) 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.

Person to screen (`Thoraya Barzan Ibrahim Hasan Al-Tikriti`) was chosen as an example based on official european [sanction list](https://data.europa.eu/data/datasets/consolidated-list-of-persons-groups-and-entities-subject-to-eu-financial-sanctions?locale=en).

To modify the request body to screen chosen person:

* Change the `entry` parameter to the person details provided above:



```json
{
  "names": [
    {
      "value": "Thoraya Barzan Ibrahim Hasan Al-Tikriti"
    }
  ]
}
```

* Change the `dataSources` parameter technical key to the `SANCTION_LIST`.



```json
{
  "dataSources": [
    {
      "technicalKey": "SANCTION_LIST"
    }
  ]
}
```

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.



```json
{
  "matchingThreshold": 0.85
}
```

* Check the below example in the **Try It Console**:



```json
{
    "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.


## Your opinion matters!

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!