Skip to content

Referencedata API (4)

This API provides services to search and read reference data

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

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

Business Partners

Everything about Business Partners

Operations

Analytics

Everything about reference data analytics

Registrations

Registrations

Addresses

Everything about Addresses

Bulk Fetch

Operations

Bulk Lookup

Operations

Cancel Bulk

Operations

Batch Lookup

Operations

Configurations

Operations

Configuration

Operations

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)

The configuration for the Business Partner fetch.

createdAtstring

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

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

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

Example: "2025-08-15T11:08:44Z"
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-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "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-08-15T11:08:44Z"
modifiedAtstring

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

Example: "2025-08-15T11:08:44Z"
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",
    "startAfter": "5712566172571652",
    "dataSources": [ … ],
    "matchingThreshold": "0.5",
    "maxCandidates": "50",
    "storagesDataSources": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ]
  },
  "createdAt": "2025-08-15T11:08:44Z",
  "modifiedAt": "2025-08-15T11:08:44Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}