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
Mock server

https://developer.cdq.com/_mock/apis/data-compliance-api/api-v2/

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

Processing Logs

Operations

List Processing Log Results

Request

Retrieves latest screening results persisted in the Processing Log.

Data is populated only when Data Monitor with type "SCREENING" is configured for provided storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Business Partner Storage ID.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
businessPartnerIdsArray of strings(BusinessPartnerId)<= 500 items

Business Partner IDs.

Example: businessPartnerIds=63e635235c06b7396330fe40
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)

List of Business Partner Data Source IDs.

Example: dataSourceIds=648824a691d8d2503d65103e
externalIdsArray of strings(BusinessPartnerExternalId)<= 500 items

Business Partner External IDs.

Example: externalIds=The ID managed in the customer's SAP systems.
statusstring

Status of the screening result.

Enum"OK""FAILED""TRIVIAL"
Example: status=TRIVIAL
startAfterstring(StartAfter)

Used to retrieve the next page of results.

Example: startAfter=5712566172571652
limitinteger(int32)[ 1 .. 100 ]

Number of results that should be fetched. Maximum 100 results can be returned in one page.

Default 100
Example: limit=50
fromstring

ISO 8601 representation of the timestamp when the result since when data was created.

Example: from=2025-08-27T14:26:40Z
tostring

ISO 8601 representation of the timestamp when the result until when data was created.

Example: to=2025-08-27T14:26:40Z
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-compliance-api/api-v2/v2/screeninglogs/72d6900fce6b326088f5d9d91049e3e6/results \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

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"
fromstring

ISO 8601 representation of the timestamp when the result since when data was created.

Example: "2025-08-27T14:26:40Z"
tostring

ISO 8601 representation of the timestamp when the result until when data was created.

Example: "2025-08-27T14:26:40Z"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(ScreeningProcessingLogResult)

List of Screening Processing Log Results.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "from": "2025-08-27T14:26:40Z",
  "to": "2025-08-27T14:26:40Z",
  "total": "67",
  "values": [
    { … }
  ]
}