Create Bulk Fetch

Business Partners

Everything about Business Partners

Operations

Analytics

Everything about reference data analytics

Registrations

Addresses

Everything about Addresses

Bulk Fetch

Operations

Create Bulk Fetch

Request

Create a bulk to fetch multiple business partners at a time.

Read more about Golden Record here

Security

apiKey

Bodyapplication/jsonrequired

featuresOnArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be activated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

featuresOffArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be deactivated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

screeningMatchingThresholdnumber

The matching threshold. When not set then all entries are taken into consideration.

Example: "0.8"

configurationIdstring(ReferenceDataFetchConfigurationId)

Configuration ID used to set up fetch. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

screeningMatchingThreshold
featuresOn
featuresOff

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

tasksArray of objects(BusinessPartnerFetchTask)[ 1 .. 1000 ] itemsrequired

List of tasks to be executed.

tasks[].cdqIdstring

CDQ ID for Business Partner and address.

Example: "VIES:DE123456789"

tasks[].businessPartnerobject(BusinessPartnerParam)

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.

tasks[].idstring(TaskId)

Unique identifier for a task.

Example: "dc172630-5791-11ee-8c99-0242ac120002"

tasks[].externalIdstring(TaskExternalId)

Unique identifier provided by a customer to identify a task.

Example: "id-customer-123"

