# Start Business Partner Validation Job

Start a new validation job on a provided storage ID.

Endpoint: POST /v2/businesspartnervalidationjobs
Version: 3
Security: apiKey

## Request fields (application/json):

  - `storageId` (string)
    Unique identifier of the Storage.
    Example: "72d6900fce6b326088f5d9d91049e3e6"

  - `profile` (string)
    Profile which is used during validation. Default value is STANDARD.
    Enum: "QUICK", "STANDARD", "QUALIFICATION", "AUTOMATION", "EU_VAT_QUALIFICATION", "DATA_SHARING_QUALITY_GATE", "IDENTIFIER_QUALITY", "ADDRESS_QUALITY", "WORLDWIDE_IDENTIFIER_QUALIFICATION", "FEATURES_OFF"

  - `featuresOn` (array)
    List of features to be activated.
    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"

  - `featuresOff` (array)
    List to be deactivated.
    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"

  - `ruleStatuses` (array)
    Enable rules with provided statuses
    Enum: "RELEASED", "DRAFT", "HYPERCARE"

  - `bzstPrint` (string)
    Request printed confirmation by German BZSt authority
    Example: true

  - `validationSource` (object)
    Source of the validation.

  - `validationSource.type` (object)
    Type of the validation source.

  - `validationSource.type.technicalKey` (string)
    Technical key of the validation source type.
    Example: "VALIDATION_GRAPH"

  - `validationSource.type.description` (string)
    Description of the validation source type.
    Example: "Default CDL Model"

  - `validationSource.value` (string)
    Value of the validation source.
    Example: "CDL"

  - `reportsRequest` (object)
    Parameters for Validation Reports.

  - `reportsRequest.reportsConfiguration` (object)
    Configures if and how Data Validation reports are generated.

  - `reportsRequest.reportsConfiguration.address` (object)
    Configures if and how Address reports are generated.

  - `reportsRequest.reportsConfiguration.address.build` (boolean)
    Enable to generate this report.
    Example: "true"

  - `reportsRequest.reportsConfiguration.businesspartner` (object)
    Configures if and how Business Partner reports are generated.

  - `reportsRequest.reportsConfiguration.identifier` (object)
    Configures if and how Identifier reports are generated.

  - `reportsRequest.reportsConfiguration.overall` (object)
    Configures if and how Overall reports are generated.

  - `reportsRequest.reportsConfiguration.qualification` (object)
    Configures if and how Qualification reports are generated.

  - `reportsRequest.reportsConfiguration.qualityImprovement` (object)
    Configures if and how Quality Improvement reports are generated.

  - `reportsRequest.reportsConfiguration.qualityImprovement.dataValidationJobIds` (array)
    An array which contains Data Validation Job IDs.
    Example: ["6be92567-4327-4463-813f-a8c990410d79","f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"]

  - `reportsRequest.reportsConfiguration.countryShortNames` (array)
    An array which contains country short names (ISO-2 Format).
    Example: "['PL', 'DE', 'CZ', 'SK']"

  - `dataSourcesOn` (array)
    If data sources are disabled by feature toogle you can enable some of them passing their prefixes here

  - `dataSourcesOn.prefix` (string)
    Identifies external Data Source.
    Example: "VIES"

  - `dataSourcesOff` (array)
    Rules with data sources passed here are not used in validation process

  - `ruleCategoriesOn` (array)
    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.

  - `ruleCategoriesOn.url` (string)
    URL of the rule category.
    Example: "https://meta.cdq.com/Identifier_checkdigit"

  - `ruleCategoriesOn.name` (string)
    Name of the rule category.
    Example: "Identifier checkdigit"

  - `ignoredRules` (array)
    Urls of cdl rules ignored during validation process.
    Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

  - `activatedRules` (array)
    Urls of cdl rules that are active during validation process.
    Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

  - `updatedFrom` (string)
    Makes the job validate entries which were modified after given date described in ISO-8601 format.
    Example: "2025-09-01T14:16:48Z"

  - `dataSourceIds` (array)
    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"]

  - `countryShortNames` (array)
    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"]

  - `configurationId` (string)
    Configuration ID used to set up data validation request. If provided, those parameters will be overridden:
* 
* 
*
    Example: "6513d25b63cf07787018790a"

  - `criticalities` (array)
    This parameter can modify criticality level of given rule.

  - `criticalities.businessRuleUrl` (string)
    Represents Data Quality Rule url.
    Example: "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"

  - `criticalities.violationLevel` (string)
    Indicates the criticality of the applied rule. 
If a data defect was found then user will get ,  or  level. Otherwise, it will be NO_DEFECT.
    Enum: "NO_DEFECT", "INFO", "WARNING", "ERROR"

  - `vatAtRequestor` (string)
    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, use organizational settings to configure.

The requestor’s VAT identifier, required for execution of requests against external data sources.
    Example: "DE123456789"

