Skip to content

Referencedata API (3)

This API provides services to search and read reference data

Download OpenAPI description
api-v3.json
api-v3.yaml
Languages
Servers
Production

https://api.cdq.com/referencedata/rest/

Business Partners

Everything about Business Partners

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

Configuration for fetching Business Partners.

configuration.​featuresOnArray of strings(BusinessPartnerFetchFeaturesDesc)

List of features to be activated.

Items Enum ValueDescription
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: ["ENABLE_SETTINGS"]
configuration.​featuresOffArray of strings(BusinessPartnerFetchFeaturesDesc)

List of features to be deactivated.

Items Enum ValueDescription
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: ["ENABLE_SETTINGS"]
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": [
        "ENABLE_SETTINGS"
      ],
      "featuresOff": [
        "ENABLE_SETTINGS"
      ],
      "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)

Configuration for fetching Business Partners.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "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)

Configuration for fetching Business Partners.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "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)

Configuration for fetching Business Partners.

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": [
        "ENABLE_SETTINGS"
      ],
      "featuresOff": [
        "ENABLE_SETTINGS"
      ],
      "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)

Configuration for fetching Business Partners.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "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)

Configuration for fetching Business Partners.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "createdBy": "76248934691294444"
}

Read Business Partner Fetch Configuration Version

Request

Read a specific version of a business partner fetch configuration by id and version number.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

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

Version number of the configuration.

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

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the business partner fetch configuration version. Not to be confused with the configuration ID.

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

The name of the configuration

Example: "Configuration Name"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(FetchConfigurationModel)

Configuration for fetching Business Partners.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "screeningMatchingThreshold": "0.8"
  },
  "createdAt": "2025-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "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-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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",
    "dataSource": "648824a691d8d2503d65103e",
    "dataSources": [ … ],
    "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
    "matchingClassifications": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "pageSize": "10",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2025-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "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",
      "dataSource": "648824a691d8d2503d65103e",
      "dataSources": [
        "VIES"
      ],
      "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
      "matchingClassifications": [
        {
          "countryScope": {
            "shortNames": [
              "CH"
            ]
          },
          "businessPartnerThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          },
          "addressThreshold": {
            "fullMatch": 0.75,
            "maybeMatch": 0.75
          }
        }
      ],
      "matchingThreshold": "0.5",
      "maxCandidates": "50",
      "pageSize": "10",
      "storagesDataSources": [
        {
          "storageId": "72d6900fce6b326088f5d9d91049e3e6",
          "dataSources": [
            "648824a691d8d2503d65103e"
          ]
        }
      ],
      "featuresOn": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "featuresOff": [
        "ACTIVATE_DATASOURCE_BVD"
      ],
      "tags": [
        "Warehouse"
      ]
    }
  }'

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-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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",
    "dataSource": "648824a691d8d2503d65103e",
    "dataSources": [ … ],
    "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
    "matchingClassifications": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "pageSize": "10",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2025-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "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-11-24T09:36:27Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
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",
    "dataSource": "648824a691d8d2503d65103e",
    "dataSources": [ … ],
    "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
    "matchingClassifications": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "pageSize": "10",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2025-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "createdBy": "76248934691294444"
}

Read Business partner Lookup Configuration Version

Request

Read a specific version of a business partner lookup configuration by id and version number.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

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

Version number of the configuration.

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

Responses

Successful operation.

Bodyapplication/json
idstring

Unique identifier of the business partner lookup configuration version. Not to be confused with the configuration ID.

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

The name of the configuration

Example: "Configuration Name"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
versioninteger(ConfigurationVersionNumber)

Version number of the configuration.

Example: 1
configurationobject(LookupConfigurationModel)

Defines the configuration settings for a Business Partner lookup process.

createdAtstring

Date and time when the first version of the configuration was created (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
modifiedAtstring

Date and time when this version of the configuration was created (ISO 8601-compliant).

Example: "2025-11-24T09:36:27Z"
createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"
modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"
Response
application/json
{
  "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "name": "Configuration Name",
  "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  "version": 1,
  "configuration": {
    "limit": "10",
    "dataSource": "648824a691d8d2503d65103e",
    "dataSources": [ … ],
    "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
    "matchingClassifications": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "pageSize": "10",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "tags": [ … ]
  },
  "createdAt": "2025-11-24T09:36:27Z",
  "modifiedAt": "2025-11-24T09:36:27Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Processing Logs

Operations

Batch Lookup

Operations