{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml","oas-apis/data-exchange-api/@data-exchange-api-v4/api-v4.yaml":"oas-apis/data-exchange-api/@data-exchange-api-v4/api-v4.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","partial","replay-openapi"]},"type":"markdown"},"seo":{"title":"Screen Compliance Lists","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"screen-compliance-lists","__idx":0},"children":["Screen Compliance Lists"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Overview"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The instruction will present how to check if targeted Business Partner or person is listed on any compliance list."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This instruction is based on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/data-compliance-api/api-v2/compliance-lists/paths/~1v2~1compliancelists~1screen/post"},"children":["Screen Compliance Lists"]}," documentation published in Developer Portal."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this instruction you will learn how to:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check targeted Business Partner based on provided example"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Interpret received data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Modify the request to screen person."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization","__idx":2},"children":["Authorization"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before trying CDQ APIs, user must be authenticated:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Paste the API Key in the console's security bar into the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-API-KEY"]}," field."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/auth7.0d4fb05fa55bc16d828c76e9976f979930ffadb949cfc149a6617cc6518ab57d.6fde6558.png","alt":""},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After pasting the API Key, the green padlock will appear."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/auth8.28e02515b78db57ec32c07fd6bd7d296484e64f65ef6a3bc5296520cb1da8d65.6fde6558.png","alt":""},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Be careful"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Green padlock doesn't mean that the API Key was pasted correctly."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check your API key for missing characters or extra space before trying."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"no-api-key","__idx":3},"children":["No API Key?"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check how to get one on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/documentation/_public/instructions/authentication"},"children":["authentication page"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Follow the steps above."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-business-partner-screening-based-on-provided-example","__idx":4},"children":["Step 1: Business Partner screening based on provided example."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To screen concrete Business Partner:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.cdq.com/reference-docs/data-compliance/V2/tag/Compliance-Lists/#tag/Compliance-Lists/paths/~1v2~1compliancelists~1screen/post"},"children":["Screen Compliance Lists"]}]}," endpoint to send the below request."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check the above example in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try It Console"]}," now!"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Find a fuzzy candidate"]}," provided example."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]}," button."]}]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"oas-apis/data-exchange-api/@data-exchange-api-v4/api-v4.yaml","pointer":"/paths/~1v2~1compliancelists~1screen/post","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To extend the response's item list modify the request with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," parameter:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"entry\": {},\n  \"dataSources\": [],\n  \"limit\": \"100\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Congratulations"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your Business Partner is screened!"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-interpret-received-data","__idx":5},"children":["Step 2: Interpret received data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains the list of items that match the provided Business Partner. Each item contains the following information:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"values","__idx":6},"children":["values"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list of items that match the provided Business Partner name ."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cdqId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique identifier of the item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The item's data such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["names"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalInformation"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["matchingProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The item's matching profile with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["matchingScores"]}," to rate screened data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataSource"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The item's compliance data source."]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Change the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lists"]}," parameter and fulfill with needed compliance lists."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full list of available compliance lists is available in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.cdq.com/reference-docs/data-compliance/V2/tag/Compliance-Lists/#tag/Compliance-Lists/paths/~1v2~1compliancelists~1screen/post!path=lists&t=request"},"children":["Compliance Lists"]}," documentation."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"externalid","__idx":7},"children":["externalId"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," is a unique identifier of the item in the data source used by customers in their own database."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"names","__idx":8},"children":["names"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["names"]}," is a list of names of the searched person or business partner."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"addresses","__idx":9},"children":["addresses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["addresses"]}," is a list of addresses of the searched person or business partner."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"list","__idx":10},"children":["list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}," is a list of compliance lists that the person or business partner is listed on."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"additionalinformation","__idx":11},"children":["additionalInformation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalInformation"]}," is a list of additional information about the item."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-modify-the-request","__idx":12},"children":["Step 3: Modify the request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now you will prepare the request to screen person against compliance lists."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Person to screen (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Thoraya Barzan Ibrahim Hasan Al-Tikriti"]},") was chosen as an example based on official european ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://data.europa.eu/data/datasets/consolidated-list-of-persons-groups-and-entities-subject-to-eu-financial-sanctions?locale=en"},"children":["sanction list"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To modify the request body to screen chosen person:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Change the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entry"]}," parameter to the person details provided above:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"names\": [\n    {\n      \"value\": \"Thoraya Barzan Ibrahim Hasan Al-Tikriti\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Change the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataSources"]}," parameter technical key to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SANCTION_LIST"]},"."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"dataSources\": [\n    {\n      \"technicalKey\": \"SANCTION_LIST\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can choose only one compliance list at a time."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data Source"},"children":["Data Source"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SANCTION_LIST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of people who are sanctioned by the government."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WATCHLIST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of people who are wanted by the police."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PEP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Politically Exposed Person."]}]}]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Remove  the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lists"]}," parameter form the request body."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["matchingThreshold"]}," parameter to the request to limit the screening results."]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"matchingThreshold\": 0.85\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check the below example in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try It Console"]},":"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"entry\": {\n        \"names\": [{\n                \"value\": \"Thoraya Barzan Ibrahim Hasan Al-Tikriti\"\n}]\n    },\n    \"dataSources\": [{\n            \"technicalKey\": \"SANCTION_LIST\"\n        }],\n    \"matchingThreshold\": 0.85\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Expand the results to see which sanction lists the person you are looking for has been placed on."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"your-opinion-matters","__idx":13},"children":["Your opinion matters!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!"]}]},"headings":[{"value":"Screen Compliance Lists","id":"screen-compliance-lists","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Authorization","id":"authorization","depth":3},{"value":"No API Key?","id":"no-api-key","depth":4},{"value":"Step 1: Business Partner screening based on provided example.","id":"step-1-business-partner-screening-based-on-provided-example","depth":2},{"value":"Step 2: Interpret received data","id":"step-2-interpret-received-data","depth":2},{"value":"values","id":"values","depth":3},{"value":"externalId","id":"externalid","depth":4},{"value":"names","id":"names","depth":4},{"value":"addresses","id":"addresses","depth":4},{"value":"list","id":"list","depth":4},{"value":"additionalInformation.","id":"additionalinformation","depth":4},{"value":"Step 3: Modify the request.","id":"step-3-modify-the-request","depth":2},{"value":"Your opinion matters!","id":"your-opinion-matters","depth":2}],"frontmatter":{"title":"Screen Compliance Lists.","seo":{"title":"Screen Compliance Lists"}},"lastModified":"2026-05-14T08:19:51.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/documentation/_public/instructions/screen-compliance-lists","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}