Configurations

Custom Compliance Lists

Manage custom compliance lists. These endpoints allow for the creation, retrieval, updating, and deletion of custom compliance lists that can be used in screening processes.

Operations

Batch Screening

Manage batch screening processes for Business Partners. It encompasses endpoints for initiating screening jobs, monitoring their progress, and retrieving the results.

Operations

Business Partners

Facilitate the management of Business Partner data in compliance contexts. It includes endpoints for generating compliance reports, initiating and monitoring screening jobs, and managing configurations.

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

basicAuth

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 \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening?startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm&limit=200&defaultConfiguration=true'

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

basicAuth

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, activated.
COMMIT_TRANSACTION	Commit transaction. By default, deactivated.

Example: ["CREATE_TRANSACTION"]

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.

copiedFromobject(WorkspaceConfigurationCopiedFrom)

The configuration from which the new configuration is copied.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "configuration": {
      "matchingThreshold": "0.8",
      "lists": [
        {
          "technicalKey": "INFO4C_SL_1"
        }
      ]
    },
    "copiedFrom": {
      "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
      "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
    }
  }'

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

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "defaultConfiguration": true,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Configuration

Request

Read existing configuration for compliance list screening by id.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

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

Headers

X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

username (e.g. "lukaszmichta")
user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")

Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

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

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "defaultConfiguration": true,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Update Configuration

Request

Update existing configuration for compliance list screening by id.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

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

Headers

X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

username (e.g. "lukaszmichta")
user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")

Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3

Bodyapplication/json

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

featuresOnArray of strings(TransactionFeaturesOn)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, activated.
COMMIT_TRANSACTION	Commit transaction. By default, deactivated.

Example: ["CREATE_TRANSACTION"]

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2",
    "featuresOn": [
      "CREATE_TRANSACTION"
    ],
    "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

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "defaultConfiguration": true,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Delete Configuration

Request

Delete existing configuration for compliance list screening by id.

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

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

Query

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2

featuresOnArray of strings(TransactionFeatureParam)

Features to be enabled. Do not use CREATE_TRANSACTION and COMMIT_TRANSACTION at the same time.

Items Enum Value	Description
CREATE_TRANSACTION	Creates a new transaction and makes the current request a part of it. By default, activated.
COMMIT_TRANSACTION	Commit transaction. By default, deactivated.

Example: featuresOn=CREATE_TRANSACTION

Headers

X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

username (e.g. "lukaszmichta")
user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")

Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3

curl -i -X DELETE \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4?transactionId=8e37da1e-ee9d-4ee0-b03d-24a1f89988f2&featuresOn=CREATE_TRANSACTION' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

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

defaultConfigurationboolean(DefaultConfiguration)

Indicates if the configuration is the default one.

Example: true

configurationobject(ComplianceListsScreeningSettings)

Defines settings for compliance list screening.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

transactionIdstring(TransactionId)

ID of the transaction, pass it in subsequent requests to make them part of the transaction.

Example: "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "defaultConfiguration": true,
  "configuration": {
    "matchingThreshold": "0.8",
    "lists": [ … ]
  },
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444",
  "transactionId": "8e37da1e-ee9d-4ee0-b03d-24a1f89988f2"
}

Read Compliance List Screening Configuration Version

Request

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

Security

basicAuth

Path

configurationIdstringrequired

ID of the configuration.

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

versionintegerrequired

Version number of the configuration.

Example: 1

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/configurations/compliancelistsscreening/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1

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: "2020-08-31T16:47+00:00"

modifiedAtstring

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

Example: "2020-08-22T13:45+00:00"

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": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-22T13:45+00:00",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Examples

Example requests for various endpoints

Operations

Processing Logs

Operations

Data Compliance API (3)

Custom Compliance Lists

Batch Screening

Business Partners

Compliance Lists

Configuration Profiles

Configurations

List Configurations

Request

Responses

Share the feedback!

Create a Configuration

Request

Responses

Share the feedback!

Read Configuration

Request

Responses

Share the feedback!

Update Configuration

Request

Responses

Share the feedback!

Delete Configuration

Request

Responses

Share the feedback!

Read Compliance List Screening Configuration Version

Request

Responses

Share the feedback!

Examples

Processing Logs

Data Compliance API (3)

Custom Compliance Lists

Batch Screening

Business Partners

Compliance Lists

Configuration Profiles

Configurations

List Configurations

Request

Responses

Share the feedback!

Create a Configuration

RequestExpand all

Responses

Share the feedback!

Read Configuration

Request

Responses

Share the feedback!

Update Configuration

RequestExpand all

Responses

Share the feedback!

Delete Configuration

Request

Responses

Share the feedback!

Read Compliance List Screening Configuration Version

Request

Responses

Share the feedback!

Examples

Processing Logs

Request

Request