This API provides services to search and read reference data
Referencedata API (3)
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/
https://api.cdq.com/referencedata/rest/
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "startAfter": "5712566172571652", "nextStartAfter": "5712566172571652", "total": "67", "values": [ { … } ] }
Uniquely identifying ID of the workspace.
Display name for a configuration.
Configuration for fetching Business Partners.
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 |
SHOW_COMMERCIAL_ULTIMATE | Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). |
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE | Fetch Domestic Commercial Ultimate from DNB. |
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. |
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 |
SHOW_COMMERCIAL_ULTIMATE | Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). |
SHOW_DOMESTIC_COMMERCIAL_ULTIMATE | Fetch Domestic Commercial Ultimate from DNB. |
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. |
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X POST \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/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"
}
}'
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Client configuration.", "version": 1, "configuration": { "featuresOn": [ … ], "featuresOff": [ … ], "screeningMatchingThreshold": "0.8" }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Client configuration.", "version": 1, "configuration": { "featuresOn": [ … ], "featuresOff": [ … ], "screeningMatchingThreshold": "0.8" }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X PUT \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/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"
}
}'
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Client configuration.", "version": 1, "configuration": { "featuresOn": [ … ], "featuresOff": [ … ], "screeningMatchingThreshold": "0.8" }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerfetch/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X DELETE \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerfetch/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Client configuration.", "version": 1, "configuration": { "featuresOn": [ … ], "featuresOff": [ … ], "screeningMatchingThreshold": "0.8" }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "startAfter": "5712566172571652", "nextStartAfter": "5712566172571652", "total": "67", "values": [ { … } ] }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "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": [ … ] }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X PUT \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/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"
]
}
}'
{ "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": [ … ] }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }
- Mock server
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup/{configurationId}
- Production
https://api.cdq.com/referencedata/rest/configurations/businesspartnerlookup/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X DELETE \
https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/configurations/businesspartnerlookup/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "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": [ … ] }, "createdAt": "2025-09-12T14:57:59Z", "modifiedAt": "2025-09-12T14:57:59Z", "createdBy": "76248934691294444" }