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
Languages
Servers
Production

https://api.cdq.com/data-compliance/rest/

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.

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

Get Compliance Lists Screen Examples

Request

Get examples of how to use the compliance lists screen endpoint.

Security
apiKey
Query
startAfterstring

Only examples with an ID greater than this ID will be fetched.

Default "0"
Example: startAfter=1
limitinteger(int32)[ 1 .. 100 ]

Number of results that should be fetched.

Default 10
Example: limit=100
curl -i -X GET \
  'https://api.cdq.com/data-compliance/rest/v2/compliancelists/screen/examples?startAfter=1&limit=100' \
  -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"
limitstring(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(ComplianceListsScreenExample)

List of examples.

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

Processing Logs

Operations