Skip to content

Data Clinic API (2)

This API provides services for Data Clinic

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Mock server

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

Production

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

Decision Log

Provides services for managing decisions for Business Partners. Decisions are stored in a Decision Log and can be retrieved, upserted, cleared or deleted.

Operations

Augmented Business Partners

Represent entities enhanced with supplementary data derived from many distinct data sources, providing a comprehensive view of the Business Partner's information.

Operations

Augmented Configuration Properties

Used to define and manipulate the settings, which include various parameters and configurations for the augmentation of Business Partners.

Operations

Configuration

Used to create, read, update, and delete the configurations, which define the settings for the augmentation process of Business Partners.

Operations

List Augmentation Configurations

Request

Read augmentation configurations of this workspace.

Security
apiKey
Query
startAfterstring(StartAfter)

Pagination parameter for determining next page.

Example: startAfter=5712566172571652
limitinteger(Limit)

Size of the page.

Example: limit=100
defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

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(AugmentationConfigurationSearchResult)

List of augmentation configurations.

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

Create Augmentation Configuration

Request

Endpoint to create a new augmentation configuration.

Security
apiKey
Bodyapplication/json
featuresOnArray of strings(TransactionFeaturesOn)

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

Items Enum ValueDescription
CREATE_TRANSACTION

Creates a new transaction and makes the current request a part of it. By default turned off.

COMMIT_TRANSACTION

Commit transaction. By default turned off.

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(AugmentationConfiguration)

The effective settings for the augmentation.

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "configuration": {
      "lookupConfiguration": {
        "outputSettings": {
          "maxCandidates": 50,
          "limit": 20,
          "matchingThreshold": 0.5
        }
      },
      "curationConfiguration": {
        "curationSettings": [
          {
            "outputSettings": {
              "outputCharsets": [
                {
                  "concept": "ADDRESS",
                  "charset": "UTF8"
                }
              ],
              "outputLanguage": {
                "technicalKey": ""
              }
            },
            "addressCurationSettings": {
              "ignoreAddressConcepts": [],
              "curationLevelThreshold": "",
              "numberSeparator": {}
            },
            "featureSettings": {
              "featuresOn": [],
              "featuresOff": [],
              "profile": "FEATURES_OFF"
            },
            "countryScope": {
              "shortName": "WORLD"
            }
          }
        ]
      },
      "referenceDataSourceUsages": [
        {
          "referenceDataSource": {
            "technicalKey": "VIES"
          },
          "updates": {
            "enabled": true
          }
        },
        {
          "referenceDataSource": {
            "technicalKey": "CH_UIDR"
          },
          "updates": {
            "enabled": true
          }
        }
      ]
    },
    "name": "Client configuration"
  }'

Responses

Augmentation 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
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
configurationobject(AugmentationConfiguration)

The effective settings for the augmentation.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2025-08-27T14:26:38Z",
  "createdBy": "76248934691294444",
  "modifiedAt": "2025-08-27T14:26:38Z",
  "configuration": {
    "lookupConfiguration": { … },
    "fetchConfiguration": { … },
    "curationConfiguration": { … },
    "updateClassificationConfiguration": { … },
    "referenceDataSourceUsages": [ … ],
    "storageDataSourceUsages": [ … ]
  }
}

Read Augmentation Configuration

Request

Endpoint to retrieve an augmentation configuration based on its ID.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

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
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
configurationobject(AugmentationConfiguration)

The effective settings for the augmentation.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2025-08-27T14:26:38Z",
  "createdBy": "76248934691294444",
  "modifiedAt": "2025-08-27T14:26:38Z",
  "configuration": {
    "lookupConfiguration": { … },
    "fetchConfiguration": { … },
    "curationConfiguration": { … },
    "updateClassificationConfiguration": { … },
    "referenceDataSourceUsages": [ … ],
    "storageDataSourceUsages": [ … ]
  }
}

Update Augmentation Configuration

Request

Endpoint to update an existing augmentation configuration.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
featuresOnArray of strings(AugmentationConfigurationUpdateFeaturesOn)

Features to be activated.

Items ValueDescription
REEVALUATION_ON_CHANGES

Re-evaluates business partners based on changes in the configuration.

Example: ["REEVALUATION_ON_CHANGES"]
namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."
configurationobject(AugmentationConfiguration)

The effective settings for the augmentation.

