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

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

Screen Compliance Lists

Request

Use this endpoint to find fuzzy candidate matches when searching in sanctions and watchlist.

By default the endpoint has SHOW_AUDIT_TRAIl feature enabled. Use the featuresOn and featuresOff fields in request to add and remove features.

Security
basicAuth
Bodyapplication/json
entryobject(ComplianceEntryRequest)

Compliance entry used for compliance screening checks.

dataSourcesArray of objects(ComplianceDataSource)

List of Data Sources.

configurationobject(ComplianceListsScreeningConfigurationRequest)

Configuration that should be used during screening. If this object and configurationId are not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown. If this object and configurationId are both provided, exception will be also thrown as only on of them is allowed.

configurationIdstring(ComplianceListsScreeningConfigurationId)

ID of the configuration that should be used during screening. If not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown.

Example: "64cd0303e1cd5s1e4354a1c6"
featuresOnArray of strings(ScreeningFeature)

List of features to be enabled.

Items Enum ValueDescription
SHOW_AUDIT_TRAIL

Show audit trail in the response.

ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]
featuresOffArray of strings(ScreeningFeature)

List of features to be disabled.

Items Enum ValueDescription
SHOW_AUDIT_TRAIL

Show audit trail in the response.

ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

Example: ["ACTIVATE_STOP_WORDS","SHOW_AUDIT_TRAIL"]
limitinteger

Specify the number of returned screen results.

Default 10
Example: "10"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v2/compliancelists/screen \
  -H 'Content-Type: application/json' \
  -d '{
    "entry": {
      "names": [
        {
          "value": "Klaus"
        }
      ],
      "addresses": [
        {
          "country": {
            "shortName": "DE"
          }
        }
      ]
    },
    "dataSources": [
      {
        "technicalKey": "SANCTION_LIST"
      }
    ],
    "lists": [
      {
        "technicalKey": "INFO4C_SL_22"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
valuesArray of objects(ComplianceHit)

List of compliance screening results.

auditTrailobject(AuditTrail)

Returns prove that a complete compliance check has been performed including all settings that have been used to do this check.

Response
application/json
{
  "total": "67",
  "nextStartAfter": "5712566172571652",
  "startAfter": "5712566172571652",
  "values": [
    { … }
  ],
  "auditTrail": {
    "performedBy": "John Doe",
    "screenedNames": [ … ],
    "screeningDate": "2024-12-31T23:59:59.000Z",
    "screeningSettings": { … }
  }
}

Info4c Entry

Request

Use this endpoint to find info4c entry by id and list type.

Security
basicAuth
Path
entryIdstringrequired

ID of Info4c entry.

Example: 10141039604
Query
listTypestringrequired

Type of the list.

Enum"WL""SL""PEP"
Example: listType=PEP
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v2/compliancelists/entries/10141039604?listType=PEP'

Responses

OK

Bodyapplication/json
formattedComplianceListEntryobject(FormattedComplianceListEntry)

Holds the result of a formatted compliance list.

Response
application/json
{
  "formattedComplianceListEntry": {
    "caseDetails": { … },
    "listDetails": { … },
    "identification": { … },
    "activity": { … },
    "metadata": { … }
  }
}

List Compliance Lists by type

Request

Use this endpoint to find Compliance Lists by type.

Security
basicAuth
Query
typestringrequired

Type of the Compliance List to retrieve.

Enum"WATCHLIST""SANCTIONLIST""PEP"
Example: type=PEP
curl -i -X POST \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/data-compliance-api/data-compliance-api-v3/api-v3/v2/compliancelists/byAuthority?type=PEP'

Responses

OK

Bodyapplication/jsonArray [
authoritystring

Name of the authority responsible for maintaining the list.

Example: "Iberville Parish Sheriff's Department"
listNamesArray of objects(ComplianceListSummary)
]
Response
application/json
[
  {
    "authority": "Iberville Parish Sheriff's Department",
    "listNames": [ … ]
  }
]

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