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

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

Qualify Business Partner

Request

Endpoint used for Business Partner qualification. It is in BETA version and may change without notice.

Security
apiKey
Bodyapplication/jsonrequired

cmd

dataSourcesArray of strings(DataSourcesEnum)

List of data sources should be used.

Items Enum ValueDescription
AR.NRC

Value indicating AR.NRC data source.

AT.CR

Value indicating AT.CR data source.

AT.FON

Value indicating AT.FON data source.

AU.BR

Value indicating AU.BR data source.

BR.RF

Value indicating BR.RF data source.

BZST

Value indicating BZST data source.

CA.CR

Value indicating CA.CR data source.

CH.UIDR

Value indicating CH.UIDR data source.

CZ.REE

Value indicating CZ.REE data source.

DK.CR

Value indicating DK.CR data source.

Example: ["AR.NRC"]
profilestring(BusinessPartnerQualificationRequestProfileEnum)

Qualification profiles enum.

Default "EU_TAX_QUALIFICATION"
Enum ValueDescription
EU_TAX_QUALIFICATION

Default option. EU_TAX_QUALIFICATION profile for the Qualification process.

WORLDWIDE_TAX_QUALIFICATION

WORLDWIDE_TAX_QUALIFICATION profile for the Qualification process.

Example: "EU_TAX_QUALIFICATION"
featuresOnArray of strings(BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned on.

Items Enum ValueDescription
SHOW_LOOKUP_RESULTS

Includes lookup results in the response.

SHOW_BUSINESS_PARTNER

Includes Business Partner in the response.

FORCE_EXTERNAL_CALL

Forces calls on external services ignoring cache.

SHOW_DEBUG_INFO

Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).

Example: ["FORCE_EXTERNAL_CALL"]
featuresOffArray of strings(BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned off.

Items Enum ValueDescription
SHOW_LOOKUP_RESULTS

Includes lookup results in the response.

SHOW_BUSINESS_PARTNER

Includes Business Partner in the response.

FORCE_EXTERNAL_CALL

Forces calls on external services ignoring cache.

SHOW_DEBUG_INFO

Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).