curl -i -X PUT \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "featuresOn": [
      "REEVALUATION_ON_CHANGES"
    ],
    "name": "Client configuration.",
    "configuration": {
      "lookupConfiguration": {
        "featureSettings": {
          "featuresOn": [
            "CURATE_REQUEST"
          ],
          "featuresOff": [
            "CURATE_REQUEST"
          ]
        },
        "outputSettings": {
          "matchingThreshold": 0.75,
          "maxCandidates": 50,
          "limit": 100
        }
      },
      "fetchConfiguration": {
        "featuresOn": [
          "FORCE_EXTERNAL_CALL"
        ],
        "featuresOff": [
          "FORCE_EXTERNAL_CALL"
        ],
        "screeningMatchingThreshold": 0.75
      },
      "curationConfiguration": {
        "curationSettings": [
          {
            "countryScope": {
              "shortName": "CH"
            },
            "featureSettings": {
              "profile": "STANDARD",
              "featuresOn": [
                "ENRICH_IDENTIFIERS"
              ],
              "featuresOff": [
                "ENRICH_IDENTIFIERS"
              ]
            },
            "addressCurationSettings": {
              "curationLevelThreshold": "0.75",
              "dataSourcePriority": {
                "primaryAddressDataSource": {},
                "secondaryAddressDataSources": [
                  null
                ]
              },
              "numberSeparator": {
                "value": ","
              },
              "ignoreAddressConcepts": [
                {}
              ],
              "inputAddressConceptsIgnored": [
                {}
              ]
            },
            "outputSettings": {
              "outputLanguage": {
                "technicalKey": "en"
              },
              "outputCharsets": [
                {}
              ]
            }
          }
        ],
        "goldenRecordSettings": {
          "dataSources": [
            {
              "countryScope": {
                "shortName": "CH"
              },
              "primaryDataSource": {
                "technicalKey": "BR_RF"
              },
              "secondaryDataSources": [
                {}
              ],
              "otherDataSources": [
                {}
              ],
              "unallowedDataSources": [
                {}
              ]
            }
          ]
        }
      },
      "updateClassificationConfiguration": {
        "updateClassificationRules": [
          {
            "technicalKey": "RULE123",
            "classification": {
              "technicalKey": "MAJOR"
            }
          }
        ]
      },
      "referenceDataSourceUsages": [
        {
          "referenceDataSource": {
            "technicalKey": "BR_RF"
          },
          "lookup": true,
          "updates": {
            "enabled": true
          }
        }
      ],
      "storageDataSourceUsages": [
        {
          "storageDataSource": {
            "id": "648824a691d8d2503d65103e"
          },
          "lookup": true,
          "updates": {
            "enabled": true,
            "linkageStrategy": {
              "externalContext": {
                "identifiers": [
                  null
                ]
              }
            }
          }
        }
      ]
    }
  }'

Responses

Augmentation configuration updated 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
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
configurationobject(AugmentationConfiguration)

The effective settings for the augmentation.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2025-08-27T14:26:38Z",
  "createdBy": "76248934691294444",
  "modifiedAt": "2025-08-27T14:26:38Z",
  "configuration": {
    "lookupConfiguration": { … },
    "fetchConfiguration": { … },
    "curationConfiguration": { … },
    "updateClassificationConfiguration": { … },
    "referenceDataSourceUsages": [ … ],
    "storageDataSourceUsages": [ … ]
  }
}

Delete Augmentation Configuration

Request

Endpoint to delete an existing augmentation configuration.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

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
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:38Z"
configurationobject(AugmentationConfiguration)

The effective settings for the augmentation.

Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "createdAt": "2025-08-27T14:26:38Z",
  "createdBy": "76248934691294444",
  "modifiedAt": "2025-08-27T14:26:38Z",
  "configuration": {
    "lookupConfiguration": { … },
    "fetchConfiguration": { … },
    "curationConfiguration": { … },
    "updateClassificationConfiguration": { … },
    "referenceDataSourceUsages": [ … ],
    "storageDataSourceUsages": [ … ]
  }
}

Read Augmentation Configuration Version

Request

Read a specific version of an augmentation configuration by id and version number.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

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

Version number of the configuration.

Example: 1
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/configurations/augmentation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the augmentation configuration 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(AugmentationConfiguration)

The effective settings for the augmentation.

createdAtstring

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

Example: "2025-08-27T14:26:38Z"
modifiedAtstring

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

Example: "2025-08-27T14:26:38Z"
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": {
    "lookupConfiguration": { … },
    "fetchConfiguration": { … },
    "curationConfiguration": { … },
    "updateClassificationConfiguration": { … },
    "referenceDataSourceUsages": [ … ],
    "storageDataSourceUsages": [ … ]
  },
  "createdAt": "2025-08-27T14:26:38Z",
  "modifiedAt": "2025-08-27T14:26:38Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Business Partners

Operations