Skip to content

Data Compliance API (2)

This API provides services to search and read compliance information

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Production
https://api.cdq.com/data-compliance/rest

Examples

Example requests for various endpoints

Operations

Compliance Lists

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

Operations

Screen Compliance Lists

Request

Use this endpoint to find fuzzy candidate matches when searching in sanctions and watchlist.

By default the endpoint has SHOW_AUDIT_TRAIl feature enabled. Use the featuresOn and featuresOff fields in request to add and remove features.

Security
apiKey
Bodyapplication/json
entryobject(ComplianceEntryRequest)

Compliance entry used for compliance screening checks.

dataSourcesArray of objects(ComplianceDataSource)

List of Data Sources.

configurationobject(ComplianceListsScreeningConfigurationRequest)

Configuration that should be used during screening. If this object and configurationId are not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown. If this object and configurationId are both provided, exception will be also thrown as only on of them is allowed.

configurationIdstring(ComplianceListsScreeningConfigurationId)

ID of the configuration that should be used during screening. If not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown.

Example: "64cd0303e1cd5s1e4354a1c6"
featuresOnArray of strings(ScreeningFeature)

List of features to be enabled.

Items Enum ValueDescription
SHOW_AUDIT_TRAIL

Show audit trail in the response.

ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]
featuresOffArray of strings(ScreeningFeature)

List of features to be disabled.

Items Enum ValueDescription
SHOW_AUDIT_TRAIL

Show audit trail in the response.

ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]
limitinteger

Specify the number of returned screen results.

Default 10
Example: "10"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
curl -i -X POST \
  https://api.cdq.com/data-compliance/rest/v2/compliancelists/screen \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "entry": {
      "names": [
        {
          "value": "Klaus"
        }
      ],
      "addresses": [
        {
          "country": {
            "shortName": "DE"
          }
        }
      ]
    },
    "dataSources": [
      {
        "technicalKey": "SANCTION_LIST"
      }
    ],
    "lists": [
      {
        "technicalKey": "INFO4C_SL_22"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
valuesArray of objects(ComplianceHit)

List of compliance screening results.

auditTrailobject(AuditTrail)

Returns prove that a complete compliance check has been performed including all settings that have been used to do this check.

Response
application/json
{
  "total": "67",
  "nextStartAfter": "5712566172571652",
  "startAfter": "5712566172571652",
  "values": [
    { … }
  ],
  "auditTrail": {
    "performedBy": "John Doe",
    "screenedNames": [ … ],
    "screeningDate": "2026-02-24T12:09:14Z",
    "screeningSettings": { … }
  }
}

Configuration Profiles

Manage the retrieval of predefined configuration profiles. These profiles are essential for setting up and managing compliance list screening processes.

Operations

Configurations

Manage configurations for compliance list screening. These endpoints allow for the listing, creation, reading, updating, and deletion of configurations. The configurations are essential for defining the parameters of the screening process.

Operations

Processing Logs

Operations