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.
required
object (BusinessPartnerParam)
bzstPrint
string
Request printed confirmation by German BZSt authority
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
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 toogle you can enable some of them passing their prefixes here
Urls of cdl rules ignored during validation process.
profile
string (ValidationProfile)
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.
Array of objects (RuleCategoryOn)
Categories use for selecting active business rules
ruleStatuses
Array of strings (RuleStatus)
Filter for rule status.
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.
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.
vatAtRequestor
string
Deprecated
This param is no loger used.
vatDeRequestor
string
Your German VAT identifier which is used during qualifications