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

Event Stores

Operations

Business Partner Storages (None Public)

Operations

Restart Monitor Job

Operations

Identity Link

Request

Creates and updates identity links for all CDQ IDs provided in the request for the organization of the user. A CDQ ID always refers to a Business Partner and a specific address.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
businessPartnerIdstring(BusinessPartnerId)

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

Example: "63e635235c06b7396330fe40"
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
addressIdstring

Unique identifier for the address which was used for the linkage in the POOL.

Example: "0"
addressVersionobject(BusinessPartnerIdentityLinkAddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

externalBusinessPartnerIdstring(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."
externalAddressIdstring(AddressExternalId)

ID the address has in the external system where the record originates from.

Example: "1"
cdqIdstring

Unique identifier for the Business Partner.

Example: "VIES:PL8660001429"
referenceAddressVersionobject(BusinessPartnerIdentityLinkAddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

overAllConfidenceScorenumber(double)

Overall confidence score of the linkage.

Example: "0.9"
businessPartnerConfidenceScorenumber(double)

Confidence score of the linkage for the Business Partner.

Example: "0.9"
addressConfidenceScorenumber(double)

Confidence score of the linkage for the Address.

Example: "0.9"
matchingExplanationstring

Explanation for matching score value.

Example: "{'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}"
cdqBusinessPartnerIdstringDeprecated

Unique identifier for the Business Partner in the CDQ POOL.

Example: "VIES:PL8660001429"
cdqAddressIdstringDeprecated

Unique identifier for the address which was used for the linkage in the POOL.

Example: "0"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/businesspartners/identitylinks \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "organization": "cdq_monitor",
    "storageId": "72d6900fce6b326088f5d9d91049e3e6",
    "businessPartnerId": "63e635235c06b7396330fe40",
    "dataSourceId": "648824a691d8d2503d65103e",
    "addressId": "0",
    "addressVersion": {
      "languageTechnicalKey": "DE",
      "characterSetTechnicalKey": "INTERNATIONAL"
    },
    "externalBusinessPartnerId": "The ID managed in the customer'\''s SAP systems.",
    "externalAddressId": "1",
    "cdqBusinessPartnerId": "VIES:PL8660001429",
    "cdqAddressId": "0",
    "cdqId": "VIES:PL8660001429",
    "referenceAddressVersion": {
      "languageTechnicalKey": "DE",
      "characterSetTechnicalKey": "INTERNATIONAL"
    },
    "overAllConfidenceScore": "0.9",
    "businessPartnerConfidenceScore": "0.9",
    "addressConfidenceScore": "0.9",
    "matchingExplanation": "{'\''BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'\''}"
  }'

Responses

OK

Bodyapplication/json
idstring

Unique identifier of the linkage.

Example: "CDQ.POOL:5E580DD08E8B454820E8F67E0"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
storageIdstring(BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
businessPartnerIdstring(BusinessPartnerId)

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

Example: "63e635235c06b7396330fe40"
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"
referenceBusinessPartnerIdstring

ID of monitored Business Partner within own Storage. Null for reference Data Sources like VIES, LEI.

Example: "VIES:ATU12345678"
addressIdstring

Unique identifier for the address which was used for the linkage in the POOL.

Example: "0"
addressVersionobject(BusinessPartnerIdentityLinkAddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

externalBusinessPartnerIdstring(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."
externalAddressIdstring(AddressExternalId)

ID the address has in the external system where the record originates from.

Example: "1"
referenceAddressVersionobject(BusinessPartnerIdentityLinkAddressVersion)

CDQ supports multiple versions of addresses comprising different charsets and languages. An address version is a unique combination of a character set and a language.

cdqIdstring

Unique identifier for the Business Partner.

Example: "VIES:PL8660001429"
linkageParameterobject(BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

linkageStatusstring(LinkageStatus)

Status of the linkage:

  • SUCCESSFULLY_LINKED - Country and identifier exists, result found by lookup and contains cdqId. Link created.
  • MISSING_INFORMATION_FOR_LINKAGE - Missing country or information for linkage strategy.
  • NO_MATCH_FOUND - No result from lookup.
  • NO_CONFIDENT_MATCH_FOUND - No confident result from lookup.
  • NO_MATCH_ADDRESS_VERSION - Result found in lookup but address version doesn’t match.
  • UNDER_CONSIDERATION - Linkage is under consideration.
  • PROCESS_ISSUE - Internal issues or issues with reference data sources.
  • QUOTA_LIMIT - The customer doesn’t have enough quota.
  • INACTIVE_SOURCE - Reference Data source is not activated for the organization or credentials are not provided.
  • ERRONEOUS_IDENTIFIER - Business Partner didn’t pass the validation due to an incorrect identifier.
  • EXTERNAL_SERVICE_NOT_AVAILABLE - Lookup would succeed if external service was available.
Example: "SUCCESSFULLY_LINKED"
statusobject(LinkStatus)

Details about status or error of a service

referenceDataSourcestring

Data Source of the Business Partner which was used for the linkage in the POOL.

Example: "VIES"
storageDataSourceobject(BusinessPartnerIdentityLinkDataSource)

Data Source of the Business Partner which was used for the linkage in the POOL.

Response
application/json
{
  "id": "CDQ.POOL:5E580DD08E8B454820E8F67E0",
  "createdAt": "2020-08-31T16:47+00:00",
  "organization": "cdq_monitor",
  "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  "businessPartnerId": "63e635235c06b7396330fe40",
  "dataSourceId": "648824a691d8d2503d65103e",
  "referenceBusinessPartnerId": "VIES:ATU12345678",
  "addressId": "0",
  "addressVersion": {
    "languageTechnicalKey": "DE",
    "characterSetTechnicalKey": "INTERNATIONAL"
  },
  "externalBusinessPartnerId": "The ID managed in the customer's SAP systems.",
  "externalAddressId": "1",
  "referenceAddressVersion": {
    "languageTechnicalKey": "DE",
    "characterSetTechnicalKey": "INTERNATIONAL"
  },
  "cdqId": "VIES:PL8660001429",
  "linkageParameter": {
    "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": [ … ],
    "metadata": { … },
    "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
    "additionalInformation": [ … ],
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "categories": [ … ],
    "status": { … },
    "profile": { … },
    "relations": [ … ],
    "types": [ … ],
    "addresses": [ … ],
    "bankAccounts": [ … ],
    "externalContext": { … }
  },
  "linkageStatus": "SUCCESSFULLY_LINKED",
  "status": {
    "details": [ … ]
  },
  "referenceDataSource": "VIES",
  "storageDataSource": {
    "id": "648824a691d8d2503d65103e"
  }
}

Cache

Operations

Configuration

Operations

Event Store

Operations

CDQ Community Pool

Operations