Data Validation API (3)

Download OpenAPI specification:Download

This API provides services used for business partner qualification

Data Validation API

Batch Validation

Everything about Batch Validation

Poll Record Validation Job

Polls the status of a record validation job. The job is finished when the status is either FINISHED or FAILED. If the job is finished, the result can be fetched using the /v2/recordvalidationjobs/{id}/results endpoint.

SecurityapiKey
Request
path Parameters
id
required
string (DataValidationJobId)

ID of the validation report.

Example: ef450653-a3bc-4476-83d3-d67397d475a0
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/v2/recordvalidationjobs/{id}
Request samples 
Response samples 
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "customKnowledgeGraph": "kg_1_m_1",
  • "dataMapperDefinitionId": "ef48bc9f-7fa1-4c4e-8c0d-d1cc3301cc20",
  • "profile": "QUICK",
  • "ruleStatuses": [
    ],
  • "featuresOn": [
    ],
  • "ruleCategoriesOn": [],
  • "ignoredRules": [],
  • "activatedRules": [],
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "updatedFrom": "2024-11-21T10:53:08Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "FINISHED",
  • "createdAt": "2024-11-21T10:53:08Z",
  • "finishedAt": "2024-11-21T10:53:08Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "result": {
    }
}
Read Business Partner Validation Batch Results
Retrieves the results of a Business Partner validation job.


SecurityapiKey 
Request 
path Parameters
id
required
string (LookupJobId) 
ID of the Lookup Job.


 
 Example:  cbed7ac6-a97d-4c23-9060-2a88fa660957
query Parameters
businessPartnerId
Array of strings (BusinessPartnerId) 
Business Partner IDs which should be filtered.


 
 Example:  businessPartnerId=63e635235c06b7396330fe40
limit
integer (Limit) 
Number of results that should be fetched. Maximum 100 results can be returned in one page.


 
 Example:  limit=100
startAfter
string (StartAfter) 
Only records with an ID greater than this ID will be fetched.


 
 Example:  startAfter=5712566172571652
Responses 
200
OK


get/v2/businesspartnervalidationjobs/{id}/results
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}
Read Record Validation Batch Results
Retrieves the results of a record validation job.


SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the Record Validation Job.


 
 Example:  6be92567-4327-4463-813f-a8c990410d79
query Parameters
limit
integer (Limit) 
Number of results that should be fetched. Maximum 100 results can be returned in one page.


 
 Example:  limit=100
recordId
Array of strings
Record IDs which should be filtered.


 
 Example:  recordId=6be92567-4327-4463-813f-a8c990410d79
startAfter
string (StartAfter) 
Used to retrieve the next page of results.


 
 Example:  startAfter=5712566172571652
Responses 
200
OK


get/v2/recordvalidationjobs/{id}/results
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}
Start Business Partner Validation Job
Starts a new validation job on a provided storage ID.


SecurityapiKey 
Request 
Request Body schema: application/json
required
cmd


activatedRules
Array 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))"]
bzstPrint
string
Request printed confirmation by German BZSt authority


 
 Example:  true
configurationId
string (ConfigurationId) 
Configuration ID used to set up data validation request. If provided, those parameters will be overridden:


    

  • profile
    • 

  • featuresOn
    • 

  • featuresOff
    • 



 
 Example:  "6513d25b63cf07787018790a"
countryShortNames
Array of strings (schemas-CountryShortName) 
If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters).


 
 Example:  ["CH"]
Array of objects (Criticality) 
This parameter can modify criticality level of given rule.


 
dataSourceIds
Array of strings (BusinessPartnerStorageDataSourceId) 
If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).


 
 Example:  ["648824a691d8d2503d65103e"]
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


 
featuresOff
Array of strings
List to be deactivated.


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).


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


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.


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.


LAB_USE_QUEUES
Perform uploading processing log with queue. Enable as default.


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.


FORCE_EXTERNAL_CALL
Force external call.


 
 Example:  ["SHOW_LOOKUP_RESULTS"]
featuresOn
Array of strings
List of features to be activated.


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).


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


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.


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.


LAB_USE_QUEUES
Perform uploading processing log with queue. Enable as default.


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.


FORCE_EXTERNAL_CALL
Force external call.


 
 Example:  ["SHOW_LOOKUP_RESULTS"]
ignoredRules
Array 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))"]
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.


 
 Example:  "QUICK"
object (ValidationReportsRequestParams) 
Parameters for Validation Reports.


 
Array of objects (RuleCategory) 
List of rule categories that are used to filter rules by its category. If any value is present then only rules of given category will be promoted to execution.


 
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"]
storageId
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  "72d6900fce6b326088f5d9d91049e3e6"
updatedFrom
string
Makes the job validate entries which were modified after given date described in ISO-8601 format.


 
 Example:  "2024-11-21T10:53:08Z"
