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: "2025-07-14T21:16:02Z"
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": "2025-07-14T21:16:02Z",
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "status": "FINISHED",
  • "createdAt": "2025-07-14T21:16:02Z",
  • "finishedAt": "2025-07-14T21:16:02Z",
  • "user": "742429-234242-4343-232323",
  • "progress": "77",
  • "result": {
    }
}