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
Mock server

https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/

Production

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

Business Partners

Everything about Business Partners

Operations

Addresses

Everything about Addresses

Analytics

Everything about reference data analytics

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://developer.cdq.com/_mock/apis/referencedata-api/api-v3/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-09-12T14:57:59Z"
modifiedAtstring

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

Example: "2025-09-12T14:57:59Z"
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-09-12T14:57:59Z",
  "modifiedAt": "2025-09-12T14:57:59Z",
  "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://developer.cdq.com/_mock/apis/referencedata-api/api-v3/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-09-12T14:57:59Z"
modifiedAtstring

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

Example: "2025-09-12T14:57:59Z"
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": [ … ]
  },
  "createdAt": "2025-09-12T14:57:59Z",
  "modifiedAt": "2025-09-12T14:57:59Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Processing Logs

Operations

Batch Lookup

Operations