Example: ["FORCE_EXTERNAL_CALL"]
businessPartnerobject(BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/v3/businesspartners/qualify \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "profile": "EU_TAX_QUALIFICATION",
    "businessPartner": {
      "names": [
        {
          "value": "ATOS SPAIN SA"
        }
      ],
      "identifiers": [
        {
          "type": {
            "technicalKey": "EU_VAT_ID_ES"
          },
          "value": "A28240752"
        }
      ],
      "addresses": [
        {
          "country": {
            "shortName": "ES"
          }
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
qualificationResultsArray of objects(BusinessPartnerQualificationResultItem)

List of Qualifications Results.

rulesInErrorArray of objects(RulesInError)

List of rules executed with error.

lookupResultsArray of objects(LookupResult)

List of Lookup Results.

debugInfoobject(DebugInfo)

Reference implementation how to structure external service responses. Can be activated by a feature SHOW_DEBUG_INFO.

businessPartnerobject(BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

Response
application/json
{
  "qualificationResults": [
    { … }
  ],
  "lookupResults": [
    { … }
  ],
  "debugInfo": {
    "externalServiceResponses": [ … ],
    "businessRulesExecutionSummary": { … }
  }
}

Validate Business Partner

Request

Validate business partners (i.e. identifiers, legal forms) and addresses (i.e. post codes) and receive a list of data defects in case of found data quality issues.

Examples

Check out our examples in the Try it console to better understand this endpoint.

ExampleDescription
Identifier exists and is validNo dataDefects related to the identifier and identifierReliability.level equals 4. Note that there might be data defects if you provide more details than the identifier (i.e. address data).
Identifier does not exist in external data sourceEntry in dataDefects related to the identifier and identifierReliability.level < 4
Unknown status for an identifier existence (only response example)identifierReliability.level < 4 and the respective message equals to external service error. You may try again as this is typical a temporary issue.
Security
apiKey
Bodyapplication/json
profilestring(ValidationProfile)

Profile which is used during validation. Default value is STANDARD.

Enum ValueDescription
QUICK

This profile checks data quality of records in a quick way, i.e. data quality rules that have a negative impact on performance.

STANDARD

This profile checks data quality using CDQ's standard configuration.

QUALIFICATION

Deprecated.

AUTOMATION

Deprecated.

EU_VAT_QUALIFICATION

This profile qualifies EU VATs using CDQ's default configuration of data quality rules for qualified checks of EU VATs

DATA_SHARING_QUALITY_GATE

Quality checks ensure that only valid data enters the CDQ Community Data Pool

IDENTIFIER_QUALITY

This profile checks identifiers with a standard configuration of data quality rules. It does not comprise qualified checks of identifiers regarding e.g. name or address.

ADDRESS_QUALITY

This profile checks addresses with a standard configuration of data quality rules.

WORLDWIDE_IDENTIFIER_QUALIFICATION

This profile qualifies any supported business identifier (e.g. tax numbers) worldwide using CDQ's default configuration of data quality rules for qualified checks of a particular identifier

FEATURES_OFF

This profile turns off any qualification rules and is designed for custom rules selection.

Example: "QUICK"
ruleStatusesArray of strings(RuleStatus)

Enable rules with provided statuses.

Items Enum ValueDescription
RELEASED

Rule was moved from status PLANNED automatically during daily testing or by manual maintenance.

DRAFT

Rule was created as a draft and it will be not executed.

HYPERCARE

Rule was moved from status DEACTIVATED automatically during daily testing.

Example: ["RELEASED"]
featuresOnArray of strings(ValidationFeature)

List of activated features.

Items Enum ValueDescription
ADDRESS_CHECKS

CDQ data quality profiling services enable the validation of addresses with respect to different data quality criteria.

BANKING_DATA_CHECKS

CDQ data quality profiling services enable the validation of bank master data with respect to different data quality criteria.

BUSINESS_PARTNER_CHECKS

Validate concepts that basically establish a business partner (e.g. name and legal form).

COUNTRY_CHECKS

Validate country information.

ENRICH_CATEGORIES

Enrich a CDL community standardized business partner category for a given entity.

ENRICH_DATA_MIRROR_CHANGES

Enriches the data with changes from the data mirror.

ENRICH_LEGAL_FORM

Identify and enriches the legal form of a company.

EU_VAT_QUALIFICATION_AT

Enforces to use AT.FON data source to qualify EU VATs.

EU_VAT_QUALIFICATION_DE

Enforces to use BZST data source for non-German business partners.

EU_VAT_QUALIFICATION_STANDARD

For a given EU VAT, it is checked whether the name and address are really associated with this identifier (same information maintained in the VAT register as provided by the user).

Example: ["SHOW_LOOKUP_RESULTS"]
featuresOffArray of strings(ValidationFeature)

List of deactivated features.

Items Enum ValueDescription
ADDRESS_CHECKS

CDQ data quality profiling services enable the validation of addresses with respect to different data quality criteria.

BANKING_DATA_CHECKS

CDQ data quality profiling services enable the validation of bank master data with respect to different data quality criteria.

BUSINESS_PARTNER_CHECKS

Validate concepts that basically establish a business partner (e.g. name and legal form).

COUNTRY_CHECKS

Validate country information.

ENRICH_CATEGORIES

Enrich a CDL community standardized business partner category for a given entity.

ENRICH_DATA_MIRROR_CHANGES

Enriches the data with changes from the data mirror.

ENRICH_LEGAL_FORM

Identify and enriches the legal form of a company.

EU_VAT_QUALIFICATION_AT

Enforces to use AT.FON data source to qualify EU VATs.

EU_VAT_QUALIFICATION_DE

Enforces to use BZST data source for non-German business partners.

EU_VAT_QUALIFICATION_STANDARD

For a given EU VAT, it is checked whether the name and address are really associated with this identifier (same information maintained in the VAT register as provided by the user).

Example: ["SHOW_LOOKUP_RESULTS"]
ruleCategoriesOnArray of objects(RuleCategoryOn)

Categories use for selecting active business rules.

dataSourcesOnArray of objects(DataSource)

If data sources are disabled by feature toggle you can enable some of them passing their prefixes here.

dataSourcesOffArray of objects(DataSource)

Rules with data sources passed here are not used in validation process.

bzstPrintstring

Request printed confirmation by German BZSt authority.

Example: "true"
validationSourceobject(ValidationSource)

Source of the validation.

ignoredRulesArray of strings(BusinessRuleUrl)

Urls of cdl rules ignored during validation process.

Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]
activatedRulesArray of strings(BusinessRuleUrl)

Urls of cdl rules that are active during validation process.

Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]
criticalitiesArray of objects(Criticality)
configurationIdstring(ConfigurationId)

Configuration ID used to set up data validation request. If provided, those parameters will be overridden:

  • profile
  • featuresOn
  • featuresOff
Example: "6513d25b63cf07787018790a"
businessPartnerobject(BusinessPartnerParam)required

Refers to an organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

businessPartner.​externalIdstring(BusinessPartnerExternalId)

Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.

Example: "The ID managed in the customer's SAP systems."
businessPartner.​namesArray of objects(NameParam)

List of names of the Business Partner.

businessPartner.​legalFormobject(LegalFormParam)

The legal form of a Business Partner is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).

businessPartner.​identifiersArray of objects(IdentifierParam)

List of identifiers of the Business Partner.

businessPartner.​addressesArray of objects(Address2)

List of addresses of the Business Partner.

vatAtRequestorstringDeprecated

DEPRECATED, use organizational settings to configure.

The requestor’s VAT identifier, required for execution of requests against external data sources.

Example: "AT123456789"
vatDeRequestorstringDeprecated

DEPRECATED, use organizational settings to configure.

The requestor’s VAT identifier, required for execution of requests against external data sources.

Example: "DE123456789"
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/v2/businesspartners/validate \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businessPartner": {
      "names": [
        {
          "value": "CDQ AG"
        }
      ],
      "identifiers": [
        {
          "value": "218.608.886",
          "type": {
            "technicalKey": "CH_UID"
          }
        }
      ],
      "legalForm": {
        "name": "Aktiengesellschaft"
      },
      "addresses": [
        {
          "country": {
            "shortName": "CH"
          },
          "thoroughfares": [
            {
              "value": "Lukasstrassse 4"
            }
          ],
          "localities": [
            {
              "value": "St.Gallen"
            }
          ],
          "postCodes": [
            {
              "value": "9008"
            }
          ]
        }
      ]
    }
  }'

