Skip to content

Data Exchange API (5)

This API provides services to upload, manipulate and download businesspartner data in the CDL Cloud.

Overview
URL

https://www.cdq.ch/team

Michal Malinka

michal.malinka@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/data-exchange/soap/v5/

Production

https://api.corporate-data-league.ch/data-exchange/

Seed Updates

Manages operations such as creating, updating, or transforming Business Partner data to ensure that the information is current and accurate.

Operations

Analytics

Provides functionalities for analyzing and processing Business Partner data, enabling users to gain insights and perform various analytical operations on the data.

Business Partner Storages

Provides functionalities for creating, retrieving, updating and deleting Business Partner storage, as well as managing associated data sources and data monitors.

Operations

Business Partners

Provides functionalities for creating, retrieving, updating, and deleting Business Partner records, as well as performing various operations such as lookup and upsert.

Operations

Data Import

Provides functionalities for uploading external data and enabling users to enhance and update their Business Partner records with new information.

Operations

Data Mapping

Provides functionalities for defining and managing data mappings, enabling users to transform and map raw data into structured formats suitable for processing and analysis.

Operations

Data Monitors

Provides functionalities for creating, retrieving, updating and deleting data monitors.

Operations

Data Transformation

Provides functionalities for converting raw data into structured formats.

Operations

DNB Storages

Provides functionalities for creating, retrieving, updating and deleting DNB storage, as well as managing associated data sources and data monitors.

Operations

Files

Provides functionalities for uploading, downloading and deleting files.

Operations

Subscriptions

Provides functionalities for managing subscriptions.

Operations

Data Mappers

Provides functionalities for transforming raw data into structured Business Partner data using predefined data mapper definitions. This allows users to convert various data formats into a standardized format suitable for processing and analysis.

Operations

Relations

Manages relationships between Business Partners.

Operations

Update Classification

Operations

Classify Updates

Request

Fills tags and classifies Business Partner updates according to rules.

Order of property changes in the response is the same as in the request.

Security
basicAuth
Bodyapplication/jsonrequired
configurationIdstring(UpdateClassificationConfigurationId)

Update Classification Configuration Id.

Example: "123"
updatedBusinessPartnerobject(UpdatedBusinessPartner)required

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

updatedBusinessPartner.​idstring(BusinessPartnerId)

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
updatedBusinessPartner.​summaryobject(UpdateSummary)

Summarizes the applied updates for easy consumption.

updatedBusinessPartner.​namesArray of objects(UpdatedName)
updatedBusinessPartner.​legalFormobject(UpdatedLegalForm)

The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).

updatedBusinessPartner.​identifiersArray of objects(UpdatedIdentifier)
updatedBusinessPartner.​categoriesArray of objects(UpdatedBusinessPartnerCategory)
updatedBusinessPartner.​statusobject(UpdatedBusinessPartnerStatus)

A business partner status which contains also contextual information about applied updates.

updatedBusinessPartner.​addressesArray of objects(UpdatedAddress)
updatedBusinessPartner.​externalIdstring(BusinessPartnerExternalId)

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."
updatedBusinessPartner.​profileobject(UpdatedPartnerProfile)

A legal form which contains also contextual information about applied updates.

updatedBusinessPartner.​typesArray of objects(UpdatedBusinessPartnerType)
updatedBusinessPartner.​relationsArray of objects(UpdatedBusinessPartnerRelation)
updatedBusinessPartner.​jsonRecordobject(JsonRecord)

A JSON representation of the business partner record.

Example: "{\"key\":\"value\"}"
updatedBusinessPartner.​externalContextobject(UpdatedExternalContext)

Represents additional context information that is external to the main Business Partner data.

customRulesArray of objects(UpdateClassificationRule)

