This API provides services used for business partner qualification
https://api.cdq.com/data-validation/rest/
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "startAfter": "0", "nextStartAfter": "1", "total": 2, "values": [ { … }, { … } ] }
Uniquely identifying ID of the workspace.
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X POST \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"name": "demo config",
"configuration": {
"ignoredRules": [
"https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)",
"https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))"
],
"activatedRules": [
"https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)"
],
"featuresOff": [
"ENRICH_LEGAL_FORM",
"SHOW_DECISIONS"
],
"featuresOn": [
"SHOW_LOOKUP_RESULTS",
"SHOW_BUSINESSPARTNER",
"SHOW_DATA_DEFECTS"
],
"ruleCategoriesOn": [
{
"url": "https://meta.cdq.ch/Missing_legal_form"
}
],
"criticalities": [
{
"businessRuleUrl": "https://meta.cdq.com/Dummy_post_code_detected_(AF)",
"violationLevel": "WARNING"
},
{
"businessRuleUrl": "https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)",
"violationLevel": "INFO"
}
],
"ruleStatuses": [
"RELEASED"
],
"dataSourcesOn": [
{
"aleiPrefix": "VIES"
}
],
"validationProfile": "EU_VAT_QUALIFICATION"
}
}'
Configuration created successfully
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date of modification (ISO 8601-compliant).
{ "name": "demo config", "configuration": { "ignoredRules": [ … ], "activatedRules": [ … ], "dataSourcesOn": [ … ], "featuresOff": [ … ], "featuresOn": [ … ], "criticalities": [ … ], "ruleStatuses": [ … ], "validationProfile": "EU_VAT_QUALIFICATION", "ruleCategoriesOn": [ … ] }, "id": "63a1d5a1335faf2f613164c0", "createdAt": "2022-12-20T15:32:49.579921335Z", "modifiedAt": "2022-12-20T15:32:49.579949313Z", "createdBy": "demo" }
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
Configuration updated successful.
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date of modification (ISO 8601-compliant).
{ "name": "demo config", "configuration": { "ignoredRules": [ … ], "activatedRules": [ … ], "dataSourcesOn": [ … ], "featuresOff": [ … ], "featuresOn": [ … ], "criticalities": [ … ], "ruleStatuses": [ … ], "validationProfile": "EU_VAT_QUALIFICATION", "ruleCategoriesOn": [ … ] }, "id": "63a1d5a13b5faf2f613164c0", "createdAt": "2022-12-20T15:32:49.579Z", "modifiedAt": "2022-12-20T15:32:49.579Z", "createdBy": "demo" }
Features to be enabled.
Items Value | Description |
---|---|
REEVALUATION_ON_CHANGES | Re-evaluates business partners based on changes in the configuration. |
Is default workspace configuration. Only one configuration of the same type can be a default configuration in a given workspace.
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X PUT \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"name": "demo config",
"configuration": {}
}'
Configuration updated successful.
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date of modification (ISO 8601-compliant).
{ "name": "demo config", "id": "63a1d5a13b5faf2f613164c0", "createdAt": "2022-12-20T15:32:49.579Z", "modifiedAt": "2022-12-20T15:43:43.158949713Z", "createdBy": "demo" }
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X DELETE \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
OK.
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date of modification (ISO 8601-compliant).
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "version": 1, "configuration": { "validationProfile": "QUICK", "ruleStatuses": [ … ], "featuresOn": [ … ], "featuresOff": [ … ], "ruleCategoriesOn": [ … ], "ignoredRules": [ … ], "activatedRules": [ … ], "criticalities": [ … ], "dataSourcesOn": [ … ], "dataSourcesOff": [ … ], "violationMessages": [ … ] }, "createdAt": "2025-10-07T05:40:33Z", "modifiedAt": "2025-10-07T05:40:33Z", "createdBy": "76248934691294444" }
- Production
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/{configurationId}/versions/{version}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
Successful operation.
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date and time when the first version of the configuration was created (ISO 8601-compliant).
Date and time when this version of the configuration was created (ISO 8601-compliant).
User who created the first version of the configuration.
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Configuration Name", "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "version": 1, "configuration": { "validationProfile": "QUICK", "ruleStatuses": [ … ], "featuresOn": [ … ], "featuresOff": [ … ], "ruleCategoriesOn": [ … ], "ignoredRules": [ … ], "activatedRules": [ … ], "criticalities": [ … ], "dataSourcesOn": [ … ], "dataSourcesOff": [ … ], "violationMessages": [ … ] }, "createdAt": "2025-10-07T05:40:33Z", "modifiedAt": "2025-10-07T05:40:33Z", "createdBy": "69129435489347624", "modifiedBy": "76248934691294444" }
Maximum number of configurations to return. Used for pagination.
ID of the last configuration returned in the previous request. Used for pagination.
Limit search to configurations with provided default flag value. If left empty, all configurations will be returned.
- Production
https://api.cdq.com/data-validation/rest/configurations/qualification
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/qualification \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
{ "startAfter": "0", "nextStartAfter": "1", "total": 2, "values": [ { … }, { … } ] }
- Production
https://api.cdq.com/data-validation/rest/configurations/qualification/{configurationId}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/qualification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
Successful operation
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date of modification (ISO 8601-compliant).
{ "name": "demo config", "configuration": { "ignoredRules": [ … ], "activatedRules": [ … ], "dataSourcesOn": [ … ], "featuresOff": [ … ], "featuresOn": [ … ], "criticalities": [ … ], "ruleStatuses": [ … ], "validationProfile": "EU_VAT_QUALIFICATION", "ruleCategoriesOn": [ … ] }, "id": "63a1d5a13b5faf2f613164c0", "createdAt": "2022-12-20T15:32:49.579Z", "modifiedAt": "2022-12-20T15:32:49.579Z", "createdBy": "demo" }
- Production
https://api.cdq.com/data-validation/rest/configurations/qualification/{configurationId}/versions/{version}
- cURL
- Java
- JavaScript
- Python
- Node.js
curl -i -X GET \
https://api.cdq.com/data-validation/rest/configurations/qualification/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4/versions/1 \
-H 'X-API-KEY: YOUR_API_KEY_HERE'
Successful operation.
Unique identifier of the business partner validation configuration version. Not to be confused with the configuration ID.
Uniquely identifies a configuration.
Configuration of the validation process for a single Business Partner record.
Date and time when the first version of the configuration was created (ISO 8601-compliant).
Date and time when this version of the configuration was created (ISO 8601-compliant).
User who created the first version of the configuration.
{ "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "name": "Configuration Name", "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4", "version": 1, "configuration": { "validationProfile": "QUICK", "ruleStatuses": [ … ], "featuresOn": [ … ], "featuresOff": [ … ], "ruleCategoriesOn": [ … ], "ignoredRules": [ … ], "activatedRules": [ … ], "criticalities": [ … ], "dataSourcesOn": [ … ], "dataSourcesOff": [ … ], "violationMessages": [ … ] }, "createdAt": "2025-10-07T05:40:33Z", "modifiedAt": "2025-10-07T05:40:33Z", "createdBy": "69129435489347624", "modifiedBy": "76248934691294444" }