Skip to content

Data Compliance API (3)

This API provides services to search and read compliance information.

Download OpenAPI description
api-v3.json
api-v3.yaml
Overview
URL

https://www.cdq.ch/team

Patryk Dziedzioch

patryk.dziedzioch@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/

Production SOAP

https://api.corporate-data-league.ch/data-compliance/soap/v3/

Production

https://api.corporate-data-league.ch/data-compliance/

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

List Custom Compliance Lists

Request

List all custom compliance lists with pagination support.

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
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v3/customcompliancelists?startAfter=NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm&limit=200'

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"
limitinteger(Limit)

Number of items per page.

Example: "100"
valuesArray of objects(CustomComplianceList)

List of custom compliance lists.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "values": [
    { … }
  ]
}

Create Custom Compliance List

Request

Create a new custom compliance list.

Security
basicAuth
Bodyapplication/jsonrequired
namestring(CustomComplianceListName)required

Name of the custom compliance list.

Example: "Internal Watchlist"
descriptionstring(CustomComplianceListDescription)

Description of the custom compliance list.

Example: "Custom watchlist for internal screening purposes"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v3/customcompliancelists \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Internal Watchlist",
    "description": "Custom watchlist for internal screening purposes"
  }'

Responses

Custom compliance list created successfully

Bodyapplication/json
idstring(CustomComplianceListId)

Unique identifier of the custom compliance list.

Example: "6926b10d6730917732b3fddf"
namestring(CustomComplianceListName)

Name of the custom compliance list.

Example: "Internal Watchlist"
technicalKeystring(CustomComplianceListTechnicalKey)

Technical key of the custom compliance list.

Example: "CUSTOM_COMPLIANCE_LIST_1"
descriptionstring(CustomComplianceListDescription)

Description of the custom compliance list.

Example: "Custom watchlist for internal screening purposes"
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"
Response
application/json
{
  "id": "6926b10d6730917732b3fddf",
  "name": "Internal Watchlist",
  "technicalKey": "CUSTOM_COMPLIANCE_LIST_1",
  "description": "Custom watchlist for internal screening purposes",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444"
}

Read Custom Compliance List

Request

Read a custom compliance list by ID or technical key.

Security
basicAuth
Path
identifierstringrequired

Either the ID or technical key of the custom compliance list

Example: 6926b10d6730917732b3fddf
Query
identifierTypestring(CustomComplianceListIdentifierTypeParam)

Type of identifier. Defaults to "ID" if not specified.

Enum ValueDescription
ID

Get by unique identifier

TECHNICAL_KEY

Get by technical key

Example: identifierType=ID
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v3/customcompliancelists/6926b10d6730917732b3fddf?identifierType=ID'

Responses

Successful operation

Bodyapplication/json
idstring(CustomComplianceListId)

Unique identifier of the custom compliance list.

Example: "6926b10d6730917732b3fddf"
namestring(CustomComplianceListName)

Name of the custom compliance list.

Example: "Internal Watchlist"
technicalKeystring(CustomComplianceListTechnicalKey)

Technical key of the custom compliance list.

Example: "CUSTOM_COMPLIANCE_LIST_1"
descriptionstring(CustomComplianceListDescription)

Description of the custom compliance list.

Example: "Custom watchlist for internal screening purposes"
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"
Response
application/json
{
  "id": "6926b10d6730917732b3fddf",
  "name": "Internal Watchlist",
  "technicalKey": "CUSTOM_COMPLIANCE_LIST_1",
  "description": "Custom watchlist for internal screening purposes",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444"
}

Update Custom Compliance List

Request

Update an existing custom compliance list by ID.

Security
basicAuth
Path
identifierstringrequired

ID of the custom compliance list.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Bodyapplication/jsonrequired
namestring(CustomComplianceListName)

Name of the custom compliance list.

Example: "Internal Watchlist"
descriptionstring(CustomComplianceListDescription)

Description of the custom compliance list.

Example: "Custom watchlist for internal screening purposes"
curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v3/customcompliancelists/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Internal Watchlist",
    "description": "Custom watchlist for internal screening purposes"
  }'

Responses

Custom compliance list updated successfully

Bodyapplication/json
idstring(CustomComplianceListId)

Unique identifier of the custom compliance list.

Example: "6926b10d6730917732b3fddf"
namestring(CustomComplianceListName)

Name of the custom compliance list.

Example: "Internal Watchlist"
technicalKeystring(CustomComplianceListTechnicalKey)

Technical key of the custom compliance list.

Example: "CUSTOM_COMPLIANCE_LIST_1"
descriptionstring(CustomComplianceListDescription)

Description of the custom compliance list.

Example: "Custom watchlist for internal screening purposes"
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"
Response
application/json
{
  "id": "6926b10d6730917732b3fddf",
  "name": "Internal Watchlist",
  "technicalKey": "CUSTOM_COMPLIANCE_LIST_1",
  "description": "Custom watchlist for internal screening purposes",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "createdBy": "76248934691294444"
}

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

Examples

Example requests for various endpoints

Operations

Processing Logs

Operations