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.
Example
Description
Identifier exists and is valid
No 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 source
Entry 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.
SecurityapiKey
Request
Request Body schema: application/json
activatedRules
Array of strings (BusinessRuleUrl)
Urls of cdl rules that are active during validation process.
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.
bzstPrint
string
Request printed confirmation by German BZSt authority.
Example: "true"
configurationId
string (ConfigurationId)
Configuration ID used to set up validation job. If provided, those parameters will be overridden:
profile
ruleStatuses
featuresOn
featuresOff
ruleCategoriesOn
ignoredRules
activatedRules
criticalities
dataSourcesOn
dataSourcesOff
Example: "6513d25b63cf07787018790a"
Array of objects (Criticality)
Array of objects (DataSource)
Rules with data sources passed here are not used in validation process.
Array of objects (DataSource)
If data sources are disabled by feature toggle you can enable some of them passing their prefixes here.
featuresOff
Array of strings (ValidationFeature)
List of deactivated features.
Items Enum:
Description
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).
EXTERNAL_SOURCES_OFF
Turns off external data sources.
FORCE_EXTERNAL_CALL
Force external call.
IDENTIFIER_CHECKS
Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories.
IDENTIFIER_QUALIFICATION
Turns on identifier qualification (standard) which enables to qualify EU VAT identifiers.
LAB_BETA
Deprecated feature.
QUALIFICATION_SILENT_MODE
If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.
SHOW_BUSINESSPARTNER
Shows business partner that was used in the request.
SHOW_DATA_DEFECTS
Shows found data defects - usually it is turned on.
SHOW_DEBUG_INFO
Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).
SHOW_DECISIONS
Deprecated feature.
SHOW_LOOKUP_RESULTS
Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).
SHOW_QUALIFICATION_DECISIONS
Shows qualification decisions - used only in qualification endpoint in API v3. In APIv1 and APIv2 it is used in validation endpoint.
USE_SPARQL_VALIDATOR
Deprecated feature.
Example: ["SHOW_LOOKUP_RESULTS"]
featuresOn
Array of strings (ValidationFeature)
List of activated features.
Items Enum:
Description
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).
EXTERNAL_SOURCES_OFF
Turns off external data sources.
FORCE_EXTERNAL_CALL
Force external call.
IDENTIFIER_CHECKS
Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories.
IDENTIFIER_QUALIFICATION
Turns on identifier qualification (standard) which enables to qualify EU VAT identifiers.
LAB_BETA
Deprecated feature.
QUALIFICATION_SILENT_MODE
If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.
SHOW_BUSINESSPARTNER
Shows business partner that was used in the request.
SHOW_DATA_DEFECTS
Shows found data defects - usually it is turned on.
SHOW_DEBUG_INFO
Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).
SHOW_DECISIONS
Deprecated feature.
SHOW_LOOKUP_RESULTS
Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).
SHOW_QUALIFICATION_DECISIONS
Shows qualification decisions - used only in qualification endpoint in API v3. In APIv1 and APIv2 it is used in validation endpoint.
USE_SPARQL_VALIDATOR
Deprecated feature.
Example: ["SHOW_LOOKUP_RESULTS"]
ignoredRules
Array of strings (BusinessRuleUrl)
Urls of cdl rules ignored during validation process.
Profile which is used during validation. Default value is STANDARD.
Enum:
Description
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"
Array of objects (RuleCategoryOn)
Categories use for selecting active business rules.
ruleStatuses
Array of strings (RuleStatus)
Enable rules with provided statuses.
Items Enum:
Description
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"]
validationSource
string (ValidationSource)
The sources is an information obtained from the Business Rule telling to which knowledge graph the Business Rule that detected the data defect belongs.
In case of a Business Partner validation the source is usually CDL knowledge graph because it contains business rules specific for BusinessPartner validation.
In case of a Record validation process - two option can be present e.g. CDL and CUSTOM. This depends on if data mapping definition was defined and if business partner validation was executed in the context of record validation.
Enum:
Description
CDL
Allows verifying the validity of a VAT number base on Corporate Data League rules.
BZST
Allows verifying the validity of a Germany VAT number issued by any European Member State.
VIES
Allows verifying the validity of a VAT number issued by any European Member State. For all countries except Germany, the registration data (name and address for which the VAT is registered) can be received as well. For Spain registration, data can only be confirmed but not received by just providing the VAT number.
AT
Allows verifying the validity of a VAT number issued by any European Member State.
CUSTOM
Allows verifying the validity of a VAT number base on custom rules set by customer in th CDQ's wiki.
Example: "VIES"
vatAtRequestor
string
Deprecated
DEPRECATED, use organizational settings to configure.
The requestor’s VAT identifier, required for execution of requests against external data sources.
Example: "AT123456789"
vatDeRequestor
string
Deprecated
DEPRECATED, use organizational settings to configure.
The requestor’s VAT identifier, required for execution of requests against external data sources.