List of custom cleaners to be applied to the Business Partner.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v5/businesspartners/classifyUpdates \
  -H 'Content-Type: application/json' \
  -d '{
    "configurationId": "123",
    "updatedBusinessPartner": {
      "id": "63e635235c06b7396330fe40",
      "summary": {
        "tags": [
          "IDENTIFIER_ADDED"
        ],
        "classification": {
          "technicalKey": "MAJOR",
          "reason": "The modified post code has deprecated format."
        },
        "provenances": [
          {
            "name": "VIES",
            "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
            "technicalKey": "VIES",
            "cdqId": "VIES:PL8660001429",
            "subscribers": "50"
          }
        ]
      },
      "names": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/name/type",
            "name": "Local Name",
            "technicalKey": "LOCAL"
          },
          "value": "Corporate Data Quality AG",
          "shortName": "CDQ AG",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "details": [
            {
              "value": "Corporate Data Quality AG - Marketing Department",
              "type": {
                "name": "Legal Entity",
                "url": "https://meta.cdq.com/Business_partner/type",
                "technicalKey": "LEGAL_ENTITY"
              }
            }
          ],
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429",
                "subscribers": "50"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "type": {
                "url": "https://meta.cdq.com/Business_partner/name/type",
                "name": "Local Name",
                "technicalKey": "LOCAL"
              },
              "value": "Corporate Data Quality AG",
              "shortName": "CDQ AG",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "details": [
                {}
              ]
            }
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft",
        "url": "https://meta.cdq.com/Business_partner/legal_form",
        "technicalKey": "DE_9866",
        "language": {
          "name": "German",
          "technicalKey": "DE"
        },
        "mainAbbreviation": "AG",
        "categories": [
          {
            "name": "Limited Liability Company",
            "shortName": "LLC",
            "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
            "technicalKey": "LIMITED"
          }
        ],
        "updateAssessment": {
          "action": {
            "technicalKey": "ADDED"
          },
          "classification": {
            "technicalKey": "MAJOR",
            "reason": "The modified post code has deprecated format."
          },
          "provenances": [
            {
              "name": "VIES",
              "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
              "technicalKey": "VIES",
              "cdqId": "VIES:PL8660001429",
              "subscribers": "50"
            }
          ],
          "modifiedAt": "2020-08-31T16:47+00:00",
          "tags": [
            "IDENTIFIER_ADDED"
          ],
          "before": {
            "name": "Aktiengesellschaft",
            "url": "https://meta.cdq.com/Business_partner/legal_form",
            "technicalKey": "DE_9866",
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "mainAbbreviation": "AG",
            "categories": [
              {
                "name": "Limited Liability Company",
                "shortName": "LLC",
                "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
                "technicalKey": "LIMITED"
              }
            ]
          }
        }
      },
      "identifiers": [
        {
          "type": {
            "url": "https://meta.cdq.com/Business_partner/identifier/type",
            "name": "CH_VAT_ID",
            "technicalKey": "CH_VAT_ID"
          },
          "value": "CHE-218.608.886 HR/MWST",
          "issuingBody": {
            "name": "Amtsgericht Aachen",
            "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
            "technicalKey": "Amtsgericht Aachen",
            "jurisdiction": {
              "country": {
                "shortName": "CH",
                "value": "Switzerland"
              }
            }
          },
          "status": {
            "name": "ACTIVE",
            "technicalKey": "ACTIVE"
          },
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429",
                "subscribers": "50"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "type": {
                "url": "https://meta.cdq.com/Business_partner/identifier/type",
                "name": "CH_VAT_ID",
                "technicalKey": "CH_VAT_ID"
              },
              "value": "CHE-218.608.886 HR/MWST",
              "issuingBody": {
                "name": "Amtsgericht Aachen",
                "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
                "technicalKey": "Amtsgericht Aachen",
                "jurisdiction": {}
              },
              "status": {
                "name": "ACTIVE",
                "technicalKey": "ACTIVE"
              }
            }
          }
        }
      ],
      "categories": [
        {
          "name": "Hotel",
          "url": "https://meta.cdq.com/Business_partner/category",
          "technicalKey": "HOTEL",
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429",
                "subscribers": "50"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "name": "Hotel",
              "url": "https://meta.cdq.com/Business_partner/category",
              "technicalKey": "HOTEL"
            }
          }
        }
      ],
      "status": {
        "type": {
          "name": "In Liquidation",
          "url": "https://meta.cdq.com/Business_partner/status/type",
          "technicalKey": "IN_LIQUIDATION"
        },
        "officialDenotation": "Good Standing",
        "validFrom": "2022-02-26",
        "validUntil": "2022-02-26",
        "updateAssessment": {
          "action": {
            "technicalKey": "ADDED"
          },
          "classification": {
            "technicalKey": "MAJOR",
            "reason": "The modified post code has deprecated format."
          },
          "provenances": [
            {
              "name": "VIES",
              "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
              "technicalKey": "VIES",
              "cdqId": "VIES:PL8660001429",
              "subscribers": "50"
            }
          ],
          "modifiedAt": "2020-08-31T16:47+00:00",
          "tags": [
            "IDENTIFIER_ADDED"
          ],
          "before": {
            "type": {
              "name": "In Liquidation",
              "url": "https://meta.cdq.com/Business_partner/status/type",
              "technicalKey": "IN_LIQUIDATION"
            },
            "officialDenotation": "Good Standing",
            "validFrom": "2022-02-26",
            "validUntil": "2022-02-26"
          }
        }
      },
      "addresses": [
        {
          "version": {
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "characterSet": {
              "name": "International",
              "technicalKey": "INTERNATIONAL"
            }
          },
          "identifyingName": {
            "value": "John Doe"
          },
          "externalId": "1",
          "metadata": {
            "language": {
              "name": "German",
              "technicalKey": "DE"
            }
          },
          "careOf": {
            "value": "CDQ GmbH c/o Product Department"
          },
          "contexts": [
            {
              "value": "Production hall 7, Storage field 8."
            }
          ],
          "country": {
            "shortName": "CH",
            "value": "Switzerland",
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "shortName": "CH",
                "value": "Switzerland"
              }
            }
          },
          "administrativeAreas": [
            {
              "value": "Sankt Gallen",
              "shortName": "SG",
              "isoCode": "CH-SG",
              "type": {
                "name": "COUNTY",
                "url": "https://meta.cdq.com/Address/administrative_area/type",
                "technicalKey": "COUNTY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "postCodes": [
            {
              "value": "9000",
              "type": {
                "name": "Regular",
                "url": "https://meta.cdq.com/Address/post_code/type",
                "technicalKey": "REGULAR"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "localities": [
            {
              "type": {
                "name": "City",
                "url": "https://meta.cdq.com/Address/locality/type",
                "technicalKey": "CITY"
              },
              "shortName": "St. Gallen",
              "value": "Sankt Gallen",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "thoroughfares": [
            {
              "type": {
                "name": "Industrial zone",
                "url": "https://meta.cdq.com/Address/thoroughfare/type",
                "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"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "premises": [
            {
              "value": "Lukasstraße 4",
              "shortName": "Lukasstr. 4",
              "number": "4",
              "type": {
                "name": "Factory",
                "url": "https://meta.cdq.com/Address/premise/type",
                "technicalKey": "FACTORY"
              },
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "postalDeliveryPoints": [
            {
              "type": {
                "name": "Mailbox",
                "url": "https://meta.cdq.com/Address/postal_delivery_point/type",
                "technicalKey": "MAILBOX"
              },
              "shortName": "St Gallen, Postfach 460",
              "number": "460",
              "value": "Postfach",
              "language": {
                "name": "German",
                "technicalKey": "DE"
              },
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {}
              }
            }
          ],
          "geographicCoordinates": {
            "latitude": "47.439549",
            "longitude": "9.395275",
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "latitude": "47.439549",
                "longitude": "9.395275"
              }
            }
          },
          "types": [
            {
              "name": "Legal Address",
              "url": "https://meta.cdq.com/Address/type",
              "technicalKey": "LEGAL_ADDRESS"
            }
          ]
        }
      ],
      "externalId": "The ID managed in the customer'\''s SAP systems.",
      "profile": {
        "minorityIndicator": {
          "value": "Social enterprise"
        },
        "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",
              "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",
              "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",
              "technicalKey": "WEBSITE_TYPE_CORPORATE"
            }
          }
        ],
        "contactEmails": [
          {
            "value": "developer-portal@cdq.com"
          }
        ],
        "tags": [
          {
            "value": "Warehouse",
            "type": {
              "technicalKey": "WAREHOUSE"
            }
          }
        ],
        "vatPayerStatus": {
          "publicationDate": "2020-07-21T17:32:28Z",
          "status": {
            "name": "RELIABLE",
            "technicalKey": "VAT_PAYER_STATUS"
          },
          "registrationAuthority": {
            "registrationAuthorityId": "RA000009",
            "registrationAuthorityEntityId": "RA000009",
            "otherRegistrationAuthorityId": "RA000009"
          }
        },
        "hcpProfile": {
          "generalLicense": {
            "professionType": {
              "name": "Doctor",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
              "technicalKey": "DOCTOR"
            },
            "licenseStatus": {
              "name": "Granted",
              "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
              "technicalKey": "GRANTED"
            },
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "professionType": {},
                "licenseStatus": {}
              }
            }
          },
          "operationalPermissions": [
            {
              "issuingAuthority": "Swiss Medical Association",
              "permissionStatus": {
                "name": "Granted",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url",
                "technicalKey": "GRANTED"
              },
              "activityStatus": {
                "name": "Inactive",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url",
                "technicalKey": "INACTIVE"
              },
              "practiceLocations": [
                {}
              ],
              "updateAssessment": {
                "action": {},
                "classification": {},
                "provenances": [
                  null
                ],
                "modifiedAt": "2020-08-31T16:47+00:00",
                "tags": [
                  null
                ],
                "before": {
                  "practiceLocations": []
                }
              }
            }
          ]
        }
      },
      "types": [
        {
          "name": "Legal Entity",
          "url": "https://meta.cdq.com/Business_partner/type",
          "technicalKey": "LEGAL_ENTITY",
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429",
                "subscribers": "50"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "name": "Legal Entity",
              "url": "https://meta.cdq.com/Business_partner/type",
              "technicalKey": "LEGAL_ENTITY"
            }
          }
        }
      ],
      "relations": [
        {
          "startedAt": "2019-08-31T16:47+00:00",
          "endedAt": "2019-08-31T16:47+00:00",
          "type": {
            "name": "Commercial ultimate",
            "technicalKey": "COMMERCIAL_ULTIMATE",
            "url": "https://meta.cdq.com/Business_partner/relation/type"
          },
          "class": {
            "name": "CDQ Hierarchy",
            "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY",
            "url": "https://meta.cdq.com/Business_partner/relation/class"
          },
          "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": "2019-08-31T16:47+00:00",
          "updateAssessment": {
            "action": {
              "technicalKey": "ADDED"
            },
            "classification": {
              "technicalKey": "MAJOR",
              "reason": "The modified post code has deprecated format."
            },
            "provenances": [
              {
                "name": "VIES",
                "url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
                "technicalKey": "VIES",
                "cdqId": "VIES:PL8660001429",
                "subscribers": "50"
              }
            ],
            "modifiedAt": "2020-08-31T16:47+00:00",
            "tags": [
              "IDENTIFIER_ADDED"
            ],
            "before": {
              "startedAt": "2019-08-31T16:47+00:00",
              "endedAt": "2019-08-31T16:47+00:00",
              "type": {
                "name": "Commercial ultimate",
                "technicalKey": "COMMERCIAL_ULTIMATE",
                "url": "https://meta.cdq.com/Business_partner/relation/type"
              },
              "class": {
                "name": "CDQ Hierarchy",
                "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY",
                "url": "https://meta.cdq.com/Business_partner/relation/class"
              },
              "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": "2019-08-31T16:47+00:00"
            }
          }
        }
      ],
      "jsonRecord": "{\"key\":\"value\"}",
      "externalContext": {
        "identifiers": [
          {
            "value": "7250017031",
            "type": {
              "technicalKey": "KUNNR"
            },
            "updateAssessment": {
              "action": {
                "technicalKey": "ADDED"
              },
              "classification": {
                "technicalKey": "MAJOR",
                "reason": "The modified post code has deprecated format."
              },
              "provenances": [
                {}
              ],
              "modifiedAt": "2020-08-31T16:47+00:00",
              "tags": [
                "IDENTIFIER_ADDED"
              ],
              "before": {
                "value": "7250017031",
                "type": {}
              }
            }
          }
        ]
      }
    },
    "customRules": [
      {
        "url": "http://meta.cdq.com/Feature/data_clinic/update_classification/rule_000035",
        "technicalKey": "UPDATE_RULE_000035",
        "shortDescription": "Custom rule for classification",
        "targetConcepts": [
          "NAME"
        ],
        "conceptFilter": [
          "LOCAL_NAME"
        ],
        "countryShortNames": [
          "CH"
        ],
        "actions": [
          "ADDED"
        ],
        "ruleType": "FILTER",
        "filter": "REGEX_MATCH",
        "threshold": "[0.0 : 0.9)",
        "classification": "MAJOR",
        "configuration": "{}",
        "executionScope": "DEFAULT",
        "dataSourceTechnicalKeys": [
          "VIES"
        ],
        "dataSourceTechnicalKeysExclusions": [
          "VIES"
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
updatedBusinessPartnerobject(UpdatedBusinessPartner)

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

Response
application/json
{
  "updatedBusinessPartner": {
    "id": "63e635235c06b7396330fe40",
    "summary": { … },
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "addresses": [ … ],
    "externalId": "The ID managed in the customer's SAP systems.",
    "profile": { … },
    "types": [ … ],
    "relations": [ … ],
    "jsonRecord": "{\"key\":\"value\"}",
    "externalContext": { … }
  }
}

List Update Classification Rules

Request

Allows user to retrieve available update classification rules.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/updateclassification/rules

Responses

Successful operation

Bodyapplication/json
valuesArray of objects(UpdateClassificationRuleSearchResult)

List of update classification rules, each linked to customer-provided classification keys.

Response
application/json
{
  "values": [
    { … }
  ]
}

Transform Business Partner

Request

Transforms Business Partner to Property Changes. Order of property changes in the response is the same as in the request.

Security
basicAuth
Bodyapplication/jsonrequired
businessPartnersArray of objects(BusinessPartner)required

List of Business Partners.

businessPartners[].​idstring(BusinessPartnerId)

A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.

Example: "63e635235c06b7396330fe40"
businessPartners[].​createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
businessPartners[].​modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
businessPartners[].​externalIdstring(BusinessPartnerExternalId)

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."
businessPartners[].​dataSourcestring(BusinessPartnerDataSource)

Name or ID of a data source. Reflects the associated external system where the record originates from.

Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
businessPartners[].​disclosedboolean(BusinessPartnerDisclosed)

A flag to indicate whether the Business Partner should participate in the sharing or not. If 'true' this Business Partner might be used to create a new entry or update an existing entry in the community pool. Otherwise, it will not be considered for the sharing process. For more details, you can read about Sharing Scopes.

Example: "false"
businessPartners[].​updateMonitoringboolean(BusinessPartnerUpdateMonitoring)

A flag to indicate whether the Business Partner should receive updates from non-commercial Reference Data Sources or not. If 'true' this Business Partner will receive updates since the change from 'false'. If 'false' this Business Partner will not receive any new updates since the change. If not provided, the previous value will not be changed. By default, Update Monitoring is activated.

Example: "true"
businessPartners[].​updateCommercialMonitoringArray of objects(BusinessPartnerUpdateCommercialMonitoring)

Enabling update commercial monitoring has 2 possibilities:

  • via Data Mapper Definition: include mapping of updateCommercialMonitoring in the Data Mapper Definition
  • via direct Business Partner model upload: fill complete Business Partner model and updateCommercialMonitoring. Null/undefined updateCommercialMonitoring results in protection of this setup from the previous upsert. Empty or filled updateCommercialMonitoring results in data transition that may link or unlink to / from respective commercial Reference Data Source

Note: follow the approach that is currently used in your storage integration.

businessPartners[].​metadataobject(BusinessPartnerMetadata)

Information about results of Business Partner processing.

businessPartners[].​recordstring(BusinessPartnerRecord)

Stringified JSON of an individual Business Partner record. Characters: backslash \ and double quote " must be escaped (respectively: \\\\ and \"). Fields containing . are unallowed. Maximum size: 15MB.

Example: "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
businessPartners[].​additionalInformationArray of objects(AdditionalInformation)

List of additional information.

businessPartners[].​namesArray of objects(Name)

List of names.

businessPartners[].​legalFormobject(LegalForm)

The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).

businessPartners[].​identifiersArray of objects(Identifier)

List of Identifiers.

businessPartners[].​categoriesArray of objects(BusinessPartnerCategory)

List of Categories.

businessPartners[].​statusobject(BusinessPartnerStatus)

Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).

businessPartners[].​profileobject(PartnerProfile)

Additional documentation can be found here.

businessPartners[].​relationsArray of objects(BusinessPartnerRelation)

List of Relations. Insert or update Business Partner Relations. Relations that are not listed in the request and start in the current business partner, are marked as INACTIVE.

In D&B storages, only not listed relations of class D&B Hierarchy and one of type [https://meta.cdq.com/Business_partner/relation/type/direct_legal_relation](Direct Legal Relation), [https://meta.cdq.com/Business_partner/relation/type/domestic_legal_ultimate_relation](Domestic Legal Ultimate Relation) or [https://meta.cdq.com/Business_partner/relation/type/global_legal_ultimate_relation](Global Legal Ultimate Relation), are marked as INACTIVE.

businessPartners[].​typesArray of objects(BusinessPartnerType)

List of Types.

businessPartners[].​addressesArray of objects(Address)

List of Addresses.

businessPartners[].​bankAccountsArray of objects(BankAccount)

List of Bank Accounts.

businessPartners[].​externalContextobject(ExternalContext)

Represents additional context information that is external to the main Business Partner data.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v4/businesspartners/transformToPropertyChanges \
  -H 'Content-Type: application/json' \
  -d '{
    "businessPartners": [
      {
        "id": "63e635235c06b7396330fe40",
        "createdAt": "2020-08-31T16:47+00:00",
        "modifiedAt": "2020-08-31T16:47+00:00",
        "externalId": "The ID managed in the customer'\''s SAP systems.",
        "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
        "disclosed": "false",
        "updateMonitoring": "true",
        "updateCommercialMonitoring": [
          {
            "type": {
              "technicalKey": "DNB"
            },
            "value": "true"
          }
        ],
        "metadata": {
          "lastUpdatedAt": "2020-08-31T16:47+00:00",
          "lastSyncAt": "2020-02-11T00:00:00Z",
          "sharingStatus": {
            "status": "SHARED_WITH_NO_MATCH",
            "description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
          },
          "identityLinks": [
            {
              "linkId": "6465f2492bdcd350159a79d6",
              "cdqId": "VIES:PL8660001429",
              "addressId": "0",
              "externalAddressId": "123456789",
              "status": {
                "details": [
                  null
                ]
              }
            }
          ],
          "logResultStatuses": [
            {
              "processingLogId": "CURATION_LOG",
              "triggerProcessedAt": "2020-08-31T16:47+00:00",
              "triggerType": {
                "name": "CREATED",
                "technicalKey": "CREATED"
              },
              "trigger": {
                "processedAt": "2020-08-31T16:47+00:00",
                "provenance": {},
                "type": {}
              },
              "jobProcessedAt": "2020-08-31T16:47+00:00",
              "processedAt": "2020-08-31T16:47+00:00",
              "status": "INFO",
              "description": "Validation Level",
              "processingStatus": {
                "technicalKey": "IN_PROGRESS",
                "modifiedAt": "2020-08-31T16:47+00:00"
              },
              "previousProcessingStatus": {
                "technicalKey": "IN_PROGRESS",
                "modifiedAt": "2020-08-31T16:47+00:00"
              }
            }
          ],
          "decisionLogResult": {
            "reviewStatus": "REVIEWED",
            "naturalPersonsReviewStatus": "REVIEWED",
            "duplicatesReviewStatus": "REVIEWED"
          }
        },
        "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
        "additionalInformation": [
          {
            "key": "KEY",
            "value": "1"
          }
        ],
        "names": [
          {
            "type": {
              "url": "https://meta.cdq.com/Business_partner/name/type",
              "name": "Local Name",
              "technicalKey": "LOCAL"
            },
            "value": "Corporate Data Quality AG",
            "shortName": "CDQ AG",
            "language": {
              "name": "German",
              "technicalKey": "DE"
            },
            "details": [
              {
                "value": "Corporate Data Quality AG - Marketing Department",
                "type": {}
              }
            ]
          }
        ],
        "legalForm": {
          "name": "Aktiengesellschaft",
          "url": "https://meta.cdq.com/Business_partner/legal_form",
          "technicalKey": "DE_9866",
          "language": {
            "name": "German",
            "technicalKey": "DE"
          },
          "mainAbbreviation": "AG",
          "categories": [
            {
              "name": "Limited Liability Company",
              "shortName": "LLC",
              "url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
              "technicalKey": "LIMITED"
            }
          ]
        },
        "identifiers": [
          {
            "type": {
              "url": "https://meta.cdq.com/Business_partner/identifier/type",
              "name": "CH_VAT_ID",
              "technicalKey": "CH_VAT_ID"
            },
            "value": "CHE-218.608.886 HR/MWST",
            "issuingBody": {
              "name": "Amtsgericht Aachen",
              "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
              "technicalKey": "Amtsgericht Aachen",
              "jurisdiction": {
                "country": {}
              }
            },
            "status": {
              "name": "ACTIVE",
              "technicalKey": "ACTIVE"
            }
          }
        ],
        "categories": [
          {
            "name": "Hotel",
            "url": "https://meta.cdq.com/Business_partner/category",
            "technicalKey": "HOTEL"
          }
        ],
        "status": {
          "type": {
            "name": "In Liquidation",
            "url": "https://meta.cdq.com/Business_partner/status/type",
            "technicalKey": "IN_LIQUIDATION"
          },
          "officialDenotation": "Good Standing",
          "validFrom": "2022-02-26",
          "validUntil": "2022-02-26"
        },
        "profile": {
          "minorityIndicator": {
            "value": "Social enterprise"
          },
          "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",
                "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",
                "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",
                "technicalKey": "WEBSITE_TYPE_CORPORATE"
              }
            }
          ],
          "contactEmails": [
            {
              "value": "developer-portal@cdq.com"
            }
          ],
          "tags": [
            {
              "value": "Warehouse",
              "type": {
                "technicalKey": "WAREHOUSE"
              }
            }
          ],
          "vatPayerStatus": {
            "publicationDate": "2020-07-21T17:32:28Z",
            "status": {
              "name": "RELIABLE",
              "technicalKey": "VAT_PAYER_STATUS"
            },
            "registrationAuthority": {
              "registrationAuthorityId": "RA000009",
              "registrationAuthorityEntityId": "RA000009",
              "otherRegistrationAuthorityId": "RA000009"
            }
          },
          "hcpProfile": {
            "generalLicense": {
              "professionType": {
                "name": "Doctor",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
                "technicalKey": "DOCTOR"
              },
              "licenseStatus": {
                "name": "Granted",
                "url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
                "technicalKey": "GRANTED"
              }
            },
            "operationalPermissions": [
              {
                "issuingAuthority": "Swiss Medical Association",
                "permissionStatus": {},
                "activityStatus": {},
                "practiceLocations": [
                  null
                ]
              }
            ]
          }
        },
        "relations": [
          {
            "startedAt": "2019-08-31T16:47+00:00",
            "endedAt": "2019-08-31T16:47+00:00",
            "type": {
              "name": "Commercial ultimate",
              "technicalKey": "COMMERCIAL_ULTIMATE",
              "url": "https://meta.cdq.com/Business_partner/relation/type"
            },
            "class": {
              "name": "CDQ Hierarchy",
              "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY",
              "url": "https://meta.cdq.com/Business_partner/relation/class"
            },
            "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": "2019-08-31T16:47+00:00"
          }
        ],
        "types": [
          {
            "name": "Legal Entity",
            "url": "https://meta.cdq.com/Business_partner/type",
            "technicalKey": "LEGAL_ENTITY"
          }
        ],
        "addresses": [
          {
            "id": "0001",
            "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",
                "shortName": "SG",
                "isoCode": "CH-SG",
                "type": {},
                "language": {}
              }
            ],
            "postCodes": [
              {
                "value": "9000",
                "type": {}
              }
            ],
            "localities": [
              {
                "type": {},
                "shortName": "St. Gallen",
                "value": "Sankt Gallen",
                "language": {}
              }
            ],
            "thoroughfares": [
              {
                "type": {},
                "shortName": "Lukasstr. 4",
                "number": "4",
                "value": "Lukasstraße 4",
                "name": "Lukasstraße",
                "direction": "221-bis Baker Street, North",
                "language": {}
              }
            ],
            "premises": [
              {
                "value": "Lukasstraße 4",
                "shortName": "Lukasstr. 4",
                "number": "4",
                "type": {},
                "language": {}
              }
            ],
            "postalDeliveryPoints": [
              {
                "type": {},
                "shortName": "St Gallen, Postfach 460",
                "number": "460",
                "value": "Postfach",
                "language": {}
              }
            ],
            "geographicCoordinates": {
              "latitude": "47.439549",
              "longitude": "9.395275"
            },
            "types": [
              {
                "name": "Legal Address",
                "url": "https://meta.cdq.com/Address/type",
                "technicalKey": "LEGAL_ADDRESS"
              }
            ]
          }
        ],
        "bankAccounts": [
          {
            "internationalBankAccountIdentifier": "CH8800781619278412000",
            "internationalBankIdentifier": "KBSGCH22XXX",
            "nationalBankAccountIdentifier": "619278412000",
            "nationalBankIdentifier": "00781",
            "countryCode": "DE",
            "vendorPaymentSummary": {
              "firstPaymentDate": "2020-08-31T16:47+00:00",
              "lastPaymentDate": "2020-08-31T16:47+00:00",
              "numberOfPayments": "1"
            }
          }
        ],
        "externalContext": {
          "identifiers": [
            {
              "value": "7250017031",
              "type": {
                "technicalKey": "KUNNR"
              }
            }
          ]
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
resultsArray of objects(TransformToPropertyChangesResult)

List of results.

Response
application/json
{
  "results": [
    { … }
  ]
}

Event Stores

Operations

Business Partner Storages (None Public)

Operations

Restart Monitor Job

Operations

Cache

Operations

Configuration

Operations

Event Store

Operations

CDQ Community Pool

Operations