Business Partner Storages

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.

Operations

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

Update Storage

Request

Update a Business Partner Storage.

Security

apiKey

Path

storageIdstring(BusinessPartnerStorageId)required

Unique ID of a Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Bodyapplication/jsonrequired

namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"

labelsArray of strings(StorageLabels)<= 10 itemsunique

List of Storages labels.

Example: ["Custom Storage Name"]

dataMatchingDefinitionIdstring(DataMatchingDefinitionId)

ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.

Example: "6400955811c68a034bcef311"

sharedWithOrganizationboolean(SharedWithOrganization)

Indicates if this Business Partner Storage is shared with all users of the same organization

Example: "true"

curl -i -X PUT \
  https://api.cdq.com/data-exchange/rest/storages/72d6900fce6b326088f5d9d91049e3e6 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "CDQ AG",
    "labels": [
      "Custom Storage Name"
    ],
    "dataMatchingDefinitionId": "6400955811c68a034bcef311",
    "sharedWithOrganization": "true"
  }'

Responses

OK

Bodyapplication/json

idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"

namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"

eventStoreIdstring(EventStoreId)

Internal ID of Event Store.

Example: "72d6900fce6b326123f5d9d91049e3e6"

decisionLogIdstring(DecisionLogId)

ID of related decision log.

Example: "72d6900fc3wb326088f5d9d91044e3e6"

organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"

userstring(UserId)

Unique ID of a user.

Example: "johndoe"

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"

expiresAtstring

Date when storage expires.

Possible values:

a date when a storage expires,
NEVER when storage is a Data Mirror or has been created including NEVER_EXPIRE feature.

Expiry date is calculated based on the date of last write operation related to a storage (upsert of data, update of data sources, executed job) plus 6 months, refreshed as most 2 weeks before previous storage expiration date.

Example: "2025-08-19T06:23:16Z"

dataMatchingDefinitionIdstring(DataMatchingDefinitionId)

ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.

Example: "6400955811c68a034bcef311"

dataSourcesArray of objects(DataSource)

List of Data Sources.

dataMonitorsArray of objects(DataMonitor)

List of data monitors.

featuresobject

Features of a storage.

numberOfCountriesinteger(int64)(NumberOfCountries)

Number of countries in the Business Partner Storage.

Example: "12"

numberOfRecordsinteger(int64)(NumberOfRecords)

Number of records in the Business Partner Storage.

Example: "500"

countryStatisticsArray of objects(CountryStatistic)

originalFileHeaderArray of strings

List of headers used for a modification of metadata.

Example: ["BusinessPartnerId, Name, Address"]

originalFileNamestring(OriginalFileName)

Name of the last file that was used to import data into this Business Partner Storage.

Example: "business-partner.csv"

resultsobject(Results)

Results of a Business Partner Storage.

statusstring(StorageMetadataStatus)

Status of a Business Partner Storage.

Example: "FILE_IMPORTED_SUCCESSFULLY"

statusMessagestring(StorageMetadataStatusMessage)

Details related to status.

Example: "BusinessPartner batch could not be upserted into Business Partner Storage."

sharedWithOrganizationboolean(SharedWithOrganization)

Indicates if this Business Partner Storage is shared with all users of the same organization

Example: "true"

labelsArray of strings(StorageLabels)<= 10 itemsunique

Labels to categorize the storage.

Example: ["Custom Storage Name"]

domainstring(Domain)Deprecated

Domain of a Business Partner Storage.

Example: "BusinessPartner"

Response

application/json

{
  "id": "648824a691d8d2503d65103e",
  "name": "CDQ AG",
  "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
  "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
  "domain": "BusinessPartner",
  "organization": "cdq_monitor",
  "user": "johndoe",
  "createdAt": "2025-08-19T06:23:16Z",
  "expiresAt": "2025-08-19T06:23:16Z",
  "dataMatchingDefinitionId": "6400955811c68a034bcef311",
  "dataSources": [
    { … }
  ],
  "dataMonitors": [
    { … }
  ],
  "features": {
    "lookup": { … },
    "updates": { … },
    "sharing": { … },
    "neverExpire": { … },
    "tagsManagedByUpsert": { … }
  },
  "numberOfCountries": "12",
  "numberOfRecords": "500",
  "countryStatistics": [
    { … }
  ],
  "originalFileHeader": [
    "BusinessPartnerId, Name, Address"
  ],
  "originalFileName": "business-partner.csv",
  "results": {
    "addressCurationReports": [ … ],
    "goldenRecordGenerationReports": [ … ],
    "resultItems": [ … ],
    "validationReports": [ … ]
  },
  "status": "FILE_IMPORTED_SUCCESSFULLY",
  "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
  "sharedWithOrganization": "true",
  "labels": [
    "Custom Storage Name"
  ]
}

Delete Storage

Request

Delete a Business Partner Storage.

Security

apiKey

Path

storageIdstring(BusinessPartnerStorageId)required

Unique ID of a Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

curl -i -X DELETE \
  https://api.cdq.com/data-exchange/rest/storages/72d6900fce6b326088f5d9d91049e3e6 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Read Storage

Request

Read metadata of a storage.

Security

apiKey

Path

