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

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

List Configurations

Request

List all existing configurations for compliance list screening.

Security
apiKey
Query
startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
limitinteger(int32)>= 1

Number of resources to be returned on the page.

Default 500
Example: limit=200
defaultConfigurationboolean

Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.

Default null
Example: defaultConfiguration=true
curl -i -X GET \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(WorkspaceConfigurationSearchResult)
Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Create a Configuration

Request

Create a new configuration for compliance list screening.

Security
apiKey
Bodyapplication/json
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

curl -i -X POST \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "configuration": {
      "matchingThreshold": "0.8",
      "lists": [
        {
          "technicalKey": "INFO4C_SL_1"
        }
      ]
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2025-10-14T07:32:29Z",
  "modifiedAt": "2025-10-14T07:32:29Z",
  "createdBy": "76248934691294444"
}

Read Configuration

Request

Read existing configuration for compliance list screening by id.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2025-10-14T07:32:29Z",
  "modifiedAt": "2025-10-14T07:32:29Z",
  "createdBy": "76248934691294444"
}

Update Configuration

Request

Update existing configuration for compliance list screening by id.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

curl -i -X PUT \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Client configuration.",
    "configuration": {
      "matchingThreshold": "0.8",
      "lists": [
        {
          "technicalKey": "INFO4C_SL_1"
        }
      ]
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2025-10-14T07:32:29Z",
  "modifiedAt": "2025-10-14T07:32:29Z",
  "createdBy": "76248934691294444"
}

Delete Configuration

Request

Delete existing configuration for compliance list screening by id.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
idstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2025-10-14T07:32:29Z",
  "modifiedAt": "2025-10-14T07:32:29Z",
  "createdBy": "76248934691294444"
}

Read Compliance List Screening Configuration Version

Request

Read a specific version of a compliance list screening configuration by id and version number.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
versionintegerrequired

Version number of the configuration.

Example: 1
curl -i -X GET \
  https://api.cdq.com/data-compliance/rest/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the compliance lists screening configuration version. Not to be confused with the configuration ID.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
namestring

The name of the configuration

Example: "Configuration Name"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2025-10-14T07:32:29Z"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2025-10-14T07:32:29Z",
  "modifiedAt": "2025-10-14T07:32:29Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Processing Logs

Operations