# Understanding the Qualification Process ## Overview ### Introduction This Qualification process introduces [**Tax Guard's**](https://www.cdq.com/products/cdq-tax-guard) capabilities in qualifying **EU VAT identifiers**, an essential step in ensuring compliance with VAT regulations, particularly within the European Union. The **Tax Guard** tool helps businesses verify that the **VAT number**, **business name**, and **address details** provided by their partners are consistent with official records. This validation is crucial for meeting legal requirements, such as those imposed by the **EU VAT Quick Fixes**, and for avoiding penalties and liabilities related to non-compliance. Deliveries of goods and services from German companies to other EU countries are generally exempt from VAT as intra-community supplies, according to § 6a of the German VAT Act (`UStG`). This tax exemption applies to transactions between EU member states, provided certain conditions are met. One key requirement is that the supplying company must establish evidence that the transaction qualifies for the exemption. Specifically, the company must verify and record the buyer's foreign VAT identification number (`VAT-ID`), ensuring it's valid at the time of issuing the invoice. If this proof isn't provided or if the VAT-ID is invalid, the goods or services can't be treated as tax-exempt. Additionally, German companies must ensure that the goods are physically transported from Germany to another EU member state. The supplier must retain documentation that proves the shipment, such as transport or shipping documents, to maintain VAT exemption status. If these conditions aren't fulfilled, the German tax authorities may retroactively impose VAT on the transaction. **Tax Guard** not only checks the validity of the VAT identifier itself but also verifies whether the associated business name and address match the customer-maintained information. This automated qualification process helps reduce the administrative burden of manual checks, mitigates the risk of dealing with fraudulent or non-compliant partners, and ensures that cross-border transactions meet stringent legal and regulatory requirements. CDQ provides the qualification of the following Business Partner attributes: * VAT identifier (national or another specific type, for example, `EU_VAT_ID`), * Name, * Address related to the Business Partner including: * a city, * a street, * an appropriate postcode value. In CDQ data model city is called `locality`and street is called `thoroughfare`. **Tax Guard** supports many different data sources that act as reference data registers. Each Business Partner can be qualified in accordance with a specific register, and CDQ uses only valid and [official registers](https://meta.cdq.com/Category:Data_source) like `VIES`, `AT.FON`, `BZST`, and many others around the world. ### Benefits of Using Tax Guard for EU VAT Validation By implementing **Tax Guard**, businesses can: | **Benefit** | **Description** | | --- | --- | | **Ensure Regulatory Compliance** | Automate the validation of VAT identifiers across EU member states, ensuring compliance with regulations such as the EU VAT Quick Fixes and DAC7. | | **Validate Key Business Partner Information** | Beyond checking VAT numbers, Tax Guard verifies that the Business Partner’s name and address align with official records, reducing the risk of errors and discrepancies. | | **Avoid Financial Penalties** | Ensuring that VAT numbers are valid and aligned with partner data protects your business from potential financial penalties, retroactive VAT charges, or disruptions in tax refunds. | | **Support Cross-Border Transactions** | For businesses engaged in cross-border trade, Tax Guard simplifies the validation process, ensuring that all VAT compliance requirements are met for each transaction, thereby avoiding delays and errors. | | **Minimize Risk** | With the increasing complexity of VAT regulations and the risks of transacting with non-compliant partners, Tax Guard provides an automated solution to minimize exposure to fraud and ensure the legitimacy of Business Partners. | The qualification of Business Partner data, along with informed decision-making, allows companies to determine whether they can trust a partner. **Tax Guard** provides instant access to 18 different data sources and official registers, ensuring up to date and comprehensive data validation. Since January 1, 2020, the EU VAT Quick Fixes have imposed stricter regulations, stating that the zero VAT rate for intra-community supplies only applies if a valid VAT number from another Member State is provided and properly filed through the `VIES` system. If these conditions aren't met, the transaction becomes subject to VAT in the state of dispatch. To avoid assessments and penalties, VAT validation is crucial. These risks can only be minimized by collecting and maintaining accurate customer data. Without automated integrations with tax authorities, many companies still rely on manual verification of VAT registrations, often contacting authorities more than 20 times a day. Effective data quality measurement goes beyond merely confirming the existence of an identifier. It ensures both consistency and accuracy throughout the data. ## Qualification with CDQ Users can perform qualified checks for **business** and **tax identifiers** against data provided by the issuing authorities of these identifiers. This means a user provides a Business Partner that comprises the identifier and the data that's to be validated. This data is then checked against the reference data retrieved by the identifier in the qualification data source. The request is sent at new `/businesspartners/qualify` endpoint, which was introduced to differentiate data validation from qualification tasks. The `/qualify` endpoint is focused on qualifying the following elements of Business Partner data: * identifier, * name, * city, * street, * postcode. In CDQ data model city is called `locality` and street is called `thoroughfare`. Each element is validated by a distinct business rule, ensuring a proper qualification decision. Five possible decisions are fully described in the [Qualification Decisions](#qualification-decisions) section. The main goal of this new endpoint is to provide a robust solution for the qualification process of Business Partner[ data.](#step-2-understand-the-qualification-results) ## Step 2: Understand the qualification results ### Qualification Response Structure The response from the qualification endpoint includes a new field called `qualificationResults`, which contains entries for each identifier of a Business Partner based on the data sources it was checked against. Each `qualificationResults` entry consists of two main components: * the `qualificationDecisionSummary`, which provides an overview of the qualification decisions, * the `qualificationDecisionDetails`, which presents the qualifications related to each target concept. It's important to note that each element in the `qualificationResults` field represents results from only one data source. Therefore, `qualificationResults` is structured as an array, where each element contains qualification decisions from a single data source. ```json { "qualificationResults": [ { "identifier": { }, "businessPartnerStatus": {}, "qualifiedAt": "SOME_VALUE", "dataSourceTechnicalKey": "SOME_VALUE", "dataSourceRequestIdentifiers": [ ], "qualificationDecisionSummary": { }, "qualificationDecisionDetails": [ ] } ], "debugInfo": { }, "businessPartner": {}, "lookupResults" : [], "rulesInError" : [] } ``` ```json { "qualificationDecisionSummary": { "identifierQualificationDecision": "SOME_VALUE", "nameQualificationDecision": "SOME_VALUE", "addressQualificationDecision": "SOME_VALUE", "addressQualificationDecisionDetails": { "localityQualificationDecision": "SOME_VALUE", "postCodeQualificationDecision": "SOME_VALUE", "thoroughfareQualificationDecision": "SOME_VALUE" }, "overallQualificationDecision": "SOME_VALUE" } } ``` ```json { "qualificationDecisionDetails": [ { "businessRule": { "name": "SOME_VALUE", "url": "SOME_VALUE", "ruleStatus": "SOME_VALUE", "violationMessage": "SOME_VALUE" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "SOME_VALUE" }, { "name": "targetInputValue", "value": "SOME_VALUE" }, { "name": "targetReferenceValue", "value": "SOME_VALUE" }, { "name": "dataSourceTechnicalKey", "value": "SOME_VALUE" }, { "name": "dataSourceRequestIdentifier", "value": "SOME_VALUE" } ], "cdqId": "SOME_VALUE", "decision": "SOME_VALUE", "error": {} } ] } ``` A response from the `/businesspartners/qualify` endpoint follows a specific structure as detailed in the qualification response example preceding. Within this structure, `SOME_VALUE` can denote various types of elements, including: * identifier, * name, * date and time, * decision, * other values. Generally, a `key`, such as `qualifiedAt` or `dataSourceRequestIdentifiers`, is placed before the value, providing insights into the expected content. **Detailed response structure explanation**: The `qualificationResults` top structure includes the following elements: | **Property Name** | **Description** | | --- | --- | | **identifier** | The value and type of an identifier. | | **businessPartnerStatus** | The status of a business partner if provided by a reference data source (it might be unknown). | | **qualifiedAt** | The timestamp when the check was performed. | | **dataSourceTechnicalKey** | The data source that was queried. | | **dataSourceRequestIdentifier** | For the `VIES` data source, this field provides a request identifier confirming that a request has been sent; this feature requires the `FORCE_EXTERNAL_CALL` setting to be enabled. | | **qualificationDecisionSummary** | A summary of the qualification decisions. | | **qualificationDecisionDetails** | Detailed information about each decision obtained. | | **executionContextProperties** | A set of execution context properties represented as `"name": "value"` pairs. Currently, the following property names are available: | The `qualificationDecisionSummary`, `qualificationDecisionDetails` and `executionContextProperties` details are listed below. The `qualificationDecisionSummary` top structure includes the following elements: | **Property Name** | **Description** | | --- | --- | | **identifierQualificationDecision** | Decision regarding the provided identifier. | | **nameQualificationDecision** | Decision about the Business Partner's name. | | **addressQualificationDecision** | Decision based on the provided address fields, calculated using decisions about postcode, locality, and thoroughfare. | | **addressQualificationDecisionDetails** | Detailed information about address decisions, which includes: `localityQualificationDecision`, `postCodeQualificationDecision`, and `thoroughfareQualificationDecision`. | | **overallQualificationDecision** | The overall decision, determined by the following hierarchy: `NOT_PROCESSED` < `NO_INPUT_PROVIDED` < `VALID` < `NO_REFERENCE_AVAILABLE` < `INVALID` < `EXECUTION_ERROR`. This hierarchy represents the highest decision based on the previous decisions about the identifier, name, locality, postcode, and thoroughfare. | The `qualificationDecisionDetails`structure includes the following elements: - **`businessRule`**: The specific rule that led to a decision. | **Property Name** | **Description** | | --- | --- | | **name** | The name of the rule. | | **url** | The rule's URL on our Wiki. | | **ruleStatus** | The current status of the rule: `HYPERCARE` or `RELEASED`. | | **violationMessage** | A message detailing any violations related to defective data. | The `executionContextProperties` structure includes the following elements: | **Property Name** | **Description** | | --- | --- | | **qualificationTarget** | The target type being qualified, with possible values of `IDENTIFIER`, `NAME_LOCAL`, `CITY`, `STREET`, and `POST_CODE_REGULAR`. | | **targetInputValue** | The value provided by a user. | | **targetReferenceValue** | The value returned by a reference data source (e.g., `VIES`). | | **dataSourceTechnicalKey** | The queried data source (e.g., `VIES`, `BZST`, `AT.FON`). | | **dataSourceRequestIdentifier** | The request identifier provided by `VIES`. | - `cdqId` - The `CDQ ID` value, if it exists, which uniquely identifies the data source and identifier for a Business Partner. - `decision` - The current decision returned by the rule. - `error` - If the check fails, an appropriate error message is provided, including an optional ID value. If applicable, the `rulesInError` object will contain a list of failed rules. The qualification response may also include a `debugInfo` structure, which provides additional details about the qualification process. This includes statistics on executed and failed rules, categories of rules considered, and activated data sources. Additionally, if available, it provides a raw response from external data sources. To access the `debugInfo` data, users must enable specific feature. More information about potential structures that the `/qualify` endpoint may return can be found in the [Qualifications Profiles](/documentation/articles/processes/tax-guard-qualification-process/#qualification-profiles) and [Qualification Features](/documentation/articles/processes/tax-guard-qualification-process/#qualification-features) sections. ### Qualification Decisions Each rule execution and each qualification decision should result in one of the following possible values: | **Decision** | **Description** | | --- | --- | | **VALID** | The input value and the reference value provided by the qualification data source are deemed congruent. | | **INVALID** | There is no congruency between the input value and the reference value provided by the qualification data source. | | **NOT_PROCESSED** | There is no applicable rule for qualifying this specific target, a rule has been deactivated, or the particular data field can't be processed. | | **NO_INPUT_PROVIDED** | No input value was provided, making it impossible to compare it with the reference value from the qualification data source. | | **NO_REFERENCE_AVAILABLE** | No reference value was provided by the qualification data source, preventing a comparison. This may occur if such a value genuinely doesn't exist, or if there was an issue with mapping and transforming the raw data from the qualification data source, resulting in an empty value. A user should review these cases. | | **EXECUTION_ERROR** | The rule wasn't executed properly due to an internal software issue or unavailability of the qualification data source (such as downtimes or connection lags). | ### Qualification Profiles The `/businesspartners/qualify` endpoint provides the following profiles: #### EU_TAX_QUALIFICATION `EU_TAX_QUALIFICATION` profile uses `VIES` as a default data source for all European Union countries. However, to fully qualify, **German Business Partners**, `AT.FON`is the only possible options. Take into account that this requires activation of `AT.FON` as well as its credentials. `VIES` doesn't provide appropriate values for name, thoroughfare, postcode, and city for a **German Business Partner**. In the `EU_TAX_QUALIFICATION` profile, a user can indicate the usage of specific data sources, such as `AT.FON`, `BZST`, or `VIES`, by providing the exact value in the `dataSources` option. If a user requests another [data source](https://meta.cdq.com/Category:Data_source), then only the requested data source is used as a reference. To use `BZST` instead of `VIES` the user needs to provide the following option: ```json { "dataSources": ["BZST"] } ``` In this case, `BZST` replaces `VIES` when qualifying identifier, name, thoroughfare, postcode, and city. To use `VIES` and `BZST` together, the user has to simply indicate all data sources: ```json { "dataSources": ["VIES", "BZST"] } ``` It's worth noting that obtained results are separated by a data source and what follows, qualification decisions are also separated. In this profile, the following options are available: * `dataSources` allows for the following values to be used: `VIES`, `BZST`, or `AT.FON`. For example, a user can combine different data sources: * `"dataSources": "VIES"` - has the same effect as the default setting in the `EU_TAX_QUALIFICATION` profile but without usage of `AT.FON`, * `"dataSources": "BZST"` - provides qualification decisions come only from `BZST`, * `"dataSources": "VIES", "BZST"` - provides qualification decisions from `VIES` and `BZST` with results separated by each data source, * `"dataSources": "VIES", "BZST", "AT.FON"` - provides qualification decisions from `VIES`, `BZST`, and `AT.FON` data sources with results separated by each data source, * features as described in the [Features Section](#qualification-features) that's common for both `EU_TAX_QUALIFICATION` and `WORLDWIDE_TAX_QUALIFICATION` profiles. #### WORLDWIDE_TAX_QUALIFICATION `WORLDWIDE_TAX_QUALIFICATION` profile uses `VIES` in the same way as in the `EU_TAX_QUALIFICATION` profile but, additionally, uses other data sources for countries outside European Union. However, in some cases, additional credentials are needed. To provide them, please configure access to available data sources in a workspace’s global settings. The following options are available: * provide `"dataSources": ["VIES", "BZST", "AT.FON"]` as data sources, which equals the "`EU_TAX_QUALIFICATION` profile with the same data sources turned on. * provide any data sources supported by CDQ rules. Currently, 18 data sources are available for qualification: | Code | Description | | --- | --- | | `AR.NRC` | National Registration Code for Argentina | | `AT.CR` | Commercial Register number for Austria | | `AT.FON` | Fiscal Organization Number for Austria | | `AU.BR` | Business Registration number for Australia | | `BR.RF` | Federal Revenue number for Brazil | | `BZST` | Federal Tax Office identifier for Germany | | `CA.CR` | Corporate Registry number for Canada | | `CH.UIDR` | Unified Business Identification Register for Switzerland | | `CZ.REE` | Register of Economic Entities for Czech Republic | | `DK.CR` | Central Register of Companies for Denmark | | `EU.EORI` | Economic Operators Registration and Identification for EU | | `FR.RC` | Registre du Commerce (Trade Register) for France | | `NO.RBE` | Register of Business Enterprises for Norway | | `PL.NOBR` | National Official Business Register for Poland | | `SG.BR` | Business Registration number for Singapore | | `UK.EORI` | Economic Operators Registration and Identification for the UK | | `UK.VAT` | Value Added Tax registration number for the United Kingdom | | `VIES` | VAT Information Exchange System for the European Union | The default option, when the `dataSources` field isn't provided, indicates the use of 17 data sources. `BZST` is excluded because `AT.FON` is designated for German Business Partners, while `VIES` is applied for other European Union Business Partners. ### Qualification Features For both qualification profiles, the feature list is provided, which can be set when invoking a request using the `/qualify` endpoint: * `"featuresOn": ["FORCE_EXTERNAL_CALL"]` - requires a direct call to a reference data source whenever possible. This can be used to get the confirmation of a request from the `VIES` data source or any other data source that confirms a request. * `"featuresOn": ["SHOW_LOOKUP_RESULTS"]` - displays lookup results and identifies the Business Partner considered during qualification. Business partner data is provided for each queried data source. Thus, it might result in more than one Business Partner. * `"featuresOn": ["SHOW_BUSINESS_PARTNER"]` - provides the Business Partner record sent for qualification. It's the same record as provided in the request. It can be used for the user’s convenience to have a request and response in one resulting structure. * `"featuresOn": ["SHOW_DEBUG_INFO"]` - provides additional information about the qualification process (number of applied rules, external services response, etc.). All the features can be set together in the following way: ```json { "featuresOn": [ "FORCE_EXTERNAL_CALL", "SHOW_LOOKUP_RESULTS", "SHOW_BUSINESS_PARTNER", "SHOW_DEBUG_INFO" ] } ``` A user can combine the necessary features based on their business needs, allowing for any combination of the specified features. Additionally, the feature `SHOW_DEBUG_INFO` is always enabled. If a user wishes to turn off this feature, their request must include the following parameter: `"featuresOff": ["SHOW_DEBUG_INFO"]`. All other features are turned off by default. ### Accesss to the `/businesspartners/qualify` endpoint Tax Guard is available under the `/businesspartners/qualify` endpoint. API Documentation Check the [`/businesspartners/qualify` endpoint](https://developer.cdq.com/reference-docs/data-validation/V3/tag/Business-Partners/#tag/Business-Partners/paths/~1v3~1businesspartners~1qualify/post) documentation. Tutorial Check the detailed tutorial on how to [create an API key](https://developer.cdq.com/documentation/instructions/authentication/). To execute qualification process user needs to provide: * qualification profile, * a Business Partner. Example request: ```curl curl -i -X POST \ https://api.cdq.com/data-validation/rest/v3/businesspartners/qualify \ -H 'Content-Type: application/json' \ -H 'X-API-KEY: YOUR_API_KEY_HERE' \ -d '{ "profile": "EU_TAX_QUALIFICATION", "businessPartner": { "names": [ { "value": "SAS DB COMPANY" } ], "identifiers": [ { "value": "FR35852293547", "type": { "technicalKey": "EU_VAT_ID_FR" } } ], "addresses": [ { "country": { "shortName": "FR" }, "localities": [ { "value": "Roubaix" } ], "postCodes": [ { "value": "59100" } ], "thoroughfares": [ { "value": "Rue De Tourcoing" } ] } ] } }' ``` All examples consist solely of data fields, which are provided through the -d parameter. All required attributes and values are included, except for the user's credentials in the `X-API-KEY` and the endpoint's URL address. ### Qualifications Examples This section presents two sets of example requests and responses to illustrate the capabilities of the new `/businesspartners/qualify` endpoint. The results are analyzed based on the descriptions provided in the [Qualification with CDQ](#qualification-with-cdq) section. * The [first](#simple-request-with-default-settings) set consists of simple requests with default settings for the two available profiles. * The [second](#complex-requests-with-advanced-settings) set includes more complex examples that use different features, resulting in slightly different outcomes, such as the `VIES` request identifier being missing. #### Simple Request With Default settings ##### Profile EU_TAX_QUALIFICATION In this set of examples, the `EU_TAX_QUALIFICATION` profile is used to cover the qualification of all European Union countries. 1) Qualify French Business Partner using the default settings of the `EU_TAX_QUALIFICATION` profile. The Business Partner's name and all other atributes are correct. Request example: ```json { "profile": "EU_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "businessPartner": { "names": [ { "value": "SAS DB COMPANY" } ], "identifiers": [ { "value": "FR35852293547", "type": { "technicalKey": "EU_VAT_ID_FR" } } ], "addresses": [ { "country": { "shortName": "FR" }, "localities": [ { "value": "Roubaix" } ], "postCodes": [ { "value": "59100" } ], "thoroughfares": [ { "value": "Rue De Tourcoing" } ] } ] } } ``` In this example, the `FORCE_EXTERNAL_CALL` feature is used to reach an external data source, specifically `VIES` as the default data source in this profile. details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "FR35852293547", "type": { "technicalKey": "EU_VAT_ID_FR" } }, "qualifiedAt": "2024-06-04T09:59:06.142592236", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [ { "dataSourceTechnicalKey": "VIES", "value": "WAPIAAAAY_isCUQc" } ], "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Rue De Tourcoing" }, { "name": "targetReferenceValue", "value": "Rue De Tourcoing" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCUQc" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "59100" }, { "name": "targetReferenceValue", "value": "59100" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCUQc" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "SAS DB COMPANY" }, { "name": "targetReferenceValue", "value": "SAS DB COMPANY" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCUQc" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Roubaix" }, { "name": "targetReferenceValue", "value": "Roubaix" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCUQc" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "FR35852293547" }, { "name": "targetReferenceValue", "value": "FR35852293547" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCUQc" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} } ] } ], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-06-04T09:59:06.070730441Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCUQc" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCUQc\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.070730441Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCUQc" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCUQc\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.070730441Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCUQc" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCUQc\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.070730441Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCUQc" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCUQc\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.070730441Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCUQc" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCUQc\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "AT.FON" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" } ] } }, "businessPartner": {} } ``` In the result, every input data is in accordance with the official registry, and the debugInfo field contains information about the actual response from `VIES` along with statistics about the executed rules, totaling 5 in this case. 1) Qualify French Business Partner using the default settings of the `EU_TAX_QUALIFICATION` profile. The Business Partner's name is wrong. Request example: ```json { "profile": "EU_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "businessPartner": { "names": [ { "value": "Deutsche Bahn" } ], "identifiers": [ { "value": "FR35852293547", "type": { "technicalKey": "EU_VAT_ID_FR" } } ], "addresses": [ { "country": { "shortName": "FR" }, "localities": [ { "value": "Roubaix" } ], "postCodes": [ { "value": "59100" } ], "thoroughfares": [ { "value": "Rue De Tourcoing" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "FR35852293547", "type": { "technicalKey": "EU_VAT_ID_FR" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-04T09:59:06.832720493", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [ { "dataSourceTechnicalKey": "VIES", "value": "WAPIAAAAY_isCgXI" } ], "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "INVALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "INVALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Rue De Tourcoing" }, { "name": "targetReferenceValue", "value": "Rue De Tourcoing" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCgXI" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "59100" }, { "name": "targetReferenceValue", "value": "59100" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCgXI" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "Deutsche Bahn" }, { "name": "targetReferenceValue", "value": "SAS DB COMPANY" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCgXI" } ], "cdqId": "VIES:FR35852293547", "decision": "INVALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Roubaix" }, { "name": "targetReferenceValue", "value": "Roubaix" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCgXI" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (France), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(France),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (France)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "FR35852293547" }, { "name": "targetReferenceValue", "value": "FR35852293547" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_isCgXI" } ], "cdqId": "VIES:FR35852293547", "decision": "VALID", "error": {} } ] } ], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-06-04T09:59:06.771923554Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCgXI" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCgXI\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.771923554Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCgXI" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCgXI\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.771923554Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCgXI" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCgXI\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.771923554Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCgXI" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCgXI\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-04T09:59:06.771923554Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_isCgXI" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"35852293547\"},\"requestDate\":{\"value\":\"2024-06-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"FR\"},\"valid\":{\"value\":true},\"traderAddress\":{\"value\":\"89 RUE DE TOURCOING\\n59100 ROUBAIX\"},\"traderName\":{\"value\":\"SAS DB COMPANY\"},\"traderCompanyType\":{\"value\":\"---\"},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_isCgXI\"},\"referenceAddressDto\":{\"version\":{\"characterSet\":{\"name\":\"International\",\"technicalKey\":\"INTERNATIONAL\"},\"language\":{\"name\":\"en\",\"technicalKey\":\"en\"}},\"metadata\":{},\"country\":{\"shortName\":\"FR\",\"value\":\"France\"},\"postCodes\":[{\"value\":\"59100\"}],\"localities\":[{\"type\":{\"name\":\"City\",\"url\":\"https://meta.cdq.com/Address/locality/type/city\",\"technicalKey\":\"CITY\"},\"shortName\":\"Roubaix\",\"value\":\"Roubaix\"}],\"thoroughfares\":[{\"type\":{\"name\":\"Street\",\"url\":\"https://meta.cdq.com/Address/thoroughfare/type/street\",\"technicalKey\":\"STREET\"},\"shortName\":\"Rue De Tourcoing\",\"number\":\"89\",\"value\":\"Rue De Tourcoing\",\"name\":\"RUE DE TOURCOING\"}]},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "AT.FON" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" } ] } }, "businessPartner": {} } ``` The `nameQualificationDecision` in the response body is `INVALID`. In this case, the external data source (`VIES`) gave the correct value for the company. This isn't always true for certain data sources and countries, which can only verify whether a value is correct or not: - `VIES` for Spanish Business Partners can only inform if the value is `VALID` or `INVALID`, - `VIES` for German Business Partners is able to provide the validity of an identifier only, - `BZST` for all European Union countries, except Germany, can only provide information about the validity of checked value, - `BZST` does not provide any results for German Business Partners. br 3. Qualify valid German Business Partner with `AT.FON` but errors occurred. Request example: ```json { "profile": "EU_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "businessPartner": { "names": [ { "value": "CDQ GmbH" } ], "identifiers": [ { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } } ], "addresses": [ { "country": { "shortName": "DE" }, "localities": [ { "value": "Friedrichshafen" } ], "postCodes": [ { "value": "88045" } ], "thoroughfares": [ { "value": "Albrechtstraße" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-04T09:59:23.380796082", "dataSourceTechnicalKey": "AT.FON", "qualificationDecisionSummary": { "identifierQualificationDecision": "EXECUTION_ERROR", "nameQualificationDecision": "EXECUTION_ERROR", "addressQualificationDecision": "EXECUTION_ERROR", "addressQualificationDecisionDetails": { "localityQualificationDecision": "EXECUTION_ERROR", "postCodeQualificationDecision": "EXECUTION_ERROR", "thoroughfareQualificationDecision": "EXECUTION_ERROR" }, "overallQualificationDecision": "EXECUTION_ERROR" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Albrechtstraße" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "N/A", "decision": "EXECUTION_ERROR", "error": { "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible." } }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "88045" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "N/A", "decision": "EXECUTION_ERROR", "error": { "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible." } }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "CDQ GmbH" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "N/A", "decision": "EXECUTION_ERROR", "error": { "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible." } }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Friedrichshafen" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "N/A", "decision": "EXECUTION_ERROR", "error": { "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible." } }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "DE307699628" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "N/A", "decision": "EXECUTION_ERROR", "error": { "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible." } } ] } ], "debugInfo": { "businessRulesExecutionSummary": { "numberOfRules": 10, "numberOfExecutions": 5, "numberOfFails": 5, "failures": [ { "externalId": "7a01d303-f035-4f34-b0b1-dc6676ef8169", "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible.", "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED" } }, { "externalId": "7a01d303-f035-4f34-b0b1-dc6676ef8169", "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible.", "businessRule": { "name": "Locality Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED" } }, { "externalId": "7a01d303-f035-4f34-b0b1-dc6676ef8169", "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible.", "businessRule": { "name": "Name Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED" } }, { "externalId": "7a01d303-f035-4f34-b0b1-dc6676ef8169", "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible.", "businessRule": { "name": "Post code Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED" } }, { "externalId": "7a01d303-f035-4f34-b0b1-dc6676ef8169", "message": "Error from AT.FON: The query for the specified UID number has already been carried out twice on this day. A more frequent query via web service is not possible.", "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED" } } ], "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "AT.FON" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" } ] } }, "businessPartner": {} } ``` The qualification process in this case resulted in only one decision: `EXECUTION_ERROR`. This occurred because `AT.FON` allows a maximum of two checks per day for the same Business Partner. Since the partner had already been queried twice today, `AT.FON` cannot qualify the given Business Partner. Consequently, it's also not possible to qualify it. Let's modify the request example by setting the `FORCE_EXTERNAL_CALL` feature as disabled. Request example: ```json { "profile": "EU_TAX_QUALIFICATION", "featuresOff": [ "FORCE_EXTERNAL_CALL" ], "businessPartner": { "names": [ { "value": "CDQ GmbH" } ], "identifiers": [ { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } } ], "addresses": [ { "country": { "shortName": "DE" }, "localities": [ { "value": "Friedrichshafen" } ], "postCodes": [ { "value": "88045" } ], "thoroughfares": [ { "value": "Albrechtstraße" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-04T10:00:14.966474398", "dataSourceTechnicalKey": "AT.FON", "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Albrechtstraße" }, { "name": "targetReferenceValue", "value": "Albrechtstraße" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "AT.FON:DE307699628", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "88045" }, { "name": "targetReferenceValue", "value": "88045" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "AT.FON:DE307699628", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "CDQ GmbH" }, { "name": "targetReferenceValue", "value": "CDQ GmbH" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "AT.FON:DE307699628", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Friedrichshafen" }, { "name": "targetReferenceValue", "value": "Friedrichshafen" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "AT.FON:DE307699628", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Germany), Data source:AT.FON)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:AT.FON)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "DE307699628" }, { "name": "targetReferenceValue", "value": "DE307699628" }, { "name": "dataSourceTechnicalKey", "value": "AT.FON" } ], "cdqId": "AT.FON:DE307699628", "decision": "VALID", "error": {} } ] } ], "debugInfo": { "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "AT.FON" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" } ] } }, "businessPartner": {} } ``` In this particular case, results were obtained from local storage without direct access to `AT.FON`. As a result, the given Business Partner was qualified and proved to be `VALID`. ##### Profile WORLDWIDE_TAX_QUALIFICATION In this set of examples, the `WORLDWIDE_TAX_QUALIFICATION` profile covers the qualification of all countries around the world, all that CDQ is able to check. br 1. Qualify Czech Business Partner using `CZ.REE` register. Use `dataSources` field to indicate, which data source should be queried. In this case, need to use the `WORLDWIDE_TAX_QUALIFICATION` profile since the `EU_TAX_QUALIFICATION` profile allows using only `VIES`, `AT.FON`, and `BZST`. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "CZ.REE" ], "businessPartner": { "names": [ { "value": "BMRC Group s.r.o." } ], "identifiers": [ { "value": "45537011", "type": { "technicalKey": "CZ_ICO" } } ], "addresses": [ { "country": { "shortName": "CZ" }, "localities": [ { "value": "Praha" } ], "postCodes": [ { "value": "17000" } ], "thoroughfares": [ { "value": "Pod dráhou" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "45537011", "type": { "technicalKey": "CZ_ICO" } }, "businessPartnerStatus": { "type": { "name": "Active", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/active", "technicalKey": "ACTIVE" } }, "qualifiedAt": "2024-06-12T08:17:55.879392", "dataSourceTechnicalKey": "CZ.REE", "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (ICO number (Czech Republic), Data source:CZ.REE)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(ICO_number_(Czech_Republic),_Data_source:CZ.REE)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the ICO number (Czech Republic)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Pod dráhou" }, { "name": "targetReferenceValue", "value": "Pod dráhou" }, { "name": "dataSourceTechnicalKey", "value": "CZ.REE" } ], "cdqId": "CZ.REE:45537011", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (ICO number (Czech Republic), Data source:CZ.REE)", "url": "https://meta.cdq.com/Post_code_Qualification_(ICO_number_(Czech_Republic),_Data_source:CZ.REE)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the ICO number (Czech Republic)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "17000" }, { "name": "targetReferenceValue", "value": "17000" }, { "name": "dataSourceTechnicalKey", "value": "CZ.REE" } ], "cdqId": "CZ.REE:45537011", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (ICO number (Czech Republic), Data source:CZ.REE)", "url": "https://meta.cdq.com/Name_Qualification_(ICO_number_(Czech_Republic),_Data_source:CZ.REE)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the ICO number (Czech Republic)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "BMRC Group s.r.o." }, { "name": "targetReferenceValue", "value": "BMRC Group s.r.o." }, { "name": "dataSourceTechnicalKey", "value": "CZ.REE" } ], "cdqId": "CZ.REE:45537011", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (ICO number (Czech Republic), Data source:CZ.REE)", "url": "https://meta.cdq.com/Locality_Qualification_(ICO_number_(Czech_Republic),_Data_source:CZ.REE)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the ICO number (Czech Republic)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Praha" }, { "name": "targetReferenceValue", "value": "Praha" }, { "name": "dataSourceTechnicalKey", "value": "CZ.REE" } ], "cdqId": "CZ.REE:45537011", "decision": "VALID", "error": {} } ] } ], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-06-12T08:17:55.819185595Z", "additionalInformation": [ { "key": "rawJson", "value": "[{\"ico\":\"45537011\",\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"pravniForma\":\"112\",\"financniUrad\":\"007\",\"datumVzniku\":\"1992-03-10\",\"datumAktualizace\":\"2024-04-04\",\"dic\":\"CZ45537011\",\"icoId\":\"45537011\",\"adresaDorucovaci\":{\"radekAdresy1\":\"Pod dráhou 1638/7\",\"radekAdresy2\":\"Holešovice\",\"radekAdresy3\":\"17000 Praha 7\"},\"seznamRegistraci\":{\"stavZdrojeVr\":\"AKTIVNI\",\"stavZdrojeRes\":\"AKTIVNI\",\"stavZdrojeRzp\":\"AKTIVNI\",\"stavZdrojeNrpzs\":\"NEEXISTUJICI\",\"stavZdrojeRpsh\":\"NEEXISTUJICI\",\"stavZdrojeRcns\":\"NEEXISTUJICI\",\"stavZdrojeSzr\":\"NEEXISTUJICI\",\"stavZdrojeDph\":\"AKTIVNI\",\"stavZdrojeSd\":\"NEEXISTUJICI\",\"stavZdrojeIr\":\"NEEXISTUJICI\",\"stavZdrojeCeu\":\"NEEXISTUJICI\",\"stavZdrojeRs\":\"NEEXISTUJICI\",\"stavZdrojeRed\":\"AKTIVNI\"},\"primarniZdroj\":\"vr\",\"dalsiUdaje\":[{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"res\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"rzp\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"spisovaZnacka\":\"C 362302/MSPH\",\"datovyZdroj\":\"vr\"}],\"czNace\":[\"00\",\"231\",\"23130\",\"25\",\"25620\",\"257\",\"28\",\"33200\",\"432\",\"43220\",\"461\",\"46900\",\"471\",\"7112\",\"90020\"],\"subRegistrSzr\":\"szr\"}]" } ] }, { "status": 200, "timestamp": "2024-06-12T08:17:55.819185595Z", "additionalInformation": [ { "key": "rawJson", "value": "[{\"ico\":\"45537011\",\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"pravniForma\":\"112\",\"financniUrad\":\"007\",\"datumVzniku\":\"1992-03-10\",\"datumAktualizace\":\"2024-04-04\",\"dic\":\"CZ45537011\",\"icoId\":\"45537011\",\"adresaDorucovaci\":{\"radekAdresy1\":\"Pod dráhou 1638/7\",\"radekAdresy2\":\"Holešovice\",\"radekAdresy3\":\"17000 Praha 7\"},\"seznamRegistraci\":{\"stavZdrojeVr\":\"AKTIVNI\",\"stavZdrojeRes\":\"AKTIVNI\",\"stavZdrojeRzp\":\"AKTIVNI\",\"stavZdrojeNrpzs\":\"NEEXISTUJICI\",\"stavZdrojeRpsh\":\"NEEXISTUJICI\",\"stavZdrojeRcns\":\"NEEXISTUJICI\",\"stavZdrojeSzr\":\"NEEXISTUJICI\",\"stavZdrojeDph\":\"AKTIVNI\",\"stavZdrojeSd\":\"NEEXISTUJICI\",\"stavZdrojeIr\":\"NEEXISTUJICI\",\"stavZdrojeCeu\":\"NEEXISTUJICI\",\"stavZdrojeRs\":\"NEEXISTUJICI\",\"stavZdrojeRed\":\"AKTIVNI\"},\"primarniZdroj\":\"vr\",\"dalsiUdaje\":[{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"res\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"rzp\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"spisovaZnacka\":\"C 362302/MSPH\",\"datovyZdroj\":\"vr\"}],\"czNace\":[\"00\",\"231\",\"23130\",\"25\",\"25620\",\"257\",\"28\",\"33200\",\"432\",\"43220\",\"461\",\"46900\",\"471\",\"7112\",\"90020\"],\"subRegistrSzr\":\"szr\"}]" } ] }, { "status": 200, "timestamp": "2024-06-12T08:17:55.819185595Z", "additionalInformation": [ { "key": "rawJson", "value": "[{\"ico\":\"45537011\",\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"pravniForma\":\"112\",\"financniUrad\":\"007\",\"datumVzniku\":\"1992-03-10\",\"datumAktualizace\":\"2024-04-04\",\"dic\":\"CZ45537011\",\"icoId\":\"45537011\",\"adresaDorucovaci\":{\"radekAdresy1\":\"Pod dráhou 1638/7\",\"radekAdresy2\":\"Holešovice\",\"radekAdresy3\":\"17000 Praha 7\"},\"seznamRegistraci\":{\"stavZdrojeVr\":\"AKTIVNI\",\"stavZdrojeRes\":\"AKTIVNI\",\"stavZdrojeRzp\":\"AKTIVNI\",\"stavZdrojeNrpzs\":\"NEEXISTUJICI\",\"stavZdrojeRpsh\":\"NEEXISTUJICI\",\"stavZdrojeRcns\":\"NEEXISTUJICI\",\"stavZdrojeSzr\":\"NEEXISTUJICI\",\"stavZdrojeDph\":\"AKTIVNI\",\"stavZdrojeSd\":\"NEEXISTUJICI\",\"stavZdrojeIr\":\"NEEXISTUJICI\",\"stavZdrojeCeu\":\"NEEXISTUJICI\",\"stavZdrojeRs\":\"NEEXISTUJICI\",\"stavZdrojeRed\":\"AKTIVNI\"},\"primarniZdroj\":\"vr\",\"dalsiUdaje\":[{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"res\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"rzp\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"spisovaZnacka\":\"C 362302/MSPH\",\"datovyZdroj\":\"vr\"}],\"czNace\":[\"00\",\"231\",\"23130\",\"25\",\"25620\",\"257\",\"28\",\"33200\",\"432\",\"43220\",\"461\",\"46900\",\"471\",\"7112\",\"90020\"],\"subRegistrSzr\":\"szr\"}]" } ] }, { "status": 200, "timestamp": "2024-06-12T08:17:55.819185595Z", "additionalInformation": [ { "key": "rawJson", "value": "[{\"ico\":\"45537011\",\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"pravniForma\":\"112\",\"financniUrad\":\"007\",\"datumVzniku\":\"1992-03-10\",\"datumAktualizace\":\"2024-04-04\",\"dic\":\"CZ45537011\",\"icoId\":\"45537011\",\"adresaDorucovaci\":{\"radekAdresy1\":\"Pod dráhou 1638/7\",\"radekAdresy2\":\"Holešovice\",\"radekAdresy3\":\"17000 Praha 7\"},\"seznamRegistraci\":{\"stavZdrojeVr\":\"AKTIVNI\",\"stavZdrojeRes\":\"AKTIVNI\",\"stavZdrojeRzp\":\"AKTIVNI\",\"stavZdrojeNrpzs\":\"NEEXISTUJICI\",\"stavZdrojeRpsh\":\"NEEXISTUJICI\",\"stavZdrojeRcns\":\"NEEXISTUJICI\",\"stavZdrojeSzr\":\"NEEXISTUJICI\",\"stavZdrojeDph\":\"AKTIVNI\",\"stavZdrojeSd\":\"NEEXISTUJICI\",\"stavZdrojeIr\":\"NEEXISTUJICI\",\"stavZdrojeCeu\":\"NEEXISTUJICI\",\"stavZdrojeRs\":\"NEEXISTUJICI\",\"stavZdrojeRed\":\"AKTIVNI\"},\"primarniZdroj\":\"vr\",\"dalsiUdaje\":[{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"res\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"datovyZdroj\":\"rzp\"},{\"obchodniJmeno\":[{\"obchodniJmeno\":\"BMRC Group s.r.o.\",\"primarniZaznam\":true}],\"sidlo\":[{\"sidlo\":{\"kodStatu\":\"CZ\",\"nazevStatu\":\"Česká republika\",\"kodKraje\":19,\"nazevKraje\":\"Hlavní město Praha\",\"kodObce\":554782,\"nazevObce\":\"Praha\",\"kodSpravnihoObvodu\":78,\"nazevSpravnihoObvodu\":\"Praha 7\",\"kodMestskehoObvodu\":78,\"nazevMestskehoObvodu\":\"Praha 7\",\"kodMestskeCastiObvodu\":500186,\"kodUlice\":508608,\"nazevMestskeCastiObvodu\":\"Praha 7\",\"nazevUlice\":\"Pod dráhou\",\"cisloDomovni\":1638,\"kodCastiObce\":490067,\"cisloOrientacni\":7,\"nazevCastiObce\":\"Holešovice\",\"kodAdresnihoMista\":85122807,\"psc\":17000,\"textovaAdresa\":\"Pod dráhou 1638/7, Holešovice, 17000 Praha 7\",\"typCisloDomovni\":\"1\",\"standardizaceAdresy\":true},\"primarniZaznam\":true}],\"pravniForma\":\"112\",\"spisovaZnacka\":\"C 362302/MSPH\",\"datovyZdroj\":\"vr\"}],\"czNace\":[\"00\",\"231\",\"23130\",\"25\",\"25620\",\"257\",\"28\",\"33200\",\"432\",\"43220\",\"461\",\"46900\",\"471\",\"7112\",\"90020\"],\"subRegistrSzr\":\"szr\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 4, "numberOfExecutions": 4, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "CZ.REE" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": {} } ``` Proper decisions, statistics, and actual responses were obtained from the `CZ.REE` data source. It's worth noticing that a rule for identifier qualification isn't established, the decision was calculated based on other rules. Since at least one valid pair of the below pairs was found, the identifier is valid. - `identifier: locality`, - `identifier: name`, - `identifier: postcode`, - `identifier: thoroughfare`. br 1. Qualify German Business Partner using `VIES` as a reference data source. `VIES` can only validate German identifiers. Therefore, other results should be marked as `NOT_PROCESSED`. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "VIES" ], "businessPartner": { "names": [ { "value": "CDQ GmbH" } ], "identifiers": [ { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } } ], "addresses": [ { "country": { "shortName": "DE" }, "localities": [ { "value": "Friedrichshafen" } ], "postCodes": [ { "value": "88045" } ], "thoroughfares": [ { "value": "Albrechtstraße" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-05-29T14:54:25.695686349", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [ { "dataSourceTechnicalKey": "VIES", "value": "WAPIAAAAY_E2F63Q" } ], "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "NOT_PROCESSED", "addressQualificationDecision": "NOT_PROCESSED", "addressQualificationDecisionDetails": { "localityQualificationDecision": "NOT_PROCESSED", "postCodeQualificationDecision": "NOT_PROCESSED", "thoroughfareQualificationDecision": "NOT_PROCESSED" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Germany), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "DE307699628" }, { "name": "targetReferenceValue", "value": "DE307699628" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAY_E2F63Q" } ], "cdqId": "VIES:DE307699628", "decision": "VALID", "error": {} } ] } ], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-05-29T14:54:25.645990240Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAY_E2F63Q" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"307699628\"},\"requestDate\":{\"value\":\"2024-05-28T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"DE\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{},\"traderCompanyType\":{},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAY_E2F63Q\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 1, "numberOfExecutions": 1, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "VIES" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": {} } ``` Only one rule was executed, and it provided a `VALID` decision since the given VAT number is indeed valid. 1. Qualify Brazilian Business Partner using `BR.RF` data source. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "BR.RF" ], "businessPartner": { "names": [ { "value": "BAYER S.A." } ], "identifiers": [ { "value": "18459628008108", "type": { "technicalKey": "BR_CNPJ" } } ], "addresses": [ { "country": { "shortName": "BR" }, "localities": [ { "value": "Cambe" } ], "postCodes": [ { "value": "86183752" } ], "thoroughfares": [ { "value": "Afonso Figueiro" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "18459628008108", "type": { "technicalKey": "BR_CNPJ" } }, "businessPartnerStatus": { "type": { "name": "Inactive", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/inactive", "technicalKey": "INACTIVE" } }, "qualifiedAt": "2024-06-12T08:17:58.423719918", "dataSourceTechnicalKey": "BR.RF", "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (CNPJ number (Brazil), Data source:BR.RF)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(CNPJ_number_(Brazil),_Data_source:BR.RF)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the CNPJ number (Brazil)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Afonso Figueiro" }, { "name": "targetReferenceValue", "value": "AFONSO FIGUEIRO" }, { "name": "dataSourceTechnicalKey", "value": "BR.RF" } ], "cdqId": "BR.RF:18459628008108", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (CNPJ number (Brazil), Data source:BR.RF)", "url": "https://meta.cdq.com/Post_code_Qualification_(CNPJ_number_(Brazil),_Data_source:BR.RF)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the CNPJ number (Brazil)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "86183752" }, { "name": "targetReferenceValue", "value": "86183752" }, { "name": "dataSourceTechnicalKey", "value": "BR.RF" } ], "cdqId": "BR.RF:18459628008108", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (CNPJ number (Brazil), Data source:BR.RF)", "url": "https://meta.cdq.com/Name_Qualification_(CNPJ_number_(Brazil),_Data_source:BR.RF)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the CNPJ number (Brazil)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "BAYER S.A." }, { "name": "targetReferenceValue", "value": "BAYER S.A." }, { "name": "dataSourceTechnicalKey", "value": "BR.RF" } ], "cdqId": "BR.RF:18459628008108", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (CNPJ number (Brazil), Data source:BR.RF)", "url": "https://meta.cdq.com/Locality_Qualification_(CNPJ_number_(Brazil),_Data_source:BR.RF)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the CNPJ number (Brazil)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Cambe" }, { "name": "targetReferenceValue", "value": "CAMBE" }, { "name": "dataSourceTechnicalKey", "value": "BR.RF" } ], "cdqId": "BR.RF:18459628008108", "decision": "VALID", "error": {} } ] }], "debugInfo": { "businessRulesExecutionSummary": { "numberOfRules": 4, "numberOfExecutions": 4, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "BR.RF" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": {} } ``` As you can see the business partner is Inactive but we provide `VALID` decisions. The reason behind is that the data (business partner's attributes) are valid but the business partner itself is not in active state right now. From the legal perspective we are leaving the interpretation to a customer. Take into account that sometimes status can be `SUSPENDED` or `IN_LIQUIDATION` and it is always the case when a customer needs to decide what is going to with such a situation. #### Complex Requests with Advanced Settings Qualification endpoint also provides additional settings as mentioned in the [Qualification with CDQ](#qualification-with-cdq) section. The following examples use different profiles and features set. 1. Qualify valid Spanish Business Partner. Additional info about lookup results is obtained by setting the feature `SHOW_LOOKUP_RESULTS` to on, as well as getting Business Partner's structure: `"featuresOn": ["SHOW_BUSINESS_PARTNER"]`. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL", "SHOW_LOOKUP_RESULTS", "SHOW_BUSINESS_PARTNER" ], "businessPartner": { "names": [ { "value": "ATOS SPAIN SA" } ], "identifiers": [ { "value": "ESA28240752", "type": { "technicalKey": "EU_VAT_ID_ES" } } ], "addresses": [ { "country": { "shortName": "ES" }, "localities": [ { "value": "Madrid" } ], "postCodes": [ { "value": "28037" } ], "thoroughfares": [ { "value": "Calle Albarracin" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "ESA28240752", "type": { "technicalKey": "EU_VAT_ID_ES" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-14T12:30:43.777672718", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [ { "dataSourceTechnicalKey": "VIES", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "VALID", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Calle Albarracin" }, { "name": "targetReferenceValue", "value": "Calle Albarracin" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "cdqId": "VIES:ESA28240752", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "28037" }, { "name": "targetReferenceValue", "value": "28037" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "cdqId": "VIES:ESA28240752", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "ATOS SPAIN SA" }, { "name": "targetReferenceValue", "value": "ATOS SPAIN SA" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "cdqId": "VIES:ESA28240752", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Madrid" }, { "name": "targetReferenceValue", "value": "Madrid" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "cdqId": "VIES:ESA28240752", "decision": "VALID", "error": {} }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "ESA28240752" }, { "name": "targetReferenceValue", "value": "ESA28240752" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" } ], "cdqId": "VIES:ESA28240752", "decision": "VALID", "error": {} } ] } ], "lookupResults": [ { "businessPartner": { "addresses": [ { "version": { "characterSet": { "technicalKey": "LATIN" }, "language": { "name": "en", "technicalKey": "en" } }, "country": { "shortName": "ES", "value": "Spain" }, "postCodes": [ { "value": "28037", "type": { "name": "Regular", "url": "https://meta.cdq.com/Address/post_code/type/regular", "technicalKey": "REGULAR" } } ], "localities": [ { "value": "Madrid", "type": { "name": "City", "url": "https://meta.cdq.com/Address/locality/type/city", "technicalKey": "CITY" }, "shortName": "Madrid", "language": {} } ], "thoroughfares": [ { "type": { "name": "Street", "url": "https://meta.cdq.com/Address/thoroughfare/type/street", "technicalKey": "STREET" }, "shortName": "Calle Albarracin", "value": "Calle Albarracin", "language": {} } ] } ], "names": [ { "type": { "url": "https://meta.cdq.com/Business_partner/name/type/vat_registered_name", "name": "VAT Registered Name", "technicalKey": "VAT_REGISTERED" }, "value": "ATOS SPAIN SA", "language": {} } ], "identifiers": [ { "value": "ESA28240752", "type": { "url": "https://meta.cdq.com/European_value_added_tax_identifier_(Spain)", "name": "Value added tax identification number", "technicalKey": "EU_VAT_ID_ES" }, "issuingBody": { "name": "Spanish Tax Administration Agency", "url": "https://meta.cdq.com/Business_partner/identifier/issuing_body/CDQ00046", "technicalKey": "ES_CDQ00046" } } ], "legalForm": { "name": "Sociedad Anónima", "mainAbbreviation": "S.A.", "url": "https://meta.cdq.com/Business_partner/legal_form/technical_key/ES_1035", "technicalKey": "ES_1035" }, "status": {}, "profile": {} }, "address": {}, "dataSource": "VIES", "cdqId": "VIES:ESA28240752" } ], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-06-14T12:30:43.653282021Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2024-06-13T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{\"value\":\"Calle Albarracin\"},\"traderPostcode\":{\"value\":\"28037\"},\"traderCity\":{\"value\":\"Madrid\"},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"1\"},\"traderPostcodeMatch\":{\"value\":\"1\"},\"traderCityMatch\":{\"value\":\"1\"},\"requestIdentifier\":{\"value\":\"453ac768-fb3c-4b9b-8d03-50e09b1eda01\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-14T12:30:43.653282021Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2024-06-13T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{\"value\":\"Calle Albarracin\"},\"traderPostcode\":{\"value\":\"28037\"},\"traderCity\":{\"value\":\"Madrid\"},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"1\"},\"traderPostcodeMatch\":{\"value\":\"1\"},\"traderCityMatch\":{\"value\":\"1\"},\"requestIdentifier\":{\"value\":\"453ac768-fb3c-4b9b-8d03-50e09b1eda01\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-14T12:30:43.653282021Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2024-06-13T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{\"value\":\"Calle Albarracin\"},\"traderPostcode\":{\"value\":\"28037\"},\"traderCity\":{\"value\":\"Madrid\"},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"1\"},\"traderPostcodeMatch\":{\"value\":\"1\"},\"traderCityMatch\":{\"value\":\"1\"},\"requestIdentifier\":{\"value\":\"453ac768-fb3c-4b9b-8d03-50e09b1eda01\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-14T12:30:43.653282021Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2024-06-13T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{\"value\":\"Calle Albarracin\"},\"traderPostcode\":{\"value\":\"28037\"},\"traderCity\":{\"value\":\"Madrid\"},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"1\"},\"traderPostcodeMatch\":{\"value\":\"1\"},\"traderCityMatch\":{\"value\":\"1\"},\"requestIdentifier\":{\"value\":\"453ac768-fb3c-4b9b-8d03-50e09b1eda01\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] }, { "status": 200, "timestamp": "2024-06-14T12:30:43.653282021Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "453ac768-fb3c-4b9b-8d03-50e09b1eda01" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"A28240752\"},\"requestDate\":{\"value\":\"2024-06-13T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"ES\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{\"value\":\"ATOS SPAIN SA\"},\"traderCompanyType\":{},\"traderStreet\":{\"value\":\"Calle Albarracin\"},\"traderPostcode\":{\"value\":\"28037\"},\"traderCity\":{\"value\":\"Madrid\"},\"traderNameMatch\":{\"value\":\"1\"},\"traderCompanyTypeMatch\":{\"value\":\"3\"},\"traderStreetMatch\":{\"value\":\"1\"},\"traderPostcodeMatch\":{\"value\":\"1\"},\"traderCityMatch\":{\"value\":\"1\"},\"requestIdentifier\":{\"value\":\"453ac768-fb3c-4b9b-8d03-50e09b1eda01\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "PL.NOBR" }, { "prefix": "CA.CR" }, { "prefix": "SG.BR" }, { "prefix": "DK.CR" }, { "prefix": "AT.FON" }, { "prefix": "FR.RC" }, { "prefix": "CZ.REE" }, { "prefix": "EU.EORI" }, { "prefix": "AU.BR" }, { "prefix": "UK.VAT" }, { "prefix": "UK.EORI" }, { "prefix": "AT.CR" }, { "prefix": "NO.RBE" }, { "prefix": "BR.RF" }, { "prefix": "CH.UIDR" }, { "prefix": "AR.NRC" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": { "addresses": [ { "version": { "characterSet": {}, "language": {} }, "country": { "shortName": "ES" }, "postCodes": [ { "value": "28037", "type": {} } ], "localities": [ { "value": "Madrid", "type": {}, "language": {} } ], "thoroughfares": [ { "type": {}, "value": "Calle Albarracin", "language": {} } ] } ], "names": [ { "type": {}, "value": "ATOS SPAIN SA", "language": {} } ], "identifiers": [ { "value": "ESA28240752", "type": { "technicalKey": "EU_VAT_ID_ES" }, "issuingBody": {} } ], "legalForm": {}, "status": { "type": {} }, "profile": {} } } ``` Note that `VIES` does not provide accurate information about Spanish Business Partners. If an incorrect identifier (`ESA28240751`) is provided, the response appears as follows: details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "ESA28240751", "type": { "technicalKey": "EU_VAT_ID_ES" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-25T20:19:41.38430389", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [], "qualificationDecisionSummary": { "identifierQualificationDecision": "INVALID", "nameQualificationDecision": "NO_REFERENCE_AVAILABLE", "addressQualificationDecision": "NO_REFERENCE_AVAILABLE", "addressQualificationDecisionDetails": { "localityQualificationDecision": "NO_REFERENCE_AVAILABLE", "postCodeQualificationDecision": "NO_REFERENCE_AVAILABLE", "thoroughfareQualificationDecision": "NO_REFERENCE_AVAILABLE" }, "overallQualificationDecision": "INVALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Calle Albarracin" }, { "name": "dataSourceTechnicalKey", "value": "VIES" } ], "cdqId": "N/A", "decision": "NO_REFERENCE_AVAILABLE", "error": { "message": "Valid request with an Invalid VAT Number", "status": 200 } }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "targetInputValue", "value": "28037" }, { "name": "dataSourceTechnicalKey", "value": "VIES" } ], "cdqId": "N/A", "decision": "NO_REFERENCE_AVAILABLE", "error": { "message": "Valid request with an Invalid VAT Number", "status": 200 } }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "ATOS SPAIN SA" }, { "name": "dataSourceTechnicalKey", "value": "VIES" } ], "cdqId": "N/A", "decision": "NO_REFERENCE_AVAILABLE", "error": { "message": "Valid request with an Invalid VAT Number", "status": 200 } }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Madrid" }, { "name": "dataSourceTechnicalKey", "value": "VIES" } ], "cdqId": "N/A", "decision": "NO_REFERENCE_AVAILABLE", "error": { "message": "Valid request with an Invalid VAT Number", "status": 200 } }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Spain), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Spain),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Spain)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "ESA28240751" }, { "name": "dataSourceTechnicalKey", "value": "VIES" } ], "cdqId": "", "decision": "INVALID", "error": { "message": "Valid request with an Invalid VAT Number", "status": 200 } } ] } ], "lookupResults": [], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-06-25T20:19:41.308371134Z", "additionalInformation": [ { "key": "rawJson", "value": "[]" } ] }, { "status": 200, "timestamp": "2024-06-25T20:19:41.308371134Z", "additionalInformation": [ { "key": "rawJson", "value": "[]" } ] }, { "status": 200, "timestamp": "2024-06-25T20:19:41.308371134Z", "additionalInformation": [ { "key": "rawJson", "value": "[]" } ] }, { "status": 200, "timestamp": "2024-06-25T20:19:41.308371134Z", "additionalInformation": [ { "key": "rawJson", "value": "[]" } ] }, { "status": 200, "timestamp": "2024-06-25T20:19:41.308371134Z", "additionalInformation": [ { "key": "rawJson", "value": "[]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "failures": [], "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "PL.NOBR" }, { "prefix": "CA.CR" }, { "prefix": "SG.BR" }, { "prefix": "DK.CR" }, { "prefix": "AT.FON" }, { "prefix": "FR.RC" }, { "prefix": "CZ.REE" }, { "prefix": "EU.EORI" }, { "prefix": "AU.BR" }, { "prefix": "UK.VAT" }, { "prefix": "UK.EORI" }, { "prefix": "AT.CR" }, { "prefix": "NO.RBE" }, { "prefix": "BR.RF" }, { "prefix": "CH.UIDR" }, { "prefix": "AR.NRC" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": { "addresses": [ { "country": { "shortName": "ES" }, "postCodes": [ { "value": "28037" } ], "localities": [ { "value": "Madrid" } ], "thoroughfares": [ { "value": "Calle Albarracin" } ] } ], "names": [ { "value": "ATOS SPAIN SA" } ], "identifiers": [ { "value": "ESA28240751", "type": { "technicalKey": "EU_VAT_ID_ES" } } ] } } ``` Since the given identifier is `INVALID`, it's not possible to determine if other fields are correct. Thus, the `NO_REFERENCE_AVAILABLE` decision is provided for other checks. It's important to note that `INVALID` is considered a higher value than `NO_REFERENCE_AVAILABLE` in the hierarchy of decisions, resulting in an overall decision of `INVALID`. 1. Qualify the German Business Partners with `BZST` . Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "BZST" ], "businessPartner": { "names": [ { "value": "CDQ GmbH" } ], "identifiers": [ { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } } ], "addresses": [ { "country": { "shortName": "DE" }, "localities": [ { "value": "Friedrichshafen" } ], "postCodes": [ { "value": "88045" } ], "thoroughfares": [ { "value": "Albrechtstraße" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-06-14T13:49:14.961223223", "qualificationDecisionSummary": { "identifierQualificationDecision": "NOT_PROCESSED", "nameQualificationDecision": "NOT_PROCESSED", "addressQualificationDecision": "NOT_PROCESSED", "addressQualificationDecisionDetails": { "localityQualificationDecision": "NOT_PROCESSED", "postCodeQualificationDecision": "NOT_PROCESSED", "thoroughfareQualificationDecision": "NOT_PROCESSED" }, "overallQualificationDecision": "NOT_PROCESSED" }, "qualificationDecisionDetails": [ { "businessRule": {}, "error": { "error": "This identifier is not supported or configuration does not trigger any qualification rules.", "status": 200 } } ] } ], "debugInfo": { "businessRulesExecutionSummary": { "numberOfRules": 0, "numberOfExecutions": 0, "numberOfFails": 0, "dataSourcesOn": [ { "prefix": "BZST" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } }, "businessPartner": {} } ``` `BZST` data source doesn't allow for the qualification of German companies. As a result, the `NOT_PROCESSED` decisions was obtained. To execute the qualification both, `BZST` and `VIES` data sources must be activated. Look at the following example. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "BZST", "VIES" ], "businessPartner": { "names": [ { "value": "CDQ GmbH" } ], "identifiers": [ { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } } ], "addresses": [ { "country": { "shortName": "DE" }, "localities": [ { "value": "Friedrichshafen" } ], "postCodes": [ { "value": "88045" } ], "thoroughfares": [ { "value": "Albrechtstraße" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-07-04T14:21:06.640107795", "dataSourceTechnicalKey": "BZST", "dataSourceRequestIdentifiers": [], "qualificationDecisionSummary": { "identifierQualificationDecision": "NOT_PROCESSED", "nameQualificationDecision": "NOT_PROCESSED", "addressQualificationDecision": "NOT_PROCESSED", "addressQualificationDecisionDetails": { "localityQualificationDecision": "NOT_PROCESSED", "postCodeQualificationDecision": "NOT_PROCESSED", "thoroughfareQualificationDecision": "NOT_PROCESSED" }, "overallQualificationDecision": "NOT_PROCESSED" }, "qualificationDecisionDetails": [ { "error": { "error": "This identifier is not supported or configuration does not trigger any qualification rules.", "status": 200 } } ] }, { "identifier": { "value": "DE307699628", "type": { "technicalKey": "EU_VAT_ID_DE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-07-04T14:21:06.653910938", "dataSourceTechnicalKey": "VIES", "dataSourceRequestIdentifiers": [ { "dataSourceTechnicalKey": "VIES", "value": "WAPIAAAAZB-HsxfW" } ], "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "NOT_PROCESSED", "addressQualificationDecision": "NOT_PROCESSED", "addressQualificationDecisionDetails": { "localityQualificationDecision": "NOT_PROCESSED", "postCodeQualificationDecision": "NOT_PROCESSED", "thoroughfareQualificationDecision": "NOT_PROCESSED" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Germany), Data source:VIES)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Germany),_Data_source:VIES)", "ruleStatus": "RELEASED", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Germany)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "DE307699628" }, { "name": "targetReferenceValue", "value": "DE307699628" }, { "name": "dataSourceTechnicalKey", "value": "VIES" }, { "name": "dataSourceRequestIdentifier", "value": "WAPIAAAAZB-HsxfW" } ], "cdqId": "VIES:DE307699628", "decision": "VALID" } ] } ], "lookupResults": [], "debugInfo": { "externalServiceResponses": [ { "status": 200, "timestamp": "2024-07-04T14:21:06.320157950Z", "additionalInformation": [ { "key": "requestorId", "value": "DE307699628" }, { "key": "requestId", "value": "WAPIAAAAZB-HsxfW" }, { "key": "rawJson", "value": "[{\"vatValue\":{\"value\":\"307699628\"},\"requestDate\":{\"value\":\"2024-07-03T22:00:00.000+00:00\"},\"countryCode\":{\"value\":\"DE\"},\"valid\":{\"value\":true},\"traderAddress\":{},\"traderName\":{},\"traderCompanyType\":{},\"traderStreet\":{},\"traderPostcode\":{},\"traderCity\":{},\"traderNameMatch\":{},\"traderCompanyTypeMatch\":{},\"traderStreetMatch\":{},\"traderPostcodeMatch\":{},\"traderCityMatch\":{},\"requestIdentifier\":{\"value\":\"WAPIAAAAZB-HsxfW\"},\"requesterVatNumber\":\"307699628\",\"requesterCountryCode\":\"DE\",\"refreshReason\":\"FORCED_BY_CUSTOMER\"}]" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 1, "numberOfExecutions": 1, "numberOfFails": 0, "failures": [], "dataSourcesOn": [ { "prefix": "VIES" }, { "prefix": "BZST" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } } } ``` 1. Qualify Irish Business Partner. The `BZST` system requires the name and city from the address for comprehensive qualification decisions, while the postcode and street details are optional. In the below request, the postcode isn't included. Request example: ```json { "profile": "WORLDWIDE_TAX_QUALIFICATION", "featuresOn": [ "FORCE_EXTERNAL_CALL" ], "dataSources": [ "BZST" ], "businessPartner": { "names": [ { "value": "WEMBAR COMPANY ULC" } ], "identifiers": [ { "value": "IE4811174Q", "type": { "technicalKey": "EU_VAT_ID_IE" } } ], "addresses": [ { "country": { "shortName": "IE" }, "localities": [ { "value": "Dublin 17" } ], "postCodes": [ { "value": "" } ], "thoroughfares": [ { "value": "Malahide Road" } ] } ] } } ``` details summary Expand the Response ```json { "qualificationResults": [ { "identifier": { "value": "IE4811174Q", "type": { "technicalKey": "EU_VAT_ID_IE" } }, "businessPartnerStatus": { "type": { "name": "Unknown", "url": "https://meta.cdq.com/Business_partner/status/type/technical_key/unknown", "technicalKey": "UNKNOWN" } }, "qualifiedAt": "2024-07-04T14:28:18.733682537", "dataSourceTechnicalKey": "BZST", "dataSourceRequestIdentifiers": [], "qualificationDecisionSummary": { "identifierQualificationDecision": "VALID", "nameQualificationDecision": "VALID", "addressQualificationDecision": "VALID", "addressQualificationDecisionDetails": { "localityQualificationDecision": "VALID", "postCodeQualificationDecision": "NO_INPUT_PROVIDED", "thoroughfareQualificationDecision": "VALID" }, "overallQualificationDecision": "VALID" }, "qualificationDecisionDetails": [ { "businessRule": { "name": "Thoroughfare Qualification (European value added tax identifier (Ireland), Data source:BZST)", "url": "https://meta.cdq.com/Thoroughfare_Qualification_(European_value_added_tax_identifier_(Ireland),_Data_source:BZST)", "ruleStatus": "RELEASED", "violationMessage": "Street deviates from the reference street registered with the European value added tax identifier (Ireland)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "STREET" }, { "name": "targetInputValue", "value": "Malahide Road" }, { "name": "targetReferenceValue", "value": "Malahide Road" }, { "name": "dataSourceTechnicalKey", "value": "BZST" } ], "cdqId": "BZST:IE4811174Q", "decision": "VALID" }, { "businessRule": { "name": "Post code Qualification (European value added tax identifier (Ireland), Data source:BZST)", "url": "https://meta.cdq.com/Post_code_Qualification_(European_value_added_tax_identifier_(Ireland),_Data_source:BZST)", "ruleStatus": "RELEASED", "violationMessage": "Post code deviates from the reference post code registered with the European value added tax identifier (Ireland)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "POST_CODE_REGULAR" }, { "name": "dataSourceTechnicalKey", "value": "BZST" } ], "cdqId": "N/A", "decision": "NO_INPUT_PROVIDED" }, { "businessRule": { "name": "Name Qualification (European value added tax identifier (Ireland), Data source:BZST)", "url": "https://meta.cdq.com/Name_Qualification_(European_value_added_tax_identifier_(Ireland),_Data_source:BZST)", "ruleStatus": "RELEASED", "violationMessage": "Name deviates from the reference name registered with the European value added tax identifier (Ireland)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "NAME_LOCAL" }, { "name": "targetInputValue", "value": "WEMBAR COMPANY ULC" }, { "name": "targetReferenceValue", "value": "WEMBAR COMPANY ULC" }, { "name": "dataSourceTechnicalKey", "value": "BZST" } ], "cdqId": "BZST:IE4811174Q", "decision": "VALID" }, { "businessRule": { "name": "Locality Qualification (European value added tax identifier (Ireland), Data source:BZST)", "url": "https://meta.cdq.com/Locality_Qualification_(European_value_added_tax_identifier_(Ireland),_Data_source:BZST)", "ruleStatus": "RELEASED", "violationMessage": "City deviates from the reference city registered with the European value added tax identifier (Ireland)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "CITY" }, { "name": "targetInputValue", "value": "Dublin 17" }, { "name": "targetReferenceValue", "value": "Dublin 17" }, { "name": "dataSourceTechnicalKey", "value": "BZST" } ], "cdqId": "BZST:IE4811174Q", "decision": "VALID" }, { "businessRule": { "name": "Identifier Qualification (European value added tax identifier (Ireland), Data source:BZST)", "url": "https://meta.cdq.com/Identifier_Qualification_(European_value_added_tax_identifier_(Ireland),_Data_source:BZST)", "ruleStatus": "HYPERCARE", "violationMessage": "Identifier deviates from the reference identifier registered with the European value added tax identifier (Ireland)" }, "executionContextProperties": [ { "name": "qualificationTarget", "value": "IDENTIFIER" }, { "name": "targetInputValue", "value": "IE4811174Q" }, { "name": "targetReferenceValue", "value": "IE4811174Q" }, { "name": "dataSourceTechnicalKey", "value": "BZST" } ], "cdqId": "BZST:IE4811174Q", "decision": "VALID" } ] } ], "lookupResults": [], "debugInfo": { "externalServiceResponses": [ { "status": 200, "message": "Valid request with valid VAT number", "timestamp": "2024-07-04T14:28:18.636881699Z", "additionalInformation": [ { "key": "Erg_Ort", "value": "A" }, { "key": "Erg_Str", "value": "A" }, { "key": "Datum", "value": "04.07.2024" }, { "key": "Erg_Name", "value": "A" }, { "key": "UstId_2", "value": "IE4811174Q" }, { "key": "Ort", "value": "Dublin 17" }, { "key": "UstId_1", "value": "DE307699628" }, { "key": "Erg_PLZ", "value": "D" }, { "key": "ErrorCode", "value": "200" }, { "key": "Druck", "value": "nein" }, { "key": "Uhrzeit", "value": "16:28:18" }, { "key": "Firmenname", "value": "WEMBAR COMPANY ULC" }, { "key": "Strasse", "value": "Malahide Road" }, { "key": "PLZ", "value": "n/a" } ] }, { "status": 200, "message": "Valid request with valid VAT number", "timestamp": "2024-07-04T14:28:18.636881699Z", "additionalInformation": [ { "key": "Erg_Ort", "value": "A" }, { "key": "Erg_Str", "value": "A" }, { "key": "Datum", "value": "04.07.2024" }, { "key": "Erg_Name", "value": "A" }, { "key": "UstId_2", "value": "IE4811174Q" }, { "key": "Ort", "value": "Dublin 17" }, { "key": "UstId_1", "value": "DE307699628" }, { "key": "Erg_PLZ", "value": "D" }, { "key": "ErrorCode", "value": "200" }, { "key": "Druck", "value": "nein" }, { "key": "Uhrzeit", "value": "16:28:18" }, { "key": "Firmenname", "value": "WEMBAR COMPANY ULC" }, { "key": "Strasse", "value": "Malahide Road" }, { "key": "PLZ", "value": "n/a" } ] }, { "status": 200, "message": "Valid request with valid VAT number", "timestamp": "2024-07-04T14:28:18.636881699Z", "additionalInformation": [ { "key": "Erg_Ort", "value": "A" }, { "key": "Erg_Str", "value": "A" }, { "key": "Datum", "value": "04.07.2024" }, { "key": "Erg_Name", "value": "A" }, { "key": "UstId_2", "value": "IE4811174Q" }, { "key": "Ort", "value": "Dublin 17" }, { "key": "UstId_1", "value": "DE307699628" }, { "key": "Erg_PLZ", "value": "D" }, { "key": "ErrorCode", "value": "200" }, { "key": "Druck", "value": "nein" }, { "key": "Uhrzeit", "value": "16:28:18" }, { "key": "Firmenname", "value": "WEMBAR COMPANY ULC" }, { "key": "Strasse", "value": "Malahide Road" }, { "key": "PLZ", "value": "n/a" } ] }, { "status": 200, "message": "Valid request with valid VAT number", "timestamp": "2024-07-04T14:28:18.636881699Z", "additionalInformation": [ { "key": "Erg_Ort", "value": "A" }, { "key": "Erg_Str", "value": "A" }, { "key": "Datum", "value": "04.07.2024" }, { "key": "Erg_Name", "value": "A" }, { "key": "UstId_2", "value": "IE4811174Q" }, { "key": "Ort", "value": "Dublin 17" }, { "key": "UstId_1", "value": "DE307699628" }, { "key": "Erg_PLZ", "value": "D" }, { "key": "ErrorCode", "value": "200" }, { "key": "Druck", "value": "nein" }, { "key": "Uhrzeit", "value": "16:28:18" }, { "key": "Firmenname", "value": "WEMBAR COMPANY ULC" }, { "key": "Strasse", "value": "Malahide Road" }, { "key": "PLZ", "value": "n/a" } ] } ], "businessRulesExecutionSummary": { "numberOfRules": 5, "numberOfExecutions": 5, "numberOfFails": 0, "failures": [], "dataSourcesOn": [ { "prefix": "BZST" } ], "ruleCategoriesOn": [ { "url": "https://meta.cdq.com/Qualification" }, { "url": "https://meta.cdq.com/EU_TAX_Qualification" }, { "url": "https://meta.cdq.com/Worldwide_TAX_Qualification" } ] } } } ``` The `NO_INPUT_PROVIDED` decision was obtained for the postcode qualification, as the postcode wasn't provided in the request. The overall decision is `VALID` since the identifier, name, street, and city are correct. ## Current Limitations and Restrictions of CDQ's Qualification The `/businesspartners/qualify` endpoint enables the use of 18 different data sources. Not all data sources behave the same way or provide results in the same format. To integrate all of them, the necessary steps were taken to follow each data source's restrictions. A common interface has been provided with the following limitations: | Limitations | | --- | | `BZST` does not support German Business Partners. | | `VIES` can validate only the EU VAT identifier of German Business Partners but does not provide reference data for the German address and name. | | `VIES` does not return reference data for Spanish Business Partners; it merely indicates whether a given input, such as name and address, is a match. | | Currently, only `AT.FON` can fully qualify German Business Partners with all attributes: identifier, postcode, name, locality, and thoroughfare. | | If the `dataSources` attribute is included in a request, results for each identifier from each requested data source will be provided, which may lead to many `NOT_PROCESSED` decisions. | | In some cases, qualification of an identifier is based on the calculation of other checked fields: postcode, name, locality, and thoroughfare due to the absence of specific rules for checking the identifier alone; this remains under active development. | | Qualification can fail if issues arise with connecting to a reference data source, such as if it is undergoing maintenance. All issues that occur during execution will be available in the `debugInfo` data field of a response. | | Currently, it is possible to qualify five data fields: identifier, postcode, name, locality, and thoroughfare of a Business Partner. If other Business Partner attributes require qualification, customers are encouraged to create an idea in the idea portal. | | Values that are empty or missing fields, such as not present `"postCodes": []` data, result in the `NO_INPUT_PROVIDED` decision. | | Not all data sources provide the status of a business partner. For example, `VIES` provides decisions about the validity of an identifier but does not provide anything about the business partner status itself. As a result we usually provide status `UNKNOWN` except in cases when a reference data source provides otherwise (like in the `CZ.REE` register). | ### Differences between Validation and Qualification The `/businesspartners/qualify` endpoint was designed and implemented to resolve problematic issues with qualification in validation endpoints. When qualification was being implemented using validation endpoints, many workarounds were introduced because the validation process wasn't initially intended for such use cases. After facing several service desk tickets, incidents, and issues with reference data sources, it became clear that this significant problem required proper treatment and a dedicated design. Consequently, the new qualification endpoint was designed, implemented, and tested with fresh ideas and methods. The main differences between validation endpoints and the qualification endpoint from an end user's perspective are: - A new dedicated endpoint solely for qualification purposes. - A new set of decisions. - A structure that's straightforward to understand and interpret. - Elimination of the problematic identifier reliability level. - A hierarchy of decisions that provides a clear, decision-wise perspective. - No data defects. Only rules enabling qualification decisions are employed, typically five for each Business Partner, corresponding to five attributes: `identifier`, `name`, `postcode`, `locality`, and `thoroughfare`. - Qualification of multiple identifiers against multiple reference data sources. - Introduction of two new profiles with clear features. - A smaller number of rules, positively impacting performance. - More robust implementation. This new endpoint should meet the expectations of most customers regarding the qualification of a Business Partner. ## Conclusion Qualifying Business Partners is one of the main steps in ensuring data accuracy. The CDQ Tax Guard offers a complete set of rules that qualify Business Partners according to identifiers, names, and addresses. The qualification results provide insight into the correctness of the data and support informed decisions. The examples provided in the document serve to illustrate the qualification process for Business Partners from different countries using the CDQ Data Quality Suite. The results that come out illustrate how important correct data is in ensuring that the quality of information on the business partners is good. ## Your opinion matters! We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!