Skip to content

Data Validation API (3)

This API provides services used for business partner qualification

Data Validation API
Overview
URL

https://www.cdq.ch/team

Paweł Siwoń

pawel.siwon@cdq.com

Languages
Servers
Mock server

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

Production SOAP

https://api.corporate-data-league.ch/data-validation/soap/v3/

Production

https://api.corporate-data-league.ch/data-validation/

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

Validation

Provides funcionalities for validation of Business Partner data.

Operations

Validate Data

Request

Endpoint used for data validation.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "johndoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
featuresOnArray of strings(DataValidationRequestFeatures)

Request features that should be turned on.

Items Enum ValueDescription
V3_DATA_VALIDATION_PROFILE_1

Triggers specific behaviours for FEATURE_1.

V3_DATA_VALIDATION_PROFILE_2

Triggers specific behaviours for FEATURE_2.

Example: ["V3_DATA_VALIDATION_FEATURE_1"]
featuresOffArray of strings(DataValidationRequestFeatures)

Request features that should be turned off.

Items Enum ValueDescription
V3_DATA_VALIDATION_PROFILE_1

Triggers specific behaviours for FEATURE_1.

V3_DATA_VALIDATION_PROFILE_2

Triggers specific behaviours for FEATURE_2.

Example: ["V3_DATA_VALIDATION_FEATURE_1"]
profilestring(DataValidationRequestProfile)

Profile used in the data validation process.

Enum ValueDescription
V3_DATA_VALIDATION_PROFILE_1

Triggers specific behaviours for PROFILE_1.

V3_DATA_VALIDATION_PROFILE_2

Triggers specific behaviours for PROFILE_2.

Example: "V3_DATA_VALIDATION_PROFILE_1"
jsonRecordobject

JSON object that represents custom record. If record and jsonRecord are present, exception will be thrown.

Example: {"recordId":"id","name":"demo"}
knowledgeGraphListArray of objects(KnowledgeGraphRequest)

List of knowledge graphs with optional mappings.

configurationIdstring(ConfigurationId)

Configuration ID used to set up data validation request. If provided, those parameters will be overridden:

  • profile
  • featuresOn
  • featuresOff
Example: "6513d25b63cf07787018790a"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-validation-api/api-v3/v3/validate \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "featuresOn": [
      "V3_DATA_VALIDATION_FEATURE_1"
    ],
    "featuresOff": [
      "V3_DATA_VALIDATION_FEATURE_2"
    ],
    "profile": "V3_DATA_VALIDATION_PROFILE_1",
    "businessPartner": {
      "identifiers": [
        {
          "value": "ESA28240752",
          "type": {
            "technicalKey": "EU_VAT_ID_ES"
          }
        }
      ],
      "names": [
        {
          "value": "ATOS SPAIN SA"
        }
      ],
      "addresses": [
        {
          "country": {
            "shortName": "ES"
          },
          "localities": [
            {
              "value": "Madrid"
            }
          ],
          "postCodes": [
            {
              "value": "28037"
            }
          ],
          "thoroughfares": [
            {
              "value": "Calle Albarracin"
            }
          ]
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
versionstring

Version of the response schema.

Example: "3.0"
dataDefectsArray of objects(DataDefect)

List of Data Defects found in the record.

rulesInErrorArray of objects(DataValidationRulesInError)

List of rules executed with error.

customResultsArray of objects(CustomResult)

List of custom results.

Example: [{"type":"myVariable","value":"someBoundedOrReturnedValue"}]
statusobject(Status)

Details about status or error of a service

Response
application/json
{
  "version": 3,
  "dataDefects": [
    { … }
  ]
}

Batch Validation

Provides funcionalities for validation of multiple records or entities in a single request. Includes endpoints that allow users to start validation jobs, poll the status of these jobs, and retrieve validation results.

Operations

Business Partners

Provides funcionalities for managing Business Partners. Includes endpoints that allow users to validate Business Partners against data quality rules.

Operations

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.

Operations

Records

Provides funcionalities for managing records. Includes endpoints that allow users to validate records.

Operations

Processing Logs

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

Operations