Public

Rdificate Custom RecordDeprecated

Rdificate a custom record. It returns rdf model of the record.

SecurityapiKey

Request

Request Body schema: application/json

baseURL required	string Base. Example: "http://meta.cdq.com/"
	object JSON object that will be RDFied. Record and jsonRecord cannot be present at the same time. Example: "{'recordId': 'id', 'name': 'demo'}"
knowledgeGraphId	string Knowledge Graph that contains required configuration for test cases rdfication process. Example: "kg_1_m_1"
pathToReferenceId required	string JSON path that can locate attribute, in case of non-existent path selection will fall back to referenceIdTag. Example: "\\fullPath\\recordId"
record	string Stringified data that will be RDFied. Record and jsonRecord cannot be present at the same time. Example: "{\\\"recordId\\\":\\\"id\\\",\\\"name\\\":\\\"demo\\\"}"
referenceIdTag required	string Name of the attribute that should be used as a main identifier for all triples generated based on the data sent. Will use first found value of an attribute with given name. Example: "record_id"
rootPrefix required	string Prefix that is used for generating TTL triples. Single resource URI is created by baseUrl + rootPrefix + encodedJSONPath ex. http://meta.cdq.com/data/name. Example: "data"

Responses

200

post/records/rdfify

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"jsonRecord": "{'recordId': 'id', 'name': 'demo'}",
"baseURL": "http://meta.cdq.com/",
"record": "{\\\"recordId\\\":\\\"id\\\",\\\"name\\\":\\\"demo\\\"}",
"referenceIdTag": "record_id",
"pathToReferenceId": "\\fullPath\\recordId",
"rootPrefix": "data",
"knowledgeGraphId": "kg_1_m_1"
}

Response samples

{"rdfRecord": "<http://monitor.test.cdq.com/380bdf33-ad17-41bc-a3e5-78b27befdca9> a <http://monitor.test.cdq.com/Record>; <http://monitor.test.cdq.com/Property/Has_record_id> '92912918-a85c-4d77-9f62-3b2ddb57a279'; <http://monitor.test.cdq.com/Property/Name> 'demo' ."
}

Validate Business PartnerDeprecated

Validates a Business Partner against data quality rules.

SecurityapiKey

Request

Request Body schema: application/json

required

object

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.

bzstPrint

string

Request printed confirmation by German BZSt authority

Example: "true"

featuresOff

Array of strings

List of features to be deactivated.

Items Enum:	Description
ENRICH_CATEGORIES	Enrich a CDL community standardized business partner category for a given entity.
ENRICH_LEGAL_FORM	Identify and enriches the legal form of a company.
LAB_BETA	Deprecated feature.
QUALIFICATION_SILENT_MODE	If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.
SHOW_BUSINESSPARTNER	Shows business partner that was used in the request.
SHOW_DEBUG_INFO	Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).
SHOW_LOOKUP_RESULTS	Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).
SHOW_QUALIFICATION_DECISIONS	Shows qualification decisions - used only in qualification endpoint in API v3. In APIv1 and APIv2 it is used in validation endpoint.
USE_SPARQL_VALIDATOR	Deprecated feature.

Example: ["SHOW_DEBUG_INFO"]

featuresOn

Array of strings

List of features to be activated.

Items Enum:	Description
ADDRESS_CHECKS	CDQ data quality profiling services enable the validation of addresses with respect to different data quality criteria.
BANKING_DATA_CHECKS	CDQ data quality profiling services enable the validation of bank master data with respect to different data quality criteria.
BUSINESS_PARTNER_CHECKS	Validate concepts that basically establish a business partner (e.g. name and legal form).
ENRICH_CATEGORIES	Enrich a CDL community standardized business partner category for a given entity.
ENRICH_LEGAL_FORM	Identify and enriches the legal form of a company.
EU_VAT_QUALIFICATION_STANDARD	For a given EU VAT, it is checked whether the name and address are really associated with this identifier (same information maintained in the VAT register as provided by the user).
FORCE_EXTERNAL_CALL	Forces calls on external services ignoring cache.
IDENTIFIER_CHECKS	Validate business (VAT, tax, business register IDs) and location identifiers against different data quality rules categories.
IDENTIFIER_QUALIFICATION	Turns on identifier qualification (standard) which enables to qualify EU VAT identifiers.
LAB_BETA	Deprecated feature.
QUALIFICATION_SILENT_MODE	If enabled all exceptions occurring within execution of business rules are ignored. If not enabled then execution error will result in creating data defect. By default, part of profile QUALIFICATION.
SHOW_BUSINESSPARTNER	Shows business partner that was used in the request.
SHOW_DATA_DEFECTS	Shows found data defects - usually it is turned on.
SHOW_DEBUG_INFO	Shows additional information about validation process (number of applied rules, used categories, failed executions etc.).
SHOW_LOOKUP_RESULTS	Displays results from the lookup endpoint (usually enriched data in comparison to the original business partner requested).
SHOW_QUALIFICATION_DECISIONS	Shows qualification decisions - used only in qualification endpoint in API v3. In APIv1 and APIv2 it is used in validation endpoint.
USE_SPARQL_VALIDATOR	Deprecated feature.

