Records

Everything about Records

Validate RecordWSDL

Validates a custom record. If the custom knowledge graph also contains a mapping, the mapping is applied ad-hoc and CDL validation rules are applied as well.

SecurityapiKey

Request

Request Body schema: application/json

activatedRules

Array of strings (BusinessRuleUrl)

Urls of cdl rules that are active during validation process.

Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

Array of objects (Criticality)

Criticalities of cdl rules that are active during validation process.

customKnowledgeGraph

string

Identifier for the custom knowledge graph that should be used for validation.

Example: "bayer"

dataMapperDefinitionId

string (DataMapperDefinitionId)

Mapping ID that should be used for the mapping. Overrules a mapping of the knowledge graph (if exists). To run validation against CDL Rules data mapping definition by given ID must exist and user executing validation needs to have permission to access it.

Example: "5D4BDC415419A70001948311"

dataMirrorStorageId

string

Storage used for data mirror enrichment.

Example: "6ecd44476b95347e8a0d215589afj420"

Array of objects (DataSource)

Rules with data sources passed here are not used in validation process.

Array of objects (DataSource)

If data sources are disabled by feature toggle you can enable some of them passing their prefixes here.

externalId

string

Unique ID from the client system.

Example: "A12345"

featuresOff

Array of strings

List of features to be deactivated.

Items Enum:	Description
ENRICH_DATA_MIRROR_CHANGES	Enriches the data with changes from the data mirror.
EXTERNAL_SOURCES_OFF	Disables any rule that utilizes Data Sources in validation process (rule’s Primary/Secondary datasources).
SHOW_BUSINESSPARTNER	Returns the Business Partner as a part of the validation response.
SHOW_DEBUG_INFO	Return additional information that can be used for debugging purposes.
USE_AUTOMATION_RULES	Executes business rules of category Automation_rule.

Example: ["SHOW_LOOKUP_RESULTS"]

featuresOn

Array of strings

Activate features.

Items Enum:	Description
ENRICH_DATA_MIRROR_CHANGES	Enriches the data with changes from the data mirror.
EXTERNAL_SOURCES_OFF	Disables any rule that utilizes Data Sources in validation process (rule’s Primary/Secondary datasources).
SHOW_BUSINESSPARTNER	Returns the Business Partner as a part of the validation response.
SHOW_DEBUG_INFO	Return additional information that can be used for debugging purposes.
USE_AUTOMATION_RULES	Executes business rules of category Automation_rule.

Example: ["SHOW_LOOKUP_RESULTS"]

ignoredRules

Array of strings (BusinessRuleUrl)

Urls of cdl rules ignored during validation process.

Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

object

Stringified JSON of the custom record.

Example: "{}"

profile

string (ValidationProfile)

Profile which is used during validation. Default value is STANDARD.

Enum:	Description
QUICK	This profile checks data quality of records in a quick way, i.e. data quality rules that have a negative impact on performance.
STANDARD	This profile checks data quality using CDQ's standard configuration.
QUALIFICATION	Deprecated.
AUTOMATION	Deprecated.
EU_VAT_QUALIFICATION	This profile qualifies EU VATs using CDQ's default configuration of data quality rules for qualified checks of EU VATs
DATA_SHARING_QUALITY_GATE	Quality checks ensure that only valid data enters the CDQ Community Data Pool
IDENTIFIER_QUALITY	This profile checks identifiers with a standard configuration of data quality rules. It does not comprise qualified checks of identifiers regarding e.g. name or address.
ADDRESS_QUALITY	This profile checks addresses with a standard configuration of data quality rules.
WORLDWIDE_IDENTIFIER_QUALIFICATION	This profile qualifies any supported business identifier (e.g. tax numbers) worldwide using CDQ's default configuration of data quality rules for qualified checks of a particular identifier
FEATURES_OFF	This profile turns off any qualification rules and is designed for custom rules selection.

Example: "QUICK"

record

string

Stringified JSON of the custom record

Example: "{}"

Array of objects (RuleCategoryOn)

Categories use for selecting active business rules.

ruleStatuses

Array of strings (RuleStatus)

Filter for rule status.