## Response 200 fields (application/json):

  - `storageId` (string)
    Unique identifier of the Storage.
    Example: "72d6900fce6b326088f5d9d91049e3e6"

  - `profile` (string)
    Profile which is used during validation. Default value is STANDARD.
    Enum: "QUICK", "STANDARD", "QUALIFICATION", "AUTOMATION", "EU_VAT_QUALIFICATION", "DATA_SHARING_QUALITY_GATE", "IDENTIFIER_QUALITY", "ADDRESS_QUALITY", "WORLDWIDE_IDENTIFIER_QUALIFICATION", "FEATURES_OFF"

  - `featuresOn` (array)
    List of features to be activated.
    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"

  - `featuresOff` (array)
    List to be deactivated.
    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"

  - `ruleStatuses` (array)
    Enable rules with provided statuses
    Enum: "RELEASED", "DRAFT", "HYPERCARE"

  - `bzstPrint` (string)
    Request printed confirmation by German BZSt authority
    Example: true

  - `validationSource` (object)
    Source of the validation.

  - `validationSource.type` (object)
    Type of the validation source.

  - `validationSource.type.technicalKey` (string)
    Technical key of the validation source type.
    Example: "VALIDATION_GRAPH"

  - `validationSource.type.description` (string)
    Description of the validation source type.
    Example: "Default CDL Model"

  - `validationSource.value` (string)
    Value of the validation source.
    Example: "CDL"

  - `reportsRequest` (object)
    Parameters for Validation Reports.

  - `reportsRequest.reportsConfiguration` (object)
    Configures if and how Data Validation reports are generated.

  - `reportsRequest.reportsConfiguration.address` (object)
    Configures if and how Address reports are generated.

  - `reportsRequest.reportsConfiguration.address.build` (boolean)
    Enable to generate this report.
    Example: "true"

  - `reportsRequest.reportsConfiguration.businesspartner` (object)
    Configures if and how Business Partner reports are generated.

  - `reportsRequest.reportsConfiguration.identifier` (object)
    Configures if and how Identifier reports are generated.

  - `reportsRequest.reportsConfiguration.overall` (object)
    Configures if and how Overall reports are generated.

  - `reportsRequest.reportsConfiguration.qualification` (object)
    Configures if and how Qualification reports are generated.

  - `reportsRequest.reportsConfiguration.qualityImprovement` (object)
    Configures if and how Quality Improvement reports are generated.

  - `reportsRequest.reportsConfiguration.qualityImprovement.dataValidationJobIds` (array)
    An array which contains Data Validation Job IDs.
    Example: ["6be92567-4327-4463-813f-a8c990410d79","f9df6cd4-4414-4719-9fb5-4eb6e5bc04cb"]

  - `reportsRequest.reportsConfiguration.countryShortNames` (array)
    An array which contains country short names (ISO-2 Format).
    Example: "['PL', 'DE', 'CZ', 'SK']"

  - `dataSourcesOn` (array)
    If data sources are disabled by feature toogle you can enable some of them passing their prefixes here

  - `dataSourcesOn.prefix` (string)
    Identifies external Data Source.
    Example: "VIES"

  - `dataSourcesOff` (array)
    Rules with data sources passed here are not used in validation process

  - `ruleCategoriesOn` (array)
    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.

  - `ruleCategoriesOn.url` (string)
    URL of the rule category.
    Example: "https://meta.cdq.com/Identifier_checkdigit"

  - `ruleCategoriesOn.name` (string)
    Name of the rule category.
    Example: "Identifier checkdigit"

  - `ignoredRules` (array)
    Urls of cdl rules ignored during validation process.
    Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

  - `activatedRules` (array)
    Urls of cdl rules that are active during validation process.
    Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

  - `updatedFrom` (string)
    Makes the job validate entries which were modified after given date described in ISO-8601 format.
    Example: "2025-09-01T14:16:48Z"

  - `dataSourceIds` (array)
    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"]

  - `countryShortNames` (array)
    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"]

  - `configurationId` (string)
    Configuration ID used to set up data validation request. If provided, those parameters will be overridden:
* 
* 
*
    Example: "6513d25b63cf07787018790a"

  - `criticalities` (array)
    This parameter can modify criticality level of given rule.

  - `criticalities.businessRuleUrl` (string)
    Represents Data Quality Rule url.
    Example: "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"

  - `criticalities.violationLevel` (string)
    Indicates the criticality of the applied rule. 
If a data defect was found then user will get ,  or  level. Otherwise, it will be NO_DEFECT.
    Enum: "NO_DEFECT", "INFO", "WARNING", "ERROR"

  - `id` (string)
    Unique identifier of a job.
    Example: "35f23c03-1c22-45fe-9484-3ffe769325de"

  - `status` (string)
    Job execution status.
    Example: "RUNNING"

  - `createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-09-01T14:16:48Z"

  - `finishedAt` (string)
    Date of finish (ISO 8601-compliant).
    Example: "2025-09-01T14:16:48Z"

  - `user` (string)
    Unique ID of a user.
    Example: "johndoe"

  - `progress` (integer)
    Progress (%) of the job.
    Example: "77"

  - `vatAtRequestor` (string)
    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, use organizational settings to configure.

The requestor’s VAT identifier, required for execution of requests against external data sources.
    Example: "DE123456789"

## Response 400 fields (application/json):

  - `path` (string)
    Requested path which caused this error.
    Example: "/v2/businesspartners/lookup"

  - `id` (string)
    Unique identifier of an error, usually in a format of .
    Example: "REF_VIES_SERVICE_UNAVAILABLE_300"

  - `timestamp` (string)
    ISO 8601 representation of the timestamp.
    Example: "2025-09-01T14:16:48Z"

  - `message` (string)
    Details about the error.
    Example: "This user is not allowed to access this service."

  - `error` (string)
    RFC 7231 error which belongs to the status code.
    Example: "BAD_REQUEST"

  - `status` (integer)
    RFC 7231 status code for this error.
    Example: "400"