Example: ["SHOW_LOOKUP_RESULTS"]

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"

ruleCategoriesUrls

Array of strings (RuleCategoryUrl)

List of CDL rule categories.

Items Enum:	Description
http://meta.cdq.com/Category:Address_data_quality_rules	Rules that check the quality of address data.
http://meta.cdq.com/Category:National_identifier_data_quality_rules	Rules that check the quality of national identifier data.
http://meta.cdq.com/Category:European_VAT_identifier_data_quality_rules	Rules that check the quality of European VAT identifier data.
http://meta.cdq.com/Category:Tax_identifier_data_quality_rules	Rules that check the quality of tax identifier data.

Example: ["https://www.corporate-data-league.ch/meta/Category:Address_data_quality_rules"]

ruleStatuses

Array of strings (RuleStatus)

Enable rules with provided statuses.

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"]

ruleUrls

Array of strings (BusinessRuleUrl)

List of CDL rules.

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

validationSource

string (ValidationSource)

The sources is an information obtained from the Business Rule telling to which knowledge graph the Business Rule that detected the data defect belongs. In case of a Business Partner validation the source is usually CDL knowledge graph because it contains business rules specific for BusinessPartner validation. In case of a Record validation process - two option can be present e.g. CDL and CUSTOM. This depends on if data mapping definition was defined and if business partner validation was executed in the context of record validation.

Enum:	Description
CDL	Allows verifying the validity of a VAT number base on Corporate Data League rules.
BZST	Allows verifying the validity of a Germany VAT number issued by any European Member State.
VIES	Allows verifying the validity of a VAT number issued by any European Member State. For all countries except Germany, the registration data (name and address for which the VAT is registered) can be received as well. For Spain registration, data can only be confirmed but not received by just providing the VAT number.
AT	Allows verifying the validity of a VAT number issued by any European Member State.
CUSTOM	Allows verifying the validity of a VAT number base on custom rules set by customer in th CDQ's wiki.

Example: "VIES"

vatAtRequestor

string

Deprecated

DEPRECATED, use organizational settings to configure.

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

Example: "AT123456789"

vatDeRequestor

string

Deprecated

DEPRECATED, use organizational settings to configure.

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

Example: "DE123456789"

Responses

200

post/businesspartners/validate

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"names": [{"value": "Corporate Data Quality AG"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "DUNS_ID"
}
}
],
"legalForm": {"name": "Aktiengesellschaft"
},
"address": {"country": {"shortname": "CH",
"value": "Switzerland"
},
"thoroughfares": [{"value": "Lukasstraße 4"
}
],
"postCode": {"value": "9000"
},
"localities": [{"value": "Sankt Gallen"
}
],
"premises": [{"value": "Lukasstraße 4"
}
],
"administrativeAreas": [{"value": "Sankt Gallen"
}
],
"postalDeliveryPoint": {"value": "Postfach",
"type": {"technicalKey": "POST_OFFICE_BOX"
}
}
}
},
"profile": "QUICK",
"featuresOn": ["SHOW_LOOKUP_RESULTS"
],
"featuresOff": ["SHOW_DEBUG_INFO"
],
"ruleCategoriesUrls": ["https://www.corporate-data-league.ch/meta/Category:Address_data_quality_rules"
],
"ruleUrls": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"vatAtRequestor": "AT123456789",
"vatDeRequestor": "DE123456789",
"bzstPrint": "true",
"validationSource": "VIES",
"ruleStatuses": ["RELEASED"
]
}

Response samples

