List Tax Guard Identifier Qualification Configurations

Qualification
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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(DefaultWorkspaceConfiguration)

Limit search to configurations with the provided default flag value. If left empty, all configurations will be returned.

Example: defaultConfiguration=true

clientIdstring

API Key ID or Client ID. When present returns only configurations assigned to the given API key.

Example: clientId=12345678-1234-5678-1234-567812345678

curl -i -X GET \
  https://api.cdq.com/data-validation/rest/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. If given configuration is empty or lacks validationProfile - STANDARD profile will be used as default.

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.

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

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": {
      "validationProfile": "STANDARD",
      "ruleStatuses": [
        "HYPERCARE",
        "RELEASED"
      ],
      "featuresOn": [
        "SHOW_DEBUG_INFO",
        "ENRICH_LEGAL_FORM",
        "ENRICH_CATEGORIES",
        "SHOW_BUSINESSPARTNER",
        "SHOW_DATA_DEFECTS",
        "IDENTIFIER_CHECKS",
        "BUSINESS_PARTNER_CHECKS",
        "ADDRESS_CHECKS",
        "COUNTRY_CHECKS"
      ]
    }
  }'

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"

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(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

Response

application/json

{
  "name": "Demo config",
  "configuration": {
    "validationProfile": "STANDARD",
    "ruleStatuses": [ … ],
    "featuresOn": [ … ]
  },
  "version": 1,
  "id": "693133f25145ab285033b0e8",
  "createdAt": "2025-12-04T07:10:42.138388938Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

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://api.cdq.com/data-validation/rest/configurations/businesspartnervalidation/c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4 \
  -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(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

Response

application/json

{
  "name": "Demo config",
  "configuration": {
    "validationProfile": "STANDARD",
    "ruleStatuses": [ … ],
    "featuresOn": [ … ]
  },
  "version": 1,
  "id": "693133f25145ab285033b0e8",
  "createdAt": "2025-12-04T07:10:42.138Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

Update Configuration

Request

Updates an existing configuration for the current user. If given configuration is empty or lacks validationProfile - STANDARD profile will be used as default.

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 Value	Description
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"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

configurationobject(BusinessPartnerValidationConfiguration)

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

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": {}
  }'

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"

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(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

Response

application/json

{
  "name": "demo config",
  "configuration": {
    "validationProfile": "STANDARD"
  },
  "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://api.cdq.com/data-validation/rest/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"

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(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2025-12-17T13:03:14Z"

createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

Response

application/json

{
  "name": "Demo config",
  "configuration": {
    "validationProfile": "STANDARD",
    "ruleStatuses": [ … ],
    "featuresOn": [ … ]
  },
  "version": 2,
  "id": "693133f25145ab285033b0e8",
  "createdAt": "2025-12-04T07:10:42.138Z",
  "modifiedAt": "2025-12-04T07:19:22.427Z",
  "createdBy": "demo",
  "defaultConfiguration": false,
  "relatedConfigurations": []
}

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://api.cdq.com/data-validation/rest/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-12-17T13:03:14Z"

modifiedAtstring

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

Example: "2025-12-17T13:03:14Z"

createdBystring

User who created the first version of the configuration.

Example: "69129435489347624"

modifiedBystring

User who created this version of the configuration.

Example: "76248934691294444"

defaultConfigurationboolean(DefaultWorkspaceConfiguration)

The default workspace configuration. Only one configuration of a given type can be the default configuration in a given workspace.

Example: true

Response

application/json

{
  "id": "693135fa5145ab285033b0ec",
  "name": "Demo config",
  "configurationId": "693133f25145ab285033b0e8",
  "version": 2,
  "configuration": {
    "validationProfile": "STANDARD",
    "ruleStatuses": [ … ],
    "featuresOn": [ … ]
  },
  "createdAt": "2025-12-04T07:10:42.138Z",
  "createdBy": "demo",
  "modifiedAt": "2025-12-04T07:19:22.427Z",
  "modifiedBy": "demo",
  "defaultConfiguration": false
}