Skip to content

Data Validation API (3)

This API provides services used for business partner qualification

Data Validation API
Download OpenAPI description
api-v3.json
api-v3.yaml
Languages
Servers
Mock server

https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/

Production

https://api.cdq.com/data-validation/rest/

Qualification

Provides funcionalities for qualification of Business Partners. Includes endpoints that allow users to submit Business Partner data for qualification, retrieve qualification results, and handle various qualification scenarios.

Operations

Qualify Business Partner

Request

Endpoint used for Business Partner qualification. It is in BETA version and may change without notice.

Security
apiKey
Bodyapplication/jsonrequired

cmd

dataSourcesArray of strings(DataSourcesEnum)

List of data sources should be used.

Items Enum ValueDescription
AR.NRC

Value indicating AR.NRC data source.

AT.CR

Value indicating AT.CR data source.

AT.FON

Value indicating AT.FON data source.

AU.BR

Value indicating AU.BR data source.

BR.RF

Value indicating BR.RF data source.

BZST

Value indicating BZST data source.

CA.CR

Value indicating CA.CR data source.

CH.UIDR

Value indicating CH.UIDR data source.

CZ.REE

Value indicating CZ.REE data source.

DK.CR

Value indicating DK.CR data source.

Example: ["AR.NRC"]
profilestring(BusinessPartnerQualificationRequestProfileEnum)

Qualification profiles enum.

Default "EU_TAX_QUALIFICATION"
Enum ValueDescription
EU_TAX_QUALIFICATION

Default option. EU_TAX_QUALIFICATION profile for the Qualification process.

WORLDWIDE_TAX_QUALIFICATION

WORLDWIDE_TAX_QUALIFICATION profile for the Qualification process.

Example: "EU_TAX_QUALIFICATION"
featuresOnArray of strings(BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned on.

Items Enum ValueDescription
SHOW_LOOKUP_RESULTS

Includes lookup results in the response.

SHOW_BUSINESS_PARTNER

Includes Business Partner in the response.

FORCE_EXTERNAL_CALL

Forces calls on external services ignoring cache.

SHOW_DEBUG_INFO

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

Example: ["FORCE_EXTERNAL_CALL"]
featuresOffArray of strings(BusinessPartnerQualificationRequestFeaturesEnum)

Request features that should be turned off.

Items Enum ValueDescription
SHOW_LOOKUP_RESULTS

Includes lookup results in the response.

SHOW_BUSINESS_PARTNER

Includes Business Partner in the response.

FORCE_EXTERNAL_CALL

Forces calls on external services ignoring cache.

SHOW_DEBUG_INFO

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

Example: ["FORCE_EXTERNAL_CALL"]
businessPartnerobject(BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

curl -i -X POST \
  https://developer.cdq.com/_mock/apis/data-validation-api/api-v3/v3/businesspartners/qualify \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "profile": "EU_TAX_QUALIFICATION",
    "businessPartner": {
      "names": [
        {
          "value": "ATOS SPAIN SA"
        }
      ],
      "identifiers": [
        {
          "type": {
            "technicalKey": "EU_VAT_ID_ES"
          },
          "value": "A28240752"
        }
      ],
      "addresses": [
        {
          "country": {
            "shortName": "ES"
          }
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
qualificationResultsArray of objects(BusinessPartnerQualificationResultItem)

List of Qualifications Results.

rulesInErrorArray of objects(RulesInError)

List of rules executed with error.

lookupResultsArray of objects(LookupResult)

List of Lookup Results.

debugInfoobject(DebugInfo)

Reference implementation how to structure external service responses. Can be activated by a feature SHOW_DEBUG_INFO.

businessPartnerobject(BusinessPartner)

An organization which has some degree of involvement with another organization's business dealings. Typically, a company's business partner is another company in the role of a customer, a supplier, a vendor, or a service provider. In the CDL context, the business partner is the core managed entity. A business partner is globally uniquely identifiable by a CDL ID, and all managed information such as addresses, documents, and hierarchies is linked to a business partner.

Response
application/json
{
  "qualificationResults": [
    { … }
  ],
  "lookupResults": [
    { … }
  ],
  "debugInfo": {
    "externalServiceResponses": [ … ],
    "businessRulesExecutionSummary": { … }
  }
}

Configuration

Provides funcionalities for managing configurations. Includes endpoints that allow users to create, update, and delete configurations for the current user.

Operations

Public

Provides funcionalities to provide an RDF model of a record and validate a Business Partner.

Processing Logs

Provides funcionalities for managing processing logs. Includes endpoints that allow users to read processing log results.

Operations

Business Partners

Operations

Batch Validation

Operations

Records

Operations