object (ValidationSource) 
Source of the validation.


 
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.


 
 Example:  "DE123456789"
Responses 
200
OK


201
Created


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


404
Not Found


post/v2/businesspartnervalidationjobs
Request samples 
application/json
{
  • "storageId": "YOUR_STORAGE_ID",
  • "profile": "EU_VAT_QUALIFICATION",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "ruleStatuses": [
    ],
  • "vatAtRequestor": "AT123456789",
  • "vatDeRequestor": "DE123456789",
  • "bzstPrint": true,
  • "validationSource": "BZST",
  • "reportsRequest": {
    },
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "ruleCategoriesOn": [
    ],
  • "ignoredRules": [
    ],
  • "activatedRules": [
    ],
  • "updatedFrom": "2020-07-06T12:14:03.204Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "configurationId": "string",
  • "criticalities": [
    ]
}
Response samples 
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "profile": "QUICK",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "ruleStatuses": [
    ],
  • "vatAtRequestor": "AT123456789",
  • "vatDeRequestor": "DE123456789",
  • "bzstPrint": true,
  • "validationSource": {
    },
  • "reportsRequest": {
    },
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "ruleCategoriesOn": [],
  • "ignoredRules": [],
  • "activatedRules": [],
  • "updatedFrom": "2024-11-21T10:53:08Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "configurationId": "6513d25b63cf07787018790a",
  • "criticalities": [],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "RUNNING",
  • "createdAt": "2024-11-21T10:53:08Z",
  • "finishedAt": "2024-11-21T10:53:08Z",
  • "user": "johndoe",
  • "progress": "77"
}
Start Record Validation Job
Starts a new validation job on a provided storage ID.


SecurityapiKey 
Request 
Request Body schema: application/json
required
cmd


activatedRules
Array 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))"]
countryShortNames
Array of strings (schemas-CountryShortName) 
If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters).


 
 Example:  ["CH"]
customKnowledgeGraph
required
string
Identifier for the custom knowledge graph that should be used for validation.


 
 Example:  "kg_1_m_1"
dataMapperDefinitionId
string (DataMapperDefinitionId) 
Mapping ID that should be used for the mapping. Overrules a mapping of the knowledge graph (if exists). To run validation against CDL Rules, data mapping definition by given ID must exist and user executing validation needs to have permission to access it.


 
 Example:  "ef48bc9f-7fa1-4c4e-8c0d-d1cc3301cc20"
dataSourceIds
Array of strings (BusinessPartnerStorageDataSourceId) 
If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).


 
 Example:  ["648824a691d8d2503d65103e"]
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.


 
featuresOn
Array of strings
Activate features.


Items Enum: Description
SHOW_LOOKUP_RESULTS
Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).


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


LAB_BETA
Deprecated feature.


ENRICH_LEGAL_FORM
Identify and enriches the legal form of a company.


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


USE_SPARQL_VALIDATOR
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.


EXTERNAL_SOURCES_OFF
Turns off external data sources.


SHOW_BUSINESSPARTNER
Shows business partner that was used in the request.


MED_REG_VALIDATION
If enabled it will execute validation only for MED_REG records. Applies only to Record Validation Job.


 
 Example:  ["SHOW_LOOKUP_RESULTS"]
ignoredRules
Array 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))"]
profile
string
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 (e.g. rules that use external webservices) are not executed. It does not provide a full check comprising all data quality rules, but allows for a rapid, initial assessment of data quality.


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


 
 Example:  "QUICK"
Array of objects (RuleCategory) 
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.


 
 Example:  ["RELEASED"]
storageId
required
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  "72d6900fce6b326088f5d9d91049e3e6"
updatedFrom
string
Makes the job validate entries which were modified after given date described in ISO-8601 format.


 
 Example:  "2024-11-21T10:53:08Z"
Responses 
200
OK


201
Created


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


404
Not Found


post/v2/recordvalidationjobs
Request samples 
application/json
{}
Response samples 
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "customKnowledgeGraph": "kg_1_m_1",
  • "dataMapperDefinitionId": "ef48bc9f-7fa1-4c4e-8c0d-d1cc3301cc20",
  • "profile": "QUICK",
  • "ruleStatuses": [
    ],
  • "featuresOn": [
    ],
  • "ruleCategoriesOn": [],
  • "ignoredRules": [],
  • "activatedRules": [],
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "updatedFrom": "2024-11-21T10:53:08Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "FINISHED",
  • "createdAt": "2024-11-21T10:53:08Z",
  • "finishedAt": "2024-11-21T10:53:08Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "result": {
    }
}