Items Enum:	Description
RELEASED	Rule was moved from status PLANNED automatically during daily testing or by manual maintenance.
DRAFT	Rule was created as a draft and it will be not executed.
HYPERCARE	Rule was moved from status DEACTIVATED automatically during daily testing.

Example: ["RELEASED"]

Responses

200

post/v2/records/validate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"jsonRecord": "{}",
"customKnowledgeGraph": "bayer",
"dataMapperDefinitionId": "5D4BDC415419A70001948311",
"profile": "QUICK",
"ruleStatuses": ["RELEASED"
],
"featuresOn": ["SHOW_LOOKUP_RESULTS"
],
"featuresOff": ["SHOW_LOOKUP_RESULTS"
],
"ruleCategoriesOn": [{"url": "https://meta.cdq.com/Identifier_checkdigit"
}
],
"ignoredRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"activatedRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"criticalities": [{"businessRuleUrl": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"violationLevel": "INFO"
}
],
"dataSourcesOn": [{"prefix": "VIES"
}
],
"dataSourcesOff": [{"prefix": "VIES"
}
],
"dataMirrorStorageId": "6ecd44476b95347e8a0d215589afj420",
"record": "{}",
"externalId": "A12345"
}

Response samples

{"dataDefects": [{"properties": [{"content": "DE12345678",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"name": "Minority Indicator Value",
"url": "http://meta.cdq.com/Business_Partner/Identifier_Value",
"rootConcept": {"id": "EU_VAT_ID_DE",
"idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
"name": "Address",
"url": "https://meta.cdq.com/Business_partner"
},
"parentConcept": {"id": "EU_VAT_ID_DE",
"idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
"name": "Address",
"url": "https://meta.cdq.com/Business_partner"
}
}
],
"validationSource": "VIES",
"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
},
"violationLevel": "INFO",
"violationMessage": "Business Partner identifier is mandatory.",
"reason": "Identifier is mandatory.",
"categories": [{"url": "https://meta.cdq.com/Identifier_checkdigit",
"name": "Identifier checkdigit"
}
],
"errorCode": "400"
}
],
"decisions": [{"properties": [{"content": "DE12345678",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"name": "Minority Indicator Value",
"url": "http://meta.cdq.com/Business_Partner/Identifier_Value",
"rootConcept": {"id": "EU_VAT_ID_DE",
"idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
"name": "Address",
"url": "https://meta.cdq.com/Business_partner"
},
"parentConcept": {"id": "EU_VAT_ID_DE",
"idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
"name": "Address",
"url": "https://meta.cdq.com/Business_partner"
}
}
],
"action": "FULL_CHECK",
"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
}
}
],
"qualificationResult": {"sourceData": [{"key": "addrz1",
"value": "CH-9000"
}
],
"formattedSourceData": {"code": "ATU12345678",
"message": "Message to be filled in.",
"businessPartnerName": "Muster AG",
"postCodeValue": "9000",
"thoroughfareValue": "Hauptstrasse",
"localityValue": "München"
},
"validatorStatus": "ONLINE",
"validatorMessage": "VAT ID is valid.",
"qualifiedBy": "VIES",
"qualifiedAt": "2024-04-26T22:35:54Z",
"addressQualification": "QUALIFIED",
"addressQualificationDetails": {"localityQualification": "QUALIFIED",
"postCodeQualification": "QUALIFIED",
"thoroughfareNumberQualification": "QUALIFIED",
"thoroughfareQualification": "QUALIFIED"
},
"identifierValidity": "VALID",
"businessPartnerNameQualification": "QUALIFIED",
"overallQualification": "QUALIFIED"
},
"summary": {"validationLevel": "ERROR",
"dataQualityRecordStatus": {"name": "No issues found",
"description": "All rules have been executed, and we have found no data quality issues.",
"technicalKey": "NO_ISSUES_FOUND"
},
"action": "FULL_CHECK",
"statistics": {"numberOfInfoDataDefects": "10",
"numberOfErrorDataDefects": "10",
"numberOfWarningDataDefects": "10"
}
},
"debugInfo": {"externalServiceResponses": [{"status": "200",
"message": "There is no more quota left for this Data Source.",
"path": "/data-validation/businesspartners/validate",
"details": "Detailed message",
"timestamp": "2024-04-26T22:35:54Z",
"additionalInformation": [{"key": "requestId",
"value": "WAPIAAAAYse8yTdE"
}
]
}
],
"businessRulesExecutionSummary": {"numberOfRules": "274",
"numberOfExecutions": "273",
"numberOfFails": "1",
"failures": [{"externalId": "955775",
"message": "Message to be filled in.",
"businessRule": {"name": "Identifier unknown (European value added tax identifier (The Netherlands))",
"url": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"ruleStatus": "RELEASED"
}
}
],
"warnings": [{"message": "Message to be filled in."
}
],
"dataSourcesOn": [{"prefix": "VIES"
}
],
"dataSourcesOff": [{"prefix": "VIES"
}
],
"activatedRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"ignoredRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"ruleCategoriesOn": [{"url": "https://meta.cdq.com/Identifier_checkdigit"
}
],
"ruleStatuses": ["RELEASED"
],
"violationLevels": ["INFO"
]
}
},
"diff": "{\"Identified_changes\":[{\"op\":\"add\",\"path\":\"/partner/header/objectTask\",\"value\":\"C\"}]}",
"businessPartner": {"names": ["Corporate Data Quality AG"
],
"legalForm": "Aktiengesellschaft",
"identifiers": ["VAT identification number"
],
"categories": ["Hotel"
],
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T22:35:54Z",
"validUntil": "2024-04-26T22:35:54Z",
"type": "In Liquidation"
},
"addresses": ["Lukasstraße 4, 9008 St. Gallen"
],
"externalId": "The ID managed in the customer's SAP systems.",
"profile": {"minorityIndicator": "Social enterprise",
"classifications": ["NAF"
],
"phoneNumbers": ["+41 71 571 10 40"
],
"websites": ["www.cdq.com"
],
"contactEmails": ["developer-portal@cdq.com"
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
]
},
"formattedSapRecord": {"name1": "CDQ AG",
"name2": "CDQ AG",
"name3": "CDQ AG",
"name4": "CDQ AG",
"nameCo": "Aktiengesellschaft",
"legalEntity": "Aktiengesellschaft",
"legalForm": "Aktiengesellschaft",
"indSector": "NAF",
"narp": "Friedrich Nietzsche",
"stceg": "CHE-218.608.88",
"stcd1": "CHE-218.608.88",
"stcd2": "CHE-218.608.88",
"stcd3": "CHE-218.608.88",
"stcd4": "CHE-218.608.88",
"stcd5": "CHE-218.608.88",
"url": "www.cdq.com",
"telNumber": "+41 71 571 10 40",
"country": "Switzerland",
"countryCode": "CH",
"region": "Sankt Gallen",
"regionCodeSap": "9004",
"regionCode": "9004",
"county": "Sankt Gallen",
"countyCode": "9004",
"township": "Sankt Gallen",
"townshipCode": "9004",
"city": "Sankt Gallen",
"district": "St. Georgen",
"postalCode": "9000",
"postalCode3": "9000",
"street1": "Lukasstraße 4",
"street2": "Lukasstraße 4",
"street5": "Lukasstraße 4",
"houseNum": "4",
"houseNum2": "4",
"building": "Office 2",
"floor": "2",
"roomnumber": "123",
"poBoxCountry": "9000",
"poBoxCity": "9000",
"poBoxPostalCode": "9000",
"poBox": "9000",
"latitude": "47.439549",
"longitude": "9.395275"
},
"relations": ["Commercial ultimate"
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"bank": {"name": "Sparda Bank",
"branch": "Filiale München",
"address": {"localities": ["Sankt Gallen"
],
"country": "Switzerland CH",
"administrativeAreas": ["Sankt Gallen"
],
"postCodes": ["9000"
],
"thoroughfares": ["Lukasstraße 4"
]
}
},
"countryCode": "DE"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"externalContext": "LIFNR",
"id": "63e635235c06b7396330fe40",
"lastModifiedAt": "2024-04-26T22:35:54Z"
}
}