Skip to content

Data Validation API (3)

This API provides services used for business partner qualification

Data Validation API
Download OpenAPI description
api-v3.json
api-v3.yaml
Languages
Servers
Mock server

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

Production

https://api.cdq.com/data-validation/rest/

Qualification

Provides funcionalities for qualification of Business Partners. Includes endpoints that allow users to submit Business Partner data for qualification, retrieve qualification results, and handle various qualification scenarios.

Operations

Configuration

Provides funcionalities for managing configurations. Includes endpoints that allow users to create, update, and delete configurations for the current user.

Operations

List Users Configuration

Request

Fetches the current users' configuration. If no configuration exists, a default configuration is returned.

Security
apiKey
Query
startAfterstring(StartAfter)

Start after the given index. Use this to paginate through the results. The first page is returned if this parameter is not provided.

Example: startAfter=5712566172571652
limitinteger(Limit)

Maximum number of results to return. The default is 100.

Example: limit=100
defaultConfigurationboolean

Is default workspace configuration of given type.

Example: defaultConfiguration=true
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/configurations/businesspartnervalidation \
  -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(WorkspaceConfiguration)

List of configurations.

Response
application/json
{
  "startAfter": "0",
  "nextStartAfter": "1",
  "total": 2,
  "values": [
    { … },
    { … }
  ]
}

Create Configuration

Request

Creates a new configuration for the current user. The configuration is stored in the users workspace and can be used for validation of business partners and identifiers.

Security
apiKey
Bodyapplication/json
workspaceIdstring(WorkspaceId)

Uniquely identifying ID of the workspace.

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

The name of the configuration.

Example: "Custom configuration name"
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/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"
    }
  }'

Responses

Configuration created successfully

Bodyapplication/json
idstring

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

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
configurationIdstring(schemas-ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the configuration.

Example: 1
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "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"
}

Fetch Configuration

Request

Fetches an existing configuration for the current user.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Configuration updated successful.

Bodyapplication/json
idstring

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

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
configurationIdstring(schemas-ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the configuration.

Example: 1
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "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"
}

Update Configuration

Request

Updates an existing configuration for the current user.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
Bodyapplication/json
featuresOnArray of strings(WorkspaceConfigurationUpdateFeaturesOn)

Features to be enabled.

Items ValueDescription
REEVALUATION_ON_CHANGES

Re-evaluates business partners based on changes in the configuration.

Example: ["REEVALUATION_ON_CHANGES"]
namestring

The name of the configuration.

Example: "Custom configuration name"
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

curl -i -X PUT \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/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": {}
  }'

Responses

Configuration updated successful.

Bodyapplication/json
idstring

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

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
configurationIdstring(schemas-ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the configuration.

Example: 1
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "name": "demo config",
  "id": "63a1d5a13b5faf2f613164c0",
  "createdAt": "2022-12-20T15:32:49.579Z",
  "modifiedAt": "2022-12-20T15:43:43.158949713Z",
  "createdBy": "demo"
}

Delete Configuration

Request

Deletes a configuration for the current user.

Security
apiKey
Path
configurationIdstringrequired

ID of the configuration.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
curl -i -X DELETE \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
idstring

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

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
configurationIdstring(schemas-ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the configuration.

Example: 1
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-08-27T14:26:53Z"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
Response
application/json
{
  "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-08-27T14:26:53Z",
  "modifiedAt": "2025-08-27T14:26:53Z",
  "createdBy": "76248934691294444"
}

Read Business Partner Validation Configuration Version

Request

Read a specific version of a business partner validation 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/data-validation-api/api-v3/configurations/businesspartnervalidation/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 validation 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(schemas-ConfigurationId)

Uniquely identifies a configuration.

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

Version number of the configuration.

Example: 1
configurationobject(BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

createdAtstring

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

Example: "2025-08-27T14:26:53Z"
modifiedAtstring

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

Example: "2025-08-27T14:26:53Z"
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": {
    "validationProfile": "QUICK",
    "ruleStatuses": [ … ],
    "featuresOn": [ … ],
    "featuresOff": [ … ],
    "ruleCategoriesOn": [ … ],
    "ignoredRules": [ … ],
    "activatedRules": [ … ],
    "criticalities": [ … ],
    "dataSourcesOn": [ … ],
    "dataSourcesOff": [ … ],
    "violationMessages": [ … ]
  },
  "createdAt": "2025-08-27T14:26:53Z",
  "modifiedAt": "2025-08-27T14:26:53Z",
  "createdBy": "69129435489347624",
  "modifiedBy": "76248934691294444"
}

Public

Provides funcionalities to provide an RDF model of a record and validate a Business Partner.

Processing Logs

Provides funcionalities for managing processing logs. Includes endpoints that allow users to read processing log results.

Operations

Business Partners

Operations

Batch Validation

Operations

Records

Operations