List Fetch Configurations

Business Partners

Everything about Business Partners

Operations

Analytics

Everything about reference data analytics

Registrations

Addresses

Everything about Addresses

Bulk Fetch

Operations

Bulk Lookup

Operations

Cancel Bulk

Operations

Batch Lookup

Operations

Configurations

Operations

List Fetch Configurations

Request

List all fetch configurations of the current user.

Security

apiKey

Query

startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652

limitinteger(Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100

defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true

curl -i -X GET \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(WorkspaceConfigurationSearchResult)

List of workspace configurations.

Response

application/json

{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Create Fetch Configuration

Request

Create a new fetch configuration for the current user.

Security

apiKey

Bodyapplication/json

workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

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

namestring(ConfigurationName)required

Display name for a configuration.

Example: "Client configuration."

configurationobject(FetchConfigurationModel)required

The configuration for the Business Partner fetch.

configuration.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"]

configuration.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"]

configuration.screeningMatchingThresholdnumber

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

Example: "0.8"

curl -i -X POST \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
    "name": "Client configuration.",
    "configuration": {
      "featuresOn": [
        "SHOW_RAW_DATA"
      ],
      "featuresOff": [
        "SHOW_RAW_DATA"
      ],
      "screeningMatchingThreshold": "0.8"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Read Fetch Configuration

Request

Read a fetch configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

curl -i -X GET \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Update Fetch Configuration

Request

Update a fetch configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

Bodyapplication/json

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

curl -i -X PUT \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Client configuration.",
    "configuration": {
      "featuresOn": [
        "SHOW_RAW_DATA"
      ],
      "featuresOff": [
        "SHOW_RAW_DATA"
      ],
      "screeningMatchingThreshold": "0.8"
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Delete Fetch Configuration

Request

Delete a fetch configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

curl -i -X DELETE \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(FetchConfigurationModel)

The configuration for the Business Partner fetch.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

List Lookup Configurations

Request

List all lookup configurations of the current user.

Security

apiKey

Query

limitinteger(Limit)

Maximum number of configurations to return. Used for pagination.

Example: limit=100

startAfterstring(StartAfter)

ID of the last configuration returned in the previous request. Used for pagination.

Example: startAfter=5712566172571652

defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true

curl -i -X GET \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"

nextStartAfterstring(NextStartAfter)

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

Example: "5712566172571652"

totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"

valuesArray of objects(WorkspaceConfigurationSearchResult)

List of workspace configurations.

Response

application/json

{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "total": "67",
  "values": [
    { … }
  ]
}

Read Lookup Configuration

Request

Read a lookup configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

curl -i -X GET \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ]
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Update Lookup Configuration

Request

Update a lookup configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

Bodyapplication/json

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

curl -i -X PUT \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Client configuration.",
    "configuration": {
      "limit": "10",
      "startAfter": "5712566172571652",
      "dataSources": [
        "VIES"
      ],
      "matchingThreshold": "0.5",
      "maxCandidates": "50",
      "storagesDataSources": [
        {
          "storageId": "6479fd136811f0361e083211",
          "dataSources": [
            {
              "id": "6479fd136811f0361e083211"
            }
          ]
        }
      ],
      "featuresOn": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "featuresOff": [
        "ACTIVATE_DATASOURCE_BVD"
      ]
    }
  }'

Responses

Configuration updated successful

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ]
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Delete Lookup Configuration

Request

Delete a lookup configuration of the current user.

Security

apiKey

Path

configurationIdstringrequired

ID of the configuration.

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

curl -i -X DELETE \
  https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

idstring(ConfigurationId)

Uniquely identifies a configuration.

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

namestring(ConfigurationName)

Display name for a configuration.

Example: "Client configuration."

versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1

configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

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

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

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

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

Response

application/json

{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Client configuration.",
  "version": 1,
  "configuration": {
    "limit": "10",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ]
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "76248934691294444"
}

Configuration

Operations

Referencedata API (4)

Business Partners

Analytics

Registrations

Addresses

Bulk Fetch

Bulk Lookup

Cancel Bulk

Batch Lookup

Configurations

List Fetch Configurations

Request

Responses

Share the feedback!

Create Fetch Configuration

RequestExpand all

Responses

Share the feedback!

Read Fetch Configuration

Request

Responses

Share the feedback!

Update Fetch Configuration

RequestExpand all

Responses

Share the feedback!

Delete Fetch Configuration

Request

Responses

Share the feedback!

List Lookup Configurations

Request

Responses

Share the feedback!

Read Lookup Configuration

Request

Responses

Share the feedback!

Update Lookup Configuration

RequestExpand all

Responses

Share the feedback!

Delete Lookup Configuration

Request

Responses

Share the feedback!

Configuration

Request

Request

Request