{"dataDefects": [{"properties": [{"url": "http://meta.cdq.com/Address/locality/value",
"path": "businesspartner.addresses.localities.value",
"concept": "http://meta.cdq.com/Address/locality"
}
],
"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."
}
],
"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-11-21T16:00:52Z",
"addressQualification": "QUALIFIED",
"addressQualificationDetails": {"localityQualification": "QUALIFIED",
"postCodeQualification": "QUALIFIED",
"thoroughfareNumberQualification": "QUALIFIED",
"thoroughfareQualification": "QUALIFIED"
},
"identifierValidity": "VALID",
"businessPartnerNameQualification": "QUALIFIED",
"overallQualification": "QUALIFIED"
},
"lookupResults": [{"businessPartner": {"id": "63e635235c06b7396330fe40",
"names": [{"details": "CDQ AG",
"language": "German",
"shortName": "CDQ AG",
"type": "BUSINESS_PARTNER_NAME_TYPE_LOCAL",
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"mainAbbreviation": "AG",
"technicalKey": "DE_9866"
},
"identifiers": [{"issuingBody": "Amtsgericht Aachen",
"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST"
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"type": null
}
],
"postCode": {"shortName": "PLZ",
"type": "Regular",
"value": "9000"
},
"localities": [{"shortName": null,
"type": null,
"value": null
}
],
"thoroughfares": [{"direction": null,
"number": null,
"shortName": null,
"type": null,
"value": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null
}
],
"postalDeliveryPoint": {"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach"
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": null,
"url": null,
"technicalKey": null
}
]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"record": "{name: ..., legalForm: ..., ...}",
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-21T16:00:52Z",
"validUntil": "2024-11-21T16:00:52Z",
"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
}
},
"address": {"id": "0001",
"externalId": "1",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
}
}
],
"postCode": {"shortName": "PLZ",
"type": "Regular",
"value": "9000"
},
"localities": [{"shortName": "St. Gallen",
"type": "City",
"value": "Sankt Gallen"
}
],
"thoroughfares": [{"direction": "221-bis Baker Street, North",
"number": "4",
"shortName": "Lukasstr. 4",
"type": "Industrial zone",
"value": "Lukasstraße 4"
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type",
"technicalKey": "FACTORY"
}
}
],
"postalDeliveryPoint": {"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type",
"technicalKey": "MAILBOX"
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach"
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
},
"matchingScore": "0.9",
"dataSource": "648824a691d8d2503d65103e",
"cdqId": "VIES:DE119267630"
}
],
"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-11-21T16:00:52Z",
"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"
}
}
],
"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"
]
}
},
"identifierResults": [{"property": {"value": "DE119267630",
"type": "EU_VAT_ID_DE"
},
"reliabilityLevel": {"name": "Identifier existence",
"url": "https://meta.cdq.com/Identifier_existence",
"value": "4",
"checks": [{"name": "Identifier existence",
"url": "https://meta.cdq.com/Identifier_existence",
"value": "4",
"status": "OK",
"validity": {"name": "Valid",
"description": "Identifier check was executed with success, confirms that identifier is meeting requirement for check to pass.",
"technicalKey": "VALID"
},
"message": "External service error."
}
]
},
"qualificationDecisions": [{"properties": [{"content": "DE12345678",
"contentSelector": "$.partnerProfile.minorityIndicator.value",
"name": "Minority Indicator Value",
"url": "http://meta.cdq.com/Business_Partner/Identifier_Value",
"rootConcept": {"id": null,
"idSelector": null,
"name": null,
"url": null
},
"parentConcept": {"id": null,
"idSelector": null,
"name": null,
"url": null
}
}
],
"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"
},
"qualificationTarget": "STREET",
"decision": "VALID",
"cdqId": "VIES:DE119267630",
"dataSource": "VIES",
"identifierValue": "DE119267630",
"identifierType": "EU_VAT_ID_DE",
"errorMessage": "Example.",
"externalServiceResponse": {"status": "200",
"message": "There is no more quota left for this Data Source.",
"path": "/data-validation/businesspartners/validate",
"details": "Detailed message",
"timestamp": "2024-11-21T16:00:52Z",
"additionalInformation": [{"key": null,
"value": null
}
]
}
}
]
}
],
"businessPartner": {"id": "63e635235c06b7396330fe40",
"names": [{"details": "CDQ AG",
"language": "German",
"shortName": "CDQ AG",
"type": "BUSINESS_PARTNER_NAME_TYPE_LOCAL",
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"mainAbbreviation": "AG",
"technicalKey": "DE_9866"
},
"identifiers": [{"issuingBody": "Amtsgericht Aachen",
"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST"
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"type": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
}
}
],
"postCode": {"shortName": "PLZ",
"type": "Regular",
"value": "9000"
},
"localities": [{"shortName": "St. Gallen",
"type": "City",
"value": "Sankt Gallen"
}
],
"thoroughfares": [{"direction": "221-bis Baker Street, North",
"number": "4",
"shortName": "Lukasstr. 4",
"type": "Industrial zone",
"value": "Lukasstraße 4"
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": "Factory",
"url": "https://meta.cdq.com/Address/premise/type",
"technicalKey": "FACTORY"
}
}
],
"postalDeliveryPoint": {"type": {"name": "Mailbox",
"url": "https://meta.cdq.com/Address/postal_delivery_point/type",
"technicalKey": "MAILBOX"
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach"
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"record": "{name: ..., legalForm: ..., ...}",
"status": {"officialDenotation": "Good Standing",
"validFrom": "2024-11-21T16:00:52Z",
"validUntil": "2024-11-21T16:00:52Z",
"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
}
},
"rulesInError": [{"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"
},
"executionStatus": "500",
"error": {"timestamp": "2024-11-21T16:00:52Z",
"message": "This user is not allowed to access this service.",
"error": "BAD_REQUEST",
"path": "/v2/businesspartners/lookup",
"status": "400",
"id": "REF_VIES_SERVICE_UNAVAILABLE_300"
},
"ruleResult": "parentConceptIdSelector = 'businessPartner.identifiers.technicalKey', content = '1633582012931231', parentConceptUrl='https://meta.cdq.com/Business_partner/identifier', recordId = '451ff2f9-8182-43fc-9728-aad9ce62d771', contentSelector = 'businessPartner.identifiers.value', contentSelectorUrl = 'https://meta.cdq.com/Business_partner/identifier/value', parentConceptId = 'EE_BRN'",
"violationLevel": "INFO",
"validationSource": "CDQ"
}
]
}