This API 1 provides services to upload, manipulate and download businesspartner data in the CDL Cloud.
Data Exchange API (5)
Download OpenAPI description
Languages
Servers
Production
https://api.cdq.com/data-exchange/rest/
- Production
https://api.cdq.com/data-exchange/rest/v4/datamapperdefinitions/{id}/transformBusinessPartners
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/v4/datamapperdefinitions/6440dba32b30176c5917b1b7/transformBusinessPartners \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"businessPartners": [
"63e635235c06b7396330fe40"
]
}'
Response
application/json
{ "businessPartners": [ { … } ] }
- Production
https://api.cdq.com/data-exchange/rest/v4/datamapperdefinitions/{id}/transformFields
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/v4/datamapperdefinitions/6440dba32b30176c5917b1b7/transformFields \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"businessPartners": [
{
"id": "63e635235c06b7396330fe40",
"createdAt": "2025-08-19T06:23:16Z",
"modifiedAt": "2025-08-19T06:23:16Z",
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [
{
"type": {
"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {
"sharingStatus": {
"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [
{
"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [
{
"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2025-08-19T06:23:16Z",
"triggerType": {
"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {
"processedAt": "2025-08-19T06:23:16Z",
"provenance": {},
"type": {}
},
"jobProcessedAt": "2025-08-19T06:23:16Z",
"processedAt": "2025-08-19T06:23:16Z",
"status": "INFO",
"description": "Validation Level",
"processingStatus": {
"technicalKey": "IN_PROGRESS",
"modifiedAt": "2025-08-19T06:23:16Z"
}
}
],
"decisionLogResult": {
"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [
{
"type": {
"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {
"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {
"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {
"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [
{
"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"identifiers": [
{
"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",
"issuingBody": {
"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {
"country": {}
}
},
"status": {
"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [
{
"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {
"type": {
"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2025-08-19T06:23:16Z",
"validUntil": "2025-08-19T06:23:16Z"
},
"profile": {
"minorityIndicator": {
"value": "Social enterprise"
},
"classifications": [
{
"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {
"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [
{
"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {
"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [
{
"url": "https://cdq.com",
"type": {
"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [
{
"value": "developer-portal@cdq.com"
}
],
"tags": [
{
"value": "Warehouse",
"type": {
"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {
"publicationDate": "2025-08-19T06:23:16Z",
"status": {
"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {
"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {
"generalLicense": {
"professionType": {
"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {
"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [
{
"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {},
"activityStatus": {},
"practiceLocations": [
null
]
}
]
}
},
"relations": [
{
"startedAt": "2025-08-19T06:23:16Z",
"endedAt": "2025-08-19T06:23:16Z",
"type": {
"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {
"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2025-08-19T06:23:16Z"
}
],
"types": [
{
"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [
{
"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {
"language": {
"name": "German",
"technicalKey": "DE"
},
"characterSet": {
"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {
"value": "John Doe"
},
"careOf": {
"value": "CDQ GmbH c/o Product Department"
},
"contexts": [
{
"value": "Production hall 7, Storage field 8."
}
],
"country": {
"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [
{
"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {},
"language": {}
}
],
"postCodes": [
{
"value": "9000",
"type": {}
}
],
"localities": [
{
"type": {},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {}
}
],
"thoroughfares": [
{
"type": {},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {}
}
],
"premises": [
{
"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {},
"language": {}
}
],
"postalDeliveryPoints": [
{
"type": {},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {}
}
],
"geographicCoordinates": {
"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [
{
"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [
{
"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {
"firstPaymentDate": "2025-08-19T06:23:16Z",
"lastPaymentDate": "2025-08-19T06:23:16Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {
"identifiers": [
{
"value": "7250017031",
"type": {
"technicalKey": "KUNNR"
}
}
]
}
}
]
}'
Response
application/json
{ "businessPartners": [ { … } ], "fieldBusinessPartners": [ { … } ] }
- Production
https://api.cdq.com/data-exchange/rest/v3/datamappers/{id}/transformBusinessPartners
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/v3/datamappers/6440dba32b30176c5917b1b7/transformBusinessPartners \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"businessPartners": [
"63e635235c06b7396330fe40"
]
}'
Response
application/json
{ "businessPartners": [ { … } ] }
- Production
https://api.cdq.com/data-exchange/rest/v3/datamappers/{id}/transformFields
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/v3/datamappers/6440dba32b30176c5917b1b7/transformFields \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"businessPartners": [
{
"id": "63e635235c06b7396330fe40",
"createdAt": "2025-08-19T06:23:16Z",
"modifiedAt": "2025-08-19T06:23:16Z",
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [
{
"type": {
"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {
"sharingStatus": {
"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [
{
"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [
{
"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2025-08-19T06:23:16Z",
"triggerType": {
"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {
"processedAt": "2025-08-19T06:23:16Z",
"provenance": {},
"type": {}
},
"jobProcessedAt": "2025-08-19T06:23:16Z",
"processedAt": "2025-08-19T06:23:16Z",
"status": "INFO",
"description": "Validation Level",
"processingStatus": {
"technicalKey": "IN_PROGRESS",
"modifiedAt": "2025-08-19T06:23:16Z"
}
}
],
"decisionLogResult": {
"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [
{
"type": {
"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {
"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {
"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {
"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [
{
"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"identifiers": [
{
"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",
"issuingBody": {
"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {
"country": {}
}
},
"status": {
"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [
{
"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {
"type": {
"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2025-08-19T06:23:16Z",
"validUntil": "2025-08-19T06:23:16Z"
},
"profile": {
"minorityIndicator": {
"value": "Social enterprise"
},
"classifications": [
{
"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {
"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [
{
"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {
"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [
{
"url": "https://cdq.com",
"type": {
"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [
{
"value": "developer-portal@cdq.com"
}
],
"tags": [
{
"value": "Warehouse",
"type": {
"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {
"publicationDate": "2025-08-19T06:23:16Z",
"status": {
"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {
"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
},
"hcpProfile": {
"generalLicense": {
"professionType": {
"name": "Doctor",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key",
"technicalKey": "DOCTOR"
},
"licenseStatus": {
"name": "Granted",
"url": "https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key",
"technicalKey": "GRANTED"
}
},
"operationalPermissions": [
{
"issuingAuthority": "Swiss Medical Association",
"permissionStatus": {},
"activityStatus": {},
"practiceLocations": [
null
]
}
]
}
},
"relations": [
{
"startedAt": "2025-08-19T06:23:16Z",
"endedAt": "2025-08-19T06:23:16Z",
"type": {
"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {
"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {
"externalId": "The ID managed in the customer'\''s SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2025-08-19T06:23:16Z"
}
],
"types": [
{
"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [
{
"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {
"language": {
"name": "German",
"technicalKey": "DE"
},
"characterSet": {
"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {
"value": "John Doe"
},
"careOf": {
"value": "CDQ GmbH c/o Product Department"
},
"contexts": [
{
"value": "Production hall 7, Storage field 8."
}
],
"country": {
"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [
{
"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {},
"language": {}
}
],
"postCodes": [
{
"value": "9000",
"type": {}
}
],
"localities": [
{
"type": {},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {}
}
],
"thoroughfares": [
{
"type": {},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {}
}
],
"premises": [
{
"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {},
"language": {}
}
],
"postalDeliveryPoints": [
{
"type": {},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {}
}
],
"geographicCoordinates": {
"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [
{
"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [
{
"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {
"firstPaymentDate": "2025-08-19T06:23:16Z",
"lastPaymentDate": "2025-08-19T06:23:16Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {
"identifiers": [
{
"value": "7250017031",
"type": {
"technicalKey": "KUNNR"
}
}
]
}
}
]
}'
Response
application/json
{ "businessPartners": [ { … } ], "fieldBusinessPartners": [ { … } ] }