Responses

OK

Body
dataDefectsArray of objects(DataDefect)

List of Data Defects.

qualificationResultobject(QualificationResult)

QualificationResult is created when validation process takes into consideration rules of category and the feature SHOW_QUALIFICATION_DECISIONS is enabled. Enabling qualification can be done by the profile related to the qualification. QualificationResult contains information about qualification decisions, the data that have been qualified and overall qualification decisions.

lookupResultsArray of objects(LookupResult)

List of Lookup Results.

summaryobject(ValidationSummary)

Summary of the validation result.

debugInfoobject(DebugInfo)

Reference implementation how to structure external service responses. Can be activated by a feature SHOW_DEBUG_INFO.

identifierResultsArray of objects(IdentifierResults)
businessPartnerobject(BusinessPartner3)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

rulesInErrorArray of objects(RulesInError)

List of rules executed with error.

executedAtstring

ISO 8601 representation of the timestamp when the result data was created.

Example: "2025-08-27T14:26:53Z"
Response
{
  "summary": {
    "validationLevel": "OK",
    "action": "AUTO_APPROVE",
    "statistics": { … }
  },
  "debugInfo": {
    "businessRulesExecutionSummary": { … }
  },
  "identifierResults": [
    { … }
  ],
  "businessPartner": {
    "legalForm": {},
    "identifiers": [ … ],
    "addresses": [ … ],
    "profile": {}
  }
}

Batch Validation

Operations

Records

Operations