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

Business Partners

Operations

Confirm Business Partner

Request

<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Confirms the validity of a trading partner by checking the provided data against various CDQ services.

Security
apiKey
Query
dataTransformationDefinitionIdstring

The ID of the data transformation definition to apply.

Example: dataTransformationDefinitionId=123456
Bodyapplication/jsonrequired
businessPartnerobject(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.

featuresOnArray of strings(ConfirmFeatureParam)

List of features to be activated.

Items Enum ValueDescription
ENABLE_SANCTION_CONFIRMATION

Sanction confirmation is used to confirm business partner.

ENABLE_QUALIFICATION_CONFIRMATION

Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]
featuresOffArray of strings(ConfirmFeatureParam)

List of features to be deactivated.

Items Enum ValueDescription
ENABLE_SANCTION_CONFIRMATION

Sanction confirmation is used to confirm business partner.

ENABLE_QUALIFICATION_CONFIRMATION

Qualification functionality is used to confirm business partner.

Example: ["ENABLE_QUALIFICATION_CONFIRMATION"]
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-clinic-api/api-v2/v2/businesspartners/confirm \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businessPartner": {
      "externalId": "1",
      "names": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type/local",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "shortName": "CDQ AG",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "url": "https://meta.cdq.com/Business_partner/legal_form/name",
        "technicalKey": "DE_9866",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG",
        "cdlElfCode": "AG",
        "categories": [
          {
            "name": "Limited Liability Company",
            "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001"
          }
        ]
      },
      "identifiers": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type/name",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "value": "CHE-218.608.886 HR/MWST",
          "issuingBody": {
            "name": "Amtsgericht Aachen",
            "technicalKey": "Amtsgericht Aachen"
          },
          "status": {
            "name": "ACTIVE",
            "technicalKey": "ACTIVE"
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category/hotel",
          "technicalKey": "HOTEL"
        }
      ],
      "status": {
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/in_liquidation",
          "technicalKey": "IN_LIQUIDATION"
        },
        "officialDenotation": "Good Standing",
        "validFrom": "2024-12-11T08:30:48Z",
        "validUntil": "2024-12-11T08:30:48Z"
      },
      "profile": {
        "classifications": [
          {
            "value": "Manufacture of pesticides and other agrochemical products.",
            "code": "20.20Z",
            "type": {
              "name": "NAF 2003",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type/naf_rev_1",
              "technicalKey": "NAF 2003"
            }
          }
        ],
        "phoneNumbers": [
          {
            "countryPrefix": "+41",
            "number": "71 571 10 40",
            "type": {
              "name": "FAX",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type/fax",
              "technicalKey": "FAX"
            },
            "value": "+41 71 571 10 40"
          }
        ],
        "websites": [
          {
            "url": "https://cdq.com",
            "type": {
              "name": "Corporate Website",
              "url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type/name",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ]
      },
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type/legal_entity",
          "technicalKey": "LEGAL_ENTITY"
        }
      ],
      "relations": [
        {
          "startedAt": "2024-12-11T08:30:48Z",
          "endedAt": "2024-12-11T08:30:48Z",
          "type": {
            "name": "Commercial ultimate",
            "technicalKey": "COMMERCIAL_ULTIMATE"
          },
          "class": {
            "name": "CDQ Hierarchy",
            "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
          },
          "startNode": {
            "externalId": "The ID managed in the customer'\''s SAP systems.",
            "dataSourceId": "648824a691d8d2503d65103e"
          },
          "endNode": {
            "externalId": "The ID managed in the customer'\''s SAP systems.",
            "dataSourceId": "648824a691d8d2503d65103e"
          },
          "deactivatedAt": "2024-12-11T08:30:48Z"
        }
      ],
      "addresses": [
        {
          "externalId": "1",
          "cdqId": "CDQID-123456789",
          "version": {
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            }
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "careOf": {
            "value": "CDQ GmbH c/o Product Department"
          },
          "contexts": [
            {
              "value": "Production hall 7, Storage field 8."
            }
          ],
          "country": {
            "shortName": "CH",
            "value": "Switzerland"
          },
          "administrativeAreas": [
            {
              "value": "Sankt Gallen",
              "fipsCode": "SZ15",
              "shortName": "SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type/county",
                "technicalKey": "COUNTY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postCodes": [
            {
              "value": "9000",
              "type": {
                "name": "Regular",
                "url": "https://meta.cdq.com/Address/post_code/type/regular",
                "technicalKey": "REGULAR"
              }
            }
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type/city",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type/industrial_zone",
                "technicalKey": "INDUSTRIAL_ZONE"
              },
              "shortName": "Lukasstr. 4",
              "number": "4",
              "value": "Lukasstraße 4",
              "name": "Lukasstraße",
              "direction": "221-bis Baker Street, North",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "premises": [
            {
              "value": "Lukasstraße 4",
              "shortName": "Lukasstr. 4",
              "number": "4",
              "type": {
                "name": "Factory",
                "url": "https://meta.cdq.com/Address/premise/type/factory",
                "technicalKey": "FACTORY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type/mailbox",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              }
            }
          ],
          "geographicCoordinates": {
            "latitude": 47.439549,
            "longitude": 9.395275
          },
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type/legal",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ]
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
statusobject(Status)

Details about status or error of a service.

dataQualityConfirmationobject(DataQualityConfirmation)

Describes the outcome of data quality checks, including an overall decision and detailed reports of any issues found.

companyConfirmationobject(CompanyConfirmation)

Contains results of the company confirmation process, verifying the existence and registration details of the company against trusted databases.

qualificationConfirmationobject(QualificationConfirmation)

Outputs the results of identifier validation checks against official tax databases to ensure its validity.

sanctionComplianceConfirmationobject(ScreeningComplianceConfirmation)

Provides outcomes of checks against compliance lists like sanctions or watch lists to verify if the trading partner is compliant with regulatory standards.

Response
application/json
{
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-27T14:26:38Z"
  },
  "dataQualityConfirmation": {
    "decision": { … },
    "summary": { … },
    "details": { … }
  },
  "companyConfirmation": {
    "decision": { … },
    "summary": { … },
    "details": { … }
  },
  "qualificationConfirmation": {
    "decision": { … },
    "summary": { … },
    "details": { … }
  },
  "sanctionComplianceConfirmation": {
    "decision": { … },
    "summary": { … },
    "details": { … }
  }
}