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

Read Augmented Business Partner

Request

Read an Augmented Business Partner from a given Data Source.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
dataSourceIdstring(BusinessPartnerStorageDataSourceId)required

Unique identifier of the Data Source.

Example: 648824a691d8d2503d65103e
Bodyapplication/jsonrequired
externalIdstringnon-emptyrequired

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."
fromstring

Filter updates by date.

Example: "2025-08-27T14:26:38Z"
featuresOnArray of strings(FetchAugmentedBusinessPartnerFeatureParam)

List of feature to be used during the fetch Augmented Business Partner.

Items Enum ValueDescription
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.updates in the result object. By default, turned off.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: ["FETCH_RAW_UPDATES"]
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/v2/storages/72d6900fce6b326088f5d9d91049e3e6/datasources/648824a691d8d2503d65103e/augmentedbusinesspartners/fetch \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "externalId": "The ID managed in the customer'\''s SAP systems.",
    "from": "2025-08-27T14:26:38Z",
    "featuresOn": [
      "FETCH_RAW_UPDATES"
    ]
  }'

Responses

OK

Bodyapplication/json
updatedBusinessPartnerobject(UpdatedBusinessPartner)

A Business Partner which contains also contextual information about applied updates.

updatesArray of objects(UpdatedBusinessPartner)

Raw updates from Reference Data Sources.

metadataobject(AugmentedBusinessPartnerMetadata)

Metadata for an Augmented Business Partner.

originalBusinessPartnerobject(BusinessPartner)

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

Response
application/json
{
  "updatedBusinessPartner": {
    "dataSourceId": "648824a691d8d2503d65103e",
    "summary": { … },
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "addresses": [ … ],
    "externalId": "The ID managed in the customer's SAP systems.",
    "profile": { … },
    "relations": [ … ],
    "types": [ … ]
  },
  "updates": [
    { … }
  ],
  "metadata": {
    "externalId": "The ID managed in the customer's SAP systems.",
    "executedAt": "2025-08-27T14:26:38Z",
    "country": { … },
    "trigger": { … },
    "processingStatus": { … }
  },
  "originalBusinessPartner": {
    "externalId": "The ID managed in the customer's SAP systems.",
    "jsonRecord": "{ \"key\" : \"value\"}",
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "profile": { … },
    "types": [ … ],
    "relations": [ … ],
    "addresses": [ … ]
  }
}

List Augmented Business Partners

Request

Read a page of Augmented Business Partners from a given storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
startAfterstring

Start after the provided pagination ID. Leave empty for the first query. The response will contain a property nextStartAfter, which needs to be used for any subsequent queries until nextStartAfter is empty. See CDQ - Developer Guidelines.

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

Define the maximum page size of the response.
See also CDQ - Developer Guidelines.

Default 100
Example: limit=100
dataSourceIdsArray of strings(BusinessPartnerStorageDataSourceId)

List of IDs of Data Sources of the Data Mirror for filtering only Business Partners that are managed in these sources.

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

List of Business Partner External IDs for filtering by a specific selection of Business Partners managed in the Data Mirror.

Example: externalIds=The ID managed in the customer's SAP systems.
typeTechnicalKeysArray of strings(BusinessPartnerTypeTechnicalKeyParam)

List of Business Partner Type Technical Keys for filtering by a specific selection of Business Partners managed in the Data Mirror.

Items Enum"BP_ADDRESS""BRAND""LEGAL_ENTITY""ORGANIZATIONAL_UNIT""UNKNOWN"
Example: typeTechnicalKeys=BP_ADDRESS
fromstring(ModifiedFrom)

Filter by records that were modified since the given date. Provide date in ISO format: RRRR-MM-DDTHH:MM:SSZ.

Example: from=2025-08-27T14:26:38Z
countryShortNamesArray of strings(CountryShortNameParam)

List of iso-2 country codes (see possible values here: Country - CDQ) for filtering Business Partners by country.

Items Enum"AC""AD""AE""AF""AG""AI""AL""AM""AN""AO"
Example: countryShortNames=DE
triggerTypeTechnicalKeysArray of strings(TriggerTypeTechnicalKeyParam)

Filter by the type of trigger for the generation of a new version of the Business Partner.

Items Enum ValueDescription
CREATED

Business Partners that were newly created in the data mirror by the user and thus were considered the first time.

UPDATED

Business Partners that were modified in the data mirror by the user.

REFERENCE_DATA_CHANGED

Business Partners in the data mirror for which an update in activated data sources was identified resulting in the generation of a new version of the Business Partner.

JOB

Business Partners that were created or updated by a job.

Example: triggerTypeTechnicalKeys=CREATED
triggerProvenanceTechnicalKeysArray of strings(ProvenanceTechnicalKeyParam)

Filter by the Data Sources that triggered the generation of a new version of the Augmented Business Partner.

