Compliance Lists

Facilitate the screening of Business Partners against various compliance lists such as sanction lists, watch lists and PEP lists.

Screen Compliance Lists

Use this endpoint to screen against compliance lists such as sanction lists, watch lists and PEP lists. The response includes a list of business partners that match the screening request.

SecurityapiKey
Request
Request Body schema: application/json
object (BusinessPartnerParam)

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

dataMatchingDefinitionId
string
Default: "DATA_COMPLIANCE_MATCHING_CONFIG"

Unique ID of a data matching definition

Example: "DATA_COMPLIANCE_MATCHING_CONFIG"
dataSources
Array of strings

List of Compliance Data Sources.

Items Enum: Description
SANCTION_LIST

Represents a list of individuals or entities sanctioned by authorities.

WATCHLIST

Represents a list of individuals or entities under watch for suspicious activities.

PEP

Represents a list of Politically Exposed Persons who hold a prominent public position.

Example: ["PEP"]
featuresOn
object

The features used in screening process.

matchingThreshold
number <double> (DataMatchingThreshold) [ 0 .. 1 ]
Default: 0

The threshold for the data matching.

Example: "0.5"
page
integer (Page) >= 0
Default: 0

Current page number.

Example: "1"
pageSize
integer (PageSize) [ 1 .. 1000 ]
Default: 10

Number of items per page.

Example: "100"
Responses
200

OK

post/compliancelists/screen
Request samples
application/json
{
  • "businessPartner": {
    }
}
Response samples
application/json
{
  • "pageSize": "100",
  • "totals": "67",
  • "page": "1",
  • "values": [
    ],
  • "auditTrail": {
    }
}