curl -i -X POST \
  https://api.cdq.com/referencedata/rest/v4/businesspartners/fetch/bulks \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "featuresOn": [
      "SHOW_DEBUG_INFO"
    ],
    "tasks": [
      {
        "id": "42010AEF0CEB1EEEACF7ECD80452F903__-/-",
        "businessPartner": {
          "jsonRecord": {
            "addressData": [
              {
                "organizationPostalAddress": {
                  "country": {
                    "code": "DE"
                  },
                  "postCode": "69190",
                  "houseNumber": "16",
                  "street": {
                    "name": "Dietmar-Hopp-Allee"
                  },
                  "primaryRegion": {
                    "code": "08"
                  },
                  "town": {
                    "name": "Walldorf"
                  }
                }
              }
            ],
            "businessPartnerType": "organization",
            "identifications": [
              {
                "identificationType": {
                  "code": "BUP002"
                },
                "identificationNumber": "HRB 719915",
                "entryDateVc": "-",
                "country": {
                  "code": "DE"
                },
                "institute": "Local Court Mannheim",
                "validFrom": "2024-01-15",
                "validTo": "9999-12-31"
              },
              {
                "identificationType": {
                  "code": "DPI001"
                },
                "identificationNumber": "GR.LEI:529900PM64WH8AF1E917HQ",
                "entryDateVc": "-",
                "validFrom": "2024-01-15",
                "validTo": "9999-12-31"
              }
            ],
            "organization": {
              "nameDetails": {
                "formattedOrgNameLine1": "SAP SE",
                "formattedOrgName": "SAP SE"
              }
            },
            "taxNumbers": [
              {
                "taxNumberType": {
                  "code": "DE0"
                },
                "taxNumber": "DE143454214"
              }
            ]
          }
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json

idstring(BulkId)required

Unique identifier for a set of bulk tasks.

Example: "650b12ac-3768-11ee-be56-0242ac120002"

createdAtstring(CreatedAt)required

Date of creation (ISO 8601-compliant).

Example: "2025-08-15T11:08:44Z"

finishedAtstring(FinishedAt)

Date of finish (ISO 8601-compliant).

Example: "2025-08-15T11:08:44Z"

createdBystring(CreatedBy)required

Creator of a resource.

Example: "76248934691294444"

statusobject(Status)required

Details about status or error of a service

status.codeinteger(HttpStatusCode)required

RFC 7231 status code for this error.

Example: "400"

status.technicalKeystring(HttpStatusTechnicalKey)required

Technical key describing the status or error

Example: "OK"

status.detailsArray of objects(StatusDetails)

status.pathstring(HttpPath)

Requested path which caused this error.

Example: "/v2/businesspartners/lookup"

status.timestampstring(StatusTimestamp)

ISO 8601 representation of the timestamp.

Example: "2025-08-15T11:08:44Z"

progressinteger(BulkProgress)[ 0 .. 100 ]

Progress (%) of the bulk execution.

Example: "77"

featuresOnArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be activated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

featuresOffArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be deactivated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

screeningMatchingThresholdnumber

The matching threshold. When not set then all entries are taken into consideration.

Example: "0.8"

configurationIdstring(ReferenceDataFetchConfigurationId)

Configuration ID used to set up fetch. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

screeningMatchingThreshold
featuresOn
featuresOff

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

resultsArray of objects(BusinessPartnerFetchBulkResult)

List of results of the bulk fetch.

nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"

Response

application/json

{
  "id": "650b12ac-3768-11ee-be56-0242ac120002",
  "createdAt": "2025-08-15T11:08:44Z",
  "finishedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444",
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-15T11:08:44Z"
  },
  "progress": "77",
  "featuresOn": [
    "SHOW_RAW_DATA"
  ],
  "featuresOff": [
    "SHOW_RAW_DATA"
  ],
  "screeningMatchingThreshold": "0.8",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "results": [
    { … }
  ],
  "nextStartAfter": "5712566172571652"
}

Read Bulk Fetch

Request

Read results for fetch bulk.

Security

apiKey

Path

idstringrequired

Unique identifier for a bulk.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957

Query

limitinteger(int32)[ 1 .. 1000 ]

Number of items to be returned on the page.

Default 100

Example: limit=20

startAfterstring

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Default "0"

Example: startAfter=16

curl -i -X GET \
  https://api.cdq.com/referencedata/rest/v4/businesspartners/fetch/bulks/cbed7ac6-a97d-4c23-9060-2a88fa660957 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idstring(BulkId)required

Unique identifier for a set of bulk tasks.

Example: "650b12ac-3768-11ee-be56-0242ac120002"

createdAtstring(CreatedAt)required

Date of creation (ISO 8601-compliant).

Example: "2025-08-15T11:08:44Z"

finishedAtstring(FinishedAt)

Date of finish (ISO 8601-compliant).

Example: "2025-08-15T11:08:44Z"

createdBystring(CreatedBy)required

Creator of a resource.

Example: "76248934691294444"

statusobject(Status)required

Details about status or error of a service

status.codeinteger(HttpStatusCode)required

RFC 7231 status code for this error.

Example: "400"

status.technicalKeystring(HttpStatusTechnicalKey)required

Technical key describing the status or error

Example: "OK"

status.detailsArray of objects(StatusDetails)

status.pathstring(HttpPath)

Requested path which caused this error.

Example: "/v2/businesspartners/lookup"

status.timestampstring(StatusTimestamp)

ISO 8601 representation of the timestamp.

Example: "2025-08-15T11:08:44Z"

progressinteger(BulkProgress)[ 0 .. 100 ]

Progress (%) of the bulk execution.

Example: "77"

featuresOnArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be activated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

featuresOffArray of strings(BusinessPartnerFetchFeatureEnum)

List of features to be deactivated.

Items Enum Value	Description
ENABLE_SETTINGS	Apply rules stored in organizational settings during curation.
SHOW_DEBUG_INFO	Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.
SHOW_RAW_DATA	Show raw data returned by external service.
SHOW_RAW_DATA_JSON	Show raw data returned by external service in JSON format.
FORCE_EXTERNAL_CALL	Call external service even when results from data mirrors are available.
SCREEN_BUSINESS_NAMES	Add `screeningResult` to the Business Partner.
SHOW_COMMERCIAL_ULTIMATE	Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE	Fetch Domestic Commercial Ultimate from DNB. `ACTIVATE_DATASOURCE_DNB`, `ACTIVATE_MASTER_DATA_EXTENDED` or `ACTIVATE_MASTER_DATA_LNKG` must be active if you want to calculate DNB commercial ultimate.
DETECT_LEGAL_ENTITY	<b style="color: white; background: #077fbb; border-radius: 5px; margin-left: 0; padding: 2px 10px; font-size: 14px; vertical-align: super;">BETA</b><br>Finds out whether requested DUNS is a branch or headquarter.
ACTIVATE_DATASOURCE_BVD	Allows to use DVB datasource in golden record.

Example: ["SHOW_RAW_DATA"]

screeningMatchingThresholdnumber

The matching threshold. When not set then all entries are taken into consideration.

Example: "0.8"

configurationIdstring(ReferenceDataFetchConfigurationId)

Configuration ID used to set up fetch. If provided, those parameters will be affected. If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):

screeningMatchingThreshold
featuresOn
featuresOff

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

resultsArray of objects(BusinessPartnerFetchBulkResult)

List of results of the bulk fetch.

nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"

Response

application/json

{
  "id": "650b12ac-3768-11ee-be56-0242ac120002",
  "createdAt": "2025-08-15T11:08:44Z",
  "finishedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444",
  "status": {
    "code": "400",
    "technicalKey": "OK",
    "details": [ … ],
    "path": "/v2/businesspartners/lookup",
    "timestamp": "2025-08-15T11:08:44Z"
  },
  "progress": "77",
  "featuresOn": [
    "SHOW_RAW_DATA"
  ],
  "featuresOff": [
    "SHOW_RAW_DATA"
  ],
  "screeningMatchingThreshold": "0.8",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "results": [
    { … }
  ],
  "nextStartAfter": "5712566172571652"
}

Bulk Lookup

Operations

Cancel Bulk

Operations

Batch Lookup

Operations

Configurations

Operations

Configuration

Operations

Referencedata API (4)

Business Partners

Analytics

Registrations

Addresses

Bulk Fetch

Create Bulk Fetch

Request

Responses

Share the feedback!

Read Bulk Fetch

Request

Responses

Share the feedback!

Bulk Lookup

Cancel Bulk

Batch Lookup

Configurations

Configuration

Referencedata API (4)

Business Partners

Analytics

Registrations

Addresses

Bulk Fetch

Create Bulk Fetch

RequestExpand all

Responses

Share the feedback!

Read Bulk Fetch

Request

Responses

Share the feedback!

Bulk Lookup

Cancel Bulk

Batch Lookup

Configurations

Configuration

Request