Items Enum ValueDescription
AR_NRC

Argentina - National Registry of Companies

AT_CR

Austria - Company Register

AT_FON

Austria - Financial Online

AU_BR

Australia - Business Register

BR_RF

Brazil - Receita Federal

BZST

Germany - Federal Central Tax Office

CA_CR

Canada - Company Register

CDQ_AA

CDQ - Address Augmentation

CDQ_BANKPOOL

CDQ - Bank Pool

CDQ_CRS

CDQ - Company Register Service

Example: triggerProvenanceTechnicalKeys=CDQ_POOL
processingStatusTechnicalKeystring(ProcessingStatusTechnicalKeyEnum)

Filter by the Processing Status of the Augmented Business Partner.

Enum ValueDescription
READY

Processing Log Data processing has finished and result ready to consume.

RETRY

Processing Log Data processing has failed and needs to be retried.

BLOCKED

Processing Log Data processing is blocked and needs to be resolved.

IN_PROGRESS

Processing Log Data is being processed.

Example: processingStatusTechnicalKey=IN_PROGRESS
summaryClassificationsArray of strings(UpdateClassificationTechnicalKeyEnum)

Filter by specified Summary Classification Technical Keys.

Items Enum ValueDescription
CRITICAL

Critical

REJECTED

Update has been rejected

MAJOR

Major change

MINOR

Minor update

TRIVIAL

Trivial update

CONFIRMED

Contents have been confirmed by a data source and not changed

UNCHANGED

Contents have been not changed

Example: summaryClassifications=MAJOR
conceptClassificationsArray of strings(UpdateClassificationTechnicalKeyEnum)

Filter by specified concept Concept Classification Technical Keys.

Items Enum ValueDescription
CRITICAL

Critical

REJECTED

Update has been rejected

MAJOR

Major change

MINOR

Minor update

TRIVIAL

Trivial update

CONFIRMED

Contents have been confirmed by a data source and not changed

UNCHANGED

Contents have been not changed

Example: conceptClassifications=MAJOR
tagsArray of strings(UpdateTagEnum)

Filter by specified Update Summary Tags.

Items Enum"BANKRUPTCY_BUSINESS_PARTNER""BUSINESS_PARTNER_CATEGORY_ADDED""BUSINESS_PARTNER_CATEGORY_MODIFIED""BUSINESS_PARTNER_CLASSIFICATION_ADDED""BUSINESS_PARTNER_CLASSIFICATION_MODIFIED""BUSINESS_PARTNER_STATUS_ADDED""BUSINESS_PARTNER_STATUS_MODIFIED""BUSINESS_PARTNER_TYPE_ADDED""BUSINESS_PARTNER_TYPE_MODIFIED""DIRECT_LEGAL_RELATION_ADDED"
Example: tags=IDENTIFIER_ADDED
featuresOnArray of strings(ReadAugmentedBusinessPartnersFeatureParam)

Features to be activated during the read augmented Business Partners.

Items Enum ValueDescription
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default, turned off.

FILTER_BY_ENABLED_AUGMENTATION_MONITORS

Filters out results by enabled, existing data sources of augmentation monitors. By default, turned on.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: featuresOn=FETCH_RAW_UPDATES
featuresOffArray of strings(ReadAugmentedBusinessPartnersFeatureParam)

Features to be deactivated during the read augmented Business Partners.

Items Enum ValueDescription
FETCH_RAW_UPDATES

Allows to switch fetching raw updates field to reduce data size. Result is available under $.values[*].updates in the result object. By default, turned off.

FILTER_BY_ENABLED_AUGMENTATION_MONITORS

Filters out results by enabled, existing data sources of augmentation monitors. By default, turned on.

SHOW_ORIGINAL_BUSINESS_PARTNER

Include business partner that was used as an input for curation in the result. By default, turned off.

Example: featuresOff=FETCH_RAW_UPDATES
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/v2/storages/72d6900fce6b326088f5d9d91049e3e6/augmentedbusinesspartners \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
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"
valuesArray of objects(AugmentedBusinessPartner)

List of Augmented Business Partners.

requestobject(AugmentedBusinessPartnersRequest)

Parameters for a request to read Augmented Business Partners.

Response
application/json
{
  "limit": "100",
  "total": "67",
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "values": [
    { … }
  ],
  "request": {
    "dataSourceIds": [ … ],
    "effectiveDataSourceIds": [ … ],
    "externalIds": [ … ],
    "typeTechnicalKeys": [ … ],
    "from": "2025-08-27T14:26:38Z",
    "countryShortNames": [ … ],
    "triggerTypeTechnicalKeys": [ … ],
    "triggerProvenanceTechnicalKeys": [ … ],
    "summaryClassifications": [ … ],
    "conceptClassifications": [ … ],
    "tags": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "effectiveFeatures": [ … ]
  }
}

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

Business Partners

Operations