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
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": "5D4BDC415419A70001948311",
  • "profile": "QUICK",
  • "ruleStatuses": [
    ],
  • "featuresOn": [
    ],
  • "ruleCategoriesOn": [],
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "updatedFrom": "2020-07-06T12:14:03.204Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "FINISHED",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "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.

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

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

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

Deactivate features

Items Enum: "ADDRESS_CHECKS" "BANKING_DATA_CHECKS" "BUSINESS_PARTNER_CHECKS" "ENRICH_CATEGORIES" "ENRICH_LEGAL_FORM" "EU_VAT_QUALIFICATION_AT" "EU_VAT_QUALIFICATION_DE" "EU_VAT_QUALIFICATION_STANDARD" "EXTERNAL_SOURCES_OFF" "IDENTIFIER_CHECKS" "IDENTIFIER_QUALIFICATION" "LAB_BETA" "LAB_USE_QUEUES" "QUALIFICATION_SILENT_MODE" "SHOW_BUSINESSPARTNER" "SHOW_DATA_DEFECTS" "SHOW_DEBUG_INFO" "SHOW_DECISIONS" "SHOW_LOOKUP_RESULTS" "SHOW_QUALIFICATION_DECISIONS" "USE_SPARQL_VALIDATOR"
featuresOn
Array of strings

Activate features

Items Enum: "ADDRESS_CHECKS" "BANKING_DATA_CHECKS" "BUSINESS_PARTNER_CHECKS" "ENRICH_CATEGORIES" "ENRICH_LEGAL_FORM" "EU_VAT_QUALIFICATION_AT" "EU_VAT_QUALIFICATION_DE" "EU_VAT_QUALIFICATION_STANDARD" "EXTERNAL_SOURCES_OFF" "IDENTIFIER_CHECKS" "IDENTIFIER_QUALIFICATION" "LAB_BETA" "LAB_USE_QUEUES" "QUALIFICATION_SILENT_MODE" "SHOW_BUSINESSPARTNER" "SHOW_DATA_DEFECTS" "SHOW_DEBUG_INFO" "SHOW_DECISIONS" "SHOW_LOOKUP_RESULTS" "SHOW_QUALIFICATION_DECISIONS" "USE_SPARQL_VALIDATOR" "FORCE_EXTERNAL_CALL"
ignoredRules
Array of strings (BusinessRuleUrl)

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.

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.

storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

updatedFrom
string

Makes the job validate entries which were modified before given date described in ISO-8601 format.

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 longer used.

vatDeRequestor
string

Your German VAT identifier which is used during qualifications

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
{}

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.

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

customKnowledgeGraph
required
string

Identifier for the custom knowledge graph that should be used for validation.

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.

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

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.

ignoredRules
Array of strings (BusinessRuleUrl)

Urls of cdl rules ignored during validation process.

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

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.

storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

updatedFrom
string

Makes the job validate entries which were modified before given date described in ISO-8601 format.

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": "5D4BDC415419A70001948311",
  • "profile": "QUICK",
  • "ruleStatuses": [
    ],
  • "featuresOn": [
    ],
  • "ruleCategoriesOn": [],
  • "dataSourcesOn": [
    ],
  • "dataSourcesOff": [
    ],
  • "updatedFrom": "2020-07-06T12:14:03.204Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "FINISHED",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "result": {
    }
}