storageIdstring(BusinessPartnerStorageId)required

Unique ID of a Business Partner Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Query

featuresOnArray of strings

Features to be activated during reading the metadata.

Items Enum Value	Description
WITH_COUNTRY_STATISTICS	Recalculates and retrieves country statistics information.
ONLY_ISO_COUNTRY_STATISTICS	Forces only valid ISO 3166-2 country codes.

Example: featuresOn=WITH_COUNTRY_STATISTICS

dataSourcestring(BusinessPartnerDataSource)

Data Source (name or ID) to be measured during calculating statistics. By default, all Data Sources are measured.

Example: dataSource="CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e"

curl -i -X GET \
  https://api.cdq.com/data-exchange/rest/v2/storages/72d6900fce6b326088f5d9d91049e3e6 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idstring(BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"

namestring(BusinessPartnerStorageName)<= 100 characters

Name of the Business Partner Storage.

Example: "CDQ AG"

eventStoreIdstring(EventStoreId)

Internal ID of Event Store.

Example: "72d6900fce6b326123f5d9d91049e3e6"

decisionLogIdstring(DecisionLogId)

ID of related decision log.

Example: "72d6900fc3wb326088f5d9d91044e3e6"

organizationstring(OrganizationId)

Uniquely identifying ID of the organization.

Example: "cdq_monitor"

userstring(UserId)

Unique ID of a user.

Example: "johndoe"

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-19T06:23:16Z"

expiresAtstring

Date when storage expires.

Possible values:

a date when a storage expires,
NEVER when storage is a Data Mirror or has been created including NEVER_EXPIRE feature.

Expiry date is calculated based on the date of last write operation related to a storage (upsert of data, update of data sources, executed job) plus 6 months, refreshed as most 2 weeks before previous storage expiration date.

Example: "2025-08-19T06:23:16Z"

dataMatchingDefinitionIdstring(DataMatchingDefinitionId)

ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.

Example: "6400955811c68a034bcef311"

dataSourcesArray of objects(DataSource)

List of Data Sources.

dataMonitorsArray of objects(DataMonitor)

List of data monitors.

featuresobject

Features of a storage.

numberOfCountriesinteger(int64)(NumberOfCountries)

Number of countries in the Business Partner Storage.

Example: "12"

numberOfRecordsinteger(int64)(NumberOfRecords)

Number of records in the Business Partner Storage.

Example: "500"

countryStatisticsArray of objects(CountryStatistic)

originalFileHeaderArray of strings

List of headers used for a modification of metadata.

Example: ["BusinessPartnerId, Name, Address"]

originalFileNamestring(OriginalFileName)

Name of the last file that was used to import data into this Business Partner Storage.

Example: "business-partner.csv"

resultsobject(Results)

Results of a Business Partner Storage.

statusstring(StorageMetadataStatus)

Status of a Business Partner Storage.

Example: "FILE_IMPORTED_SUCCESSFULLY"

statusMessagestring(StorageMetadataStatusMessage)

Details related to status.

Example: "BusinessPartner batch could not be upserted into Business Partner Storage."

sharedWithOrganizationboolean(SharedWithOrganization)

Indicates if this Business Partner Storage is shared with all users of the same organization

Example: "true"

labelsArray of strings(StorageLabels)<= 10 itemsunique

Labels to categorize the storage.

Example: ["Custom Storage Name"]

domainstring(Domain)Deprecated

Domain of a Business Partner Storage.

Example: "BusinessPartner"

Response

application/json

{
  "id": "648824a691d8d2503d65103e",
  "name": "CDQ AG",
  "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
  "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
  "domain": "BusinessPartner",
  "organization": "cdq_monitor",
  "user": "johndoe",
  "createdAt": "2025-08-19T06:23:16Z",
  "expiresAt": "2025-08-19T06:23:16Z",
  "dataMatchingDefinitionId": "6400955811c68a034bcef311",
  "dataSources": [
    { … }
  ],
  "dataMonitors": [
    { … }
  ],
  "features": {
    "lookup": { … },
    "updates": { … },
    "sharing": { … },
    "neverExpire": { … },
    "tagsManagedByUpsert": { … }
  },
  "numberOfCountries": "12",
  "numberOfRecords": "500",
  "countryStatistics": [
    { … }
  ],
  "originalFileHeader": [
    "BusinessPartnerId, Name, Address"
  ],
  "originalFileName": "business-partner.csv",
  "results": {
    "addressCurationReports": [ … ],
    "goldenRecordGenerationReports": [ … ],
    "resultItems": [ … ],
    "validationReports": [ … ]
  },
  "status": "FILE_IMPORTED_SUCCESSFULLY",
  "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
  "sharedWithOrganization": "true",
  "labels": [
    "Custom Storage Name"
  ]
}

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

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

Subscriptions

Operations

Data Exchange API (5)

Seed Updates

Analytics

Business Partner Storages

Update Storage

Request

Responses

Share the feedback!

Delete Storage

Request

Responses

Share the feedback!

Read Storage

Request

Responses

Share the feedback!

Business Partners

Data Import

Data Mapping

Data Monitors

Data Transformation

DNB Storages

Files

Data Mappers

Relations

Subscriptions