Business Partners

Create Business Partner Tags

Allows the creation of Business Partner tags. The tags are created in the Business Partner profile.

SecurityapiKey

Request

path Parameters

businessPartnerId required	string (BusinessPartnerStorageId) Business Partner identifier within a storage. Example: 72d6900fce6b326088f5d9d91049e3e6
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

required

Array of objects (TagCreate) <= 30 items

List of Tags.

Responses

200

400

Bad Request

post/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
]
}

Response samples

application/json

{"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"results": [{"tag": {"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
},
"status": "OK"
}
]
}

Delete Business Partner Tags

Allows the deletion of Business Partner tags. The tags are deleted from the Business Partner profile.

SecurityapiKey

Request

path Parameters

businessPartnerId required	string (BusinessPartnerStorageId) Business Partner identifier within a storage. Example: 72d6900fce6b326088f5d9d91049e3e6
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

required

Array of objects (TagDelete) <= 30 items

List of deleted Tags.

Responses

200

400

Bad Request

post/v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
]
}

Response samples

application/json

{"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"results": [{"tag": {"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
},
"status": "OK"
}
]
}

Delete Business PartnersWSDL

Delete batches of Business Partners by ID or a combination of DataSource and External ID. Maximum of 1000 Business Partners are allowed per batch. In case only a data source is provided in the request, all Business Partners related to this data source will be deleted, but the data source itself will not be deleted.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

cmd

	Array of objects <= 1000 items List of Business Partners to be deleted.
dataSource	string (BusinessPartnerStorageDataSourceId) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e"
featuresOn	Array of strings (DeleteFeatureParam) List of features to be used during delete. Items Enum: "DELETE_BY_EXTERNAL_ID" "DELETE_BUSINESS_PARTNER_DATA" "DELETE_LINKS" Example: ["DELETE_BY_EXTERNAL_ID"]

Responses

200

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/storages/{storageId}/businesspartners/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataSource": "YOUR_DATASOURCE_ID",
"businessPartners": [{"externalId": "BP_EXTERNAL_ID"
}
],
"featuresOn": ["DELETE_BY_EXTERNAL_ID"
]
}

Response samples

application/json

{"numberOfDeletes": "50",
"numberOfFailures": "0",
"failures": [{"id": "63e635235c06b7396330fe40",
"dataSource": "648824a691d8d2503d65103e",
"externalId": "The ID managed in the customer's SAP systems.",
"message": "This record could not be stored due to timeout."
}
]
}

Fetch Business Partner

Fetch a Business Partner from this storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

dataSource

string (BusinessPartnerStorageDataSourceId)

Unique identifier for a Data Source of the Storage.

Example: "648824a691d8d2503d65103e"

externalId

required

string (BusinessPartnerExternalIdParam) non-empty

Arbitrary identifier type to mark customer IDs that are "external"\ \ from CDQ's perspective. This is the identifier a customer provides to identify\ \ its records.

Example: "The ID managed in the customer's SAP systems."

featuresOff

Array of strings (FetchBusinessPartnerFeatureParam)

Features to be excluded during the fetch Business Partner.

Items Enum:	Description
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: ["FETCH_RECORD"]

featuresOn

Array of strings (FetchBusinessPartnerFeatureParam)

Features to be used during the fetch Business Partner.

Items Enum:	Description
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: ["FETCH_RECORD"]

Responses

200

401

Unauthorized

403

Forbidden

post/v4/storages/{storageId}/businesspartners/fetch

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "648824a691d8d2503d65103e",
"featuresOn": ["FETCH_RECORD"
],
"featuresOff": ["FETCH_RECORD"
]
}

Response samples

application/json

{"businessPartner": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-04-26T15:08:00Z",
"provenance": {"name": "VIES",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"type": {"name": "CREATED",
"technicalKey": "CREATED"
}
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": {"shortName": "CH",
"value": "Switzerland"
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"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": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": "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": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type",
"technicalKey": "CITY"
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"thoroughfares": [{"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type",
"technicalKey": "INDUSTRIAL_ZONE"
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postalDeliveryPoints": [{"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
},
"status": "NOT_FOUND",
"message": "Business Partner has been fetched successfully."
}

Lookup Business PartnerWSDL

Lookup a Business Partner in provided storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

cmd

object (BusinessPartnerLookupParam)

Lookup business partner data in connected data sources like the CDQ Community Data Pool, Business registers, or even in the own data mirror.

dataSources

Array of strings

List of Data Sources.

Example: ["\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""]

featuresOff

Array of strings (FetchBusinessPartnerFeatureParam)

Features to be excluded during the fetch Business Partner.

Items Enum:	Description
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: ["FETCH_RECORD"]

featuresOn

Array of strings (FetchBusinessPartnerFeatureParam)

Features to be used during the fetch Business Partner.

Items Enum:	Description
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: ["FETCH_RECORD"]

matchingThreshold

number <double> (DataMatchingThreshold) [ 0 .. 1 ]

Default: 0

The threshold for the data matching.

Example: "0.5"

page

integer (Page) >= 0

Default: 0

Current page number.

Example: "1"

pageSize

integer (PageSize) [ 1 .. 1000 ]

Default: 10

Number of items per page.

Example: "100"

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/storages/{storageId}/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"matchingThreshold": "0.5",
"pageSize": "100",
"page": "1",
"dataSources": ["\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
],
"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"value": "Corporate Data Quality AG"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "CH_VAT_ID"
}
}
],
"legalForm": {"name": "Aktiengesellschaft"
},
"addresses": [{"country": {"shortName": "CH"
},
"administrativeAreas": [{"value": "Sankt Gallen"
}
],
"localities": [{"value": "Sankt Gallen"
}
],
"postCodes": [{"value": "9000"
}
],
"thoroughfares": [{"value": "Lukasstraße 4",
"number": "4"
}
]
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
},
"profile": {"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
]
}
},
"featuresOn": ["FETCH_RECORD"
],
"featuresOff": ["FETCH_RECORD"
]
}

Response samples

application/json

{"pageSize": "100",
"total": "67",
"page": "1",
"values": [{"businessPartner": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": null,
"technicalKey": null
},
"trigger": {"processedAt": null,
"provenance": null,
"type": null
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": null
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "+41 71 571 10 40"
}
],
"websites": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": null
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": null,
"technicalKey": null
},
"characterSet": "International"
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
}
},
"matchingProfile": {"matchingScores": {"overall": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"businessPartner": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
},
"address": {"classification": {"technicalKey": "HIGH",
"name": "My Matching Configuration"
},
"value": "0.9",
"explanation": "BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall: [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]"
}
}
}
}
],
"debugInfo": {"features": [{"feature": "TRANSFORM_RECORD",
"active": "true"
}
],
"request": {"matchingThreshold": "0.5",
"pageSize": "100",
"page": "1",
"dataSources": ["\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
],
"businessPartner": {"externalId": "The ID managed in the customer's SAP systems.",
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"value": "Corporate Data Quality AG"
}
],
"identifiers": [{"value": "CHE-218.608.886 HR/MWST",
"type": {"technicalKey": "CH_VAT_ID"
}
}
],
"legalForm": {"name": "Aktiengesellschaft"
},
"addresses": [{"country": {"shortName": "CH"
},
"administrativeAreas": [{"value": null
}
],
"localities": [{"value": null
}
],
"postCodes": [{"value": null
}
],
"thoroughfares": [{"value": null,
"number": null
}
]
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
},
"profile": {"tags": [{"value": "Warehouse",
"type": {"technicalKey": null
}
}
]
}
},
"featuresOn": ["FETCH_RECORD"
],
"featuresOff": ["FETCH_RECORD"
]
}
}
}

Poll Toggle Update Monitoring Job

Poll endpoint for job created in POST toggleUpdateMonitoringJobs.

SecurityapiKey

Request

path Parameters

jobId

required

string (JobId)

Unique identifier of a job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de

Responses

200

get/jobs/toggleUpdateMonitoringJobs/{jobId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"job": {"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"createdBy": "76248934691294444",
"createdAt": "2024-04-26T15:08:00Z",
"modifiedAt": "2024-04-26T15:08:00Z",
"progress": "77",
"status": "RUNNING",
"statusMessage": "The job failed because storage is empty.",
"enable": "true",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dataSourceId": "648824a691d8d2503d65103e",
"countryShortName": "CH"
},
"status": "OK"
}

Read Business Partner

Read Business Partner by ID.

SecurityapiKey

Request

path Parameters

id required	string (BusinessPartnerId) Unique identifier of the Business Partner. Example: 63e635235c06b7396330fe40
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

featureOff	Array of strings (ReadBusinessPartnerFeatureParam) Features to be deactivated during the read Business Partner. Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_RECORD" "FETCH_RELATIONS" Example: featureOff=FETCH_RECORD
featureOn	Array of strings (ReadBusinessPartnerFeatureParam) Features to be used during the read Business Partner. Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_RECORD" "FETCH_RELATIONS" Example: featureOn=FETCH_RECORD

Responses

200

get/v4/storages/{storageId}/businesspartners/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-04-26T15:08:00Z",
"provenance": {"name": "VIES",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"type": {"name": "CREATED",
"technicalKey": "CREATED"
}
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": {"shortName": "CH",
"value": "Switzerland"
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"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": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": "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": {"name": "COUNTY",
"url": "https://meta.cdq.com/Address/administrative_area/type",
"technicalKey": "COUNTY"
},
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
}
],
"localities": [{"type": {"name": "City",
"url": "https://meta.cdq.com/Address/locality/type",
"technicalKey": "CITY"
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"thoroughfares": [{"type": {"name": "Industrial zone",
"url": "https://meta.cdq.com/Address/thoroughfare/type",
"technicalKey": "INDUSTRIAL_ZONE"
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"postalDeliveryPoints": [{"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}

Read Business PartnersWSDL

Read a page of business partners from the storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

businessPartnerId

Array of strings (BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40

countryCode

Array of strings (schemas-CountryShortName)

Country code (ISO 3166-1 alpha-2) used to filter the result of business partners returned.

Example: countryCode=CH

curationLogResultStatus

Array of strings (CurationLevelParam)

Curation log of curation result.

Items Enum:	Description
UNKNOWN	No possibility to determine curation level.
LEVEL_1	The address was not found by the CDQ in the employed external data sources.
LEVEL_2	The address was found, but there were significant changes in critical fields.
LEVEL_3	The address was found and there are minor changes in highly important fields.
LEVEL_4	The address was found by the CDQ. There were only changes in less critical fields such as the address/premise or address/thoroughfare/number.
LEVEL_5	The address was found by the CDQ, but no major changes have been made as the address was correct.
LEVEL_6	The address was found in the shared CDQ data pool. This means another company uses the same address which is a very reliable indicator that the address is correct (only in an alpha version).

Example: curationLogResultStatus=LEVEL_1

dataSource

Array of strings (BusinessPartnerDataSource)

Data Source (name or ID) to be measured during calculating statistics. By default, all Data Sources are measured.

Example: dataSource="CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e"

externalId

Array of strings (BusinessPartnerExternalId)

Business Partner externalIDs.

Example: externalId=The ID managed in the customer's SAP systems.

featuresOff

Array of strings (BusinessPartnersReadFeatureParam)

Features to be deactivated.

Items Enum:	Description
APPLY_CURATION_DECISIONS	Applies curation decisions from Decision Log to business partner if any decisions found. By default, deactivated.
CURATION_LOG_RESULT_STATUSES	Allows to switch fetching curation log result statuses. By default, deactivated.
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.
NUMBER_OF_TOTAL	Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.
USE_NEXT_START_AFTER	Allows to switch fetching the next page of Business Partners using the nextStartAfter value. By default, deactivated.
VALIDATION_LOG_RESULT_STATUSES	Allows to switch fetching validation log result statuses. By default, deactivated.

Example: featuresOff=APPLY_CURATION_DECISIONS

featuresOn

Array of strings (BusinessPartnersReadFeatureParam)

Features to be activated.

Items Enum:	Description
APPLY_CURATION_DECISIONS	Applies curation decisions from Decision Log to business partner if any decisions found. By default, deactivated.
CURATION_LOG_RESULT_STATUSES	Allows to switch fetching curation log result statuses. By default, deactivated.
FETCH_RECORD	Allows to switch fetching record field to reduce data size. By default, turned on.
FETCH_RELATIONS	Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.
NUMBER_OF_TOTAL	Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.
USE_NEXT_START_AFTER	Allows to switch fetching the next page of Business Partners using the nextStartAfter value. By default, deactivated.
VALIDATION_LOG_RESULT_STATUSES	Allows to switch fetching validation log result statuses. By default, deactivated.

Example: featuresOn=APPLY_CURATION_DECISIONS

fromJobProcessedAt

string

Returns the results which have one of the log result status -> jobProcessedAt after given date. The given date should support ISO-8601 representation.

Example: fromJobProcessedAt=2024-04-26T15:08:00Z

fromProcessedAt

string

Returns the results which have one of the log result status -> processedAt after given date. The given date should support ISO-8601 representation.

Example: fromProcessedAt=2024-04-26T15:08:00Z

fromTriggerProcessedAt

string

Returns the results which have one of the log result status -> triggerProcessedAt after given date. The given date should support ISO-8601 representation.

Example: fromTriggerProcessedAt=2024-04-26T15:08:00Z

hasRawData

boolean

Default: false

Flag to filter result of business partners based on the existence of the record attribute (raw data).

Example: hasRawData=false

limit

integer <int32> >= 1

Default: 500

Number of items to be returned on the page.

Example: limit=100

logResultTriggerProvenanceTechnicalKeys

Array of strings (ProvenanceTechnicalKey)

Provenance technical keys used for filtering the result which should match with at least one of any log result status -> triggerType fields.

Example: logResultTriggerProvenanceTechnicalKeys=VIES

logResultTriggerType

Array of strings (ProcessingLogResultStatusTriggerTypeTechnicalKeyParam)

Trigger type used for filtering the result which should match with at least one of any log result status -> triggerType fields.

Items Enum: "CREATED" "UPDATED" "REFERENCE_DATA_CHANGED" "REFRESHED" "JOB"

Example: logResultTriggerType=CREATED

modifiedAfter

string

Return entries which were modified after given data. The given date should support ISO-8601 representation.

Example: modifiedAfter=2024-04-26T15:08:00Z

modifiedBefore

string

Return entries which were modified before given data. The given date should support ISO-8601 representation.

Example: modifiedBefore=2024-04-26T15:08:00Z

reviewStatus

string (ReviewStatusParam)

Review status used for filtering the result data.

Enum:	Description
REVIEWED	Reviewed.
NOT_REVIEWED	Not reviewed.

Example: reviewStatus=REVIEWED

sharingStatus

Array of strings

Business Partner Sharing Status which should be filtered.

Sharing Statuses which can be filtered out:

UNDER_CONSIDERATION
UNDISCLOSED_RECORD
MISSING_INFORMATION_FOR_LINKAGE
ERRONEOUS_INFORMATION_FOR_LINKAGE
ERRONEOUS_RECORD
PENDING_LINKAGE_DECISION
PROCESS_ISSUE
SHARED_WITH_NO_MATCH
SHARED_WITH_CONFIDENT_MATCH
SHARED_WITH_NO_MATCH_BY_REVIEW
SHARED_BY_REVIEW

Example: sharingStatus=UNDER_CONSIDERATION

startAfter

string

Only items with an ID greater than the given one will be retrieved.

When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page.

Example: startAfter=5712566172571652

tagTypeTechnicalKey

string (TagTypeTechnicalKey)

Type Technical Key of tags that are provided in 'tagValues' query param.

Example: tagTypeTechnicalKey=WAREHOUSE

tagValues

Array of strings (TagValue)

Tag values that will be used to filter Business Partners. Values are connected with logical 'AND'.

Example: tagValues=Warehouse

toJobProcessedAt

string

Returns the results which have one of the log result status -> jobProcessedAt before given date. The given date should support ISO-8601 representation.

Example: toJobProcessedAt=2024-04-26T15:08:00Z

toProcessedAt

string

Returns the results which have one of the log result status -> processedAt before given date. The given date should support ISO-8601 representation.

Example: toProcessedAt=2024-04-26T15:08:00Z

toTriggerProcessedAt

string

Returns the results which have one of the log result status -> triggerProcessedAt before given date. The given date should support ISO-8601 representation.

Example: toTriggerProcessedAt=2024-04-26T15:08:00Z

typeTechnicalKeys

Array of strings (BusinessPartnerTypeTechnicalKeyParam) <= 1 items

Business Partner type technical keys which should be filtered.

Items Enum: "BP_ADDRESS" "LEGAL_ENTITY" "ORGANIZATIONAL_UNIT" "UNKNOWN" "BRAND"

Example: typeTechnicalKeys=LEGAL_ENTITY

updateMonitoring

boolean

Flag to filter business partners by the value of updateMonitoring attribute.

Example: updateMonitoring=true

validationLogResultStatus

Array of strings (ValidationLevelParam)

Violation level of validation result.

Items Enum:	Description
OK	No data quality issues have been found after executing all the rules.
ERROR	At least 1 `ERROR` defect has been found.
WARNING	At least 1 `WARNING` defect has been found.
INFO	At least 1 `INFO` defect has been found.
UNKNOWN	No `ERROR` has been found, but at least one data quality rule could not be executed.

Example: validationLogResultStatus=WARNING

validationSharingLogResultStatus

Array of strings (ValidationLevelParam)

Violation level of sharing validation result.

Items Enum:	Description
OK	No data quality issues have been found after executing all the rules.
ERROR	At least 1 `ERROR` defect has been found.
WARNING	At least 1 `WARNING` defect has been found.
INFO	At least 1 `INFO` defect has been found.
UNKNOWN	No `ERROR` has been found, but at least one data quality rule could not be executed.

Example: validationSharingLogResultStatus=WARNING

Responses

200

400

Bad Request

401

Unauthorized

get/v4/storages/{storageId}/businesspartners

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-04-26T15:08:00Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"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": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": "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": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
],
"nextStartAfter": "5712566172571652"
}

Read Business Partners Updates

Example Response:

{
  "values": [
    {
      "businessPartner": {
        "id": "123456",
        "externalId": "EXTID-86",
        ...,
        "record": "{<JSON>}"
      },
      "provenances": [
        {
          "name": "Supplier Gateway",
          "technicalKey": "SGW"
        }
      ],
      "changeSet": [
        {
          "modifiedAt": "2007-08-31T16:47",
          "propertyChanges": [
            {
              "newContent": "AAB",
              "previousContent": "XYZ",
              "changeType": "MODIFIED",
              "changeClassification": "MAJOR",
              "provenance": {
                "name": "Supplier Gateway",
                "technicalKey": "SGW"
              },
              "property": {
                "name": "Minority Indicator Value",
                "contentSelector": "$.profile.minorityIndicator.value",
                "technicalKey": "MINORITY_INDICATOR_VALUE"
                "parentConcept": {
                  "name": "Minority Indicator",
                  "technicalKey": "MINORITY_INDICATOR"
                }
              }
            }
          ],
          "provenances": [
            {
              "name": "Supplier Gateway",
              "technicalKey": "SGW"
            }
          ]
        }
      ]
    }
  ]
}

In typed concepts, like Name, Identifier or Premise, type.technicalKey and any non-empty property are required to be filled in order to monitor updates.

The following limits for updates calculated per concepts is applied:

$.addresses.administrativeAreas: up to 5 sub concept levels supported
$.addresses.localities: up to 5 sub concept levels supported
$.addresses.postCodes: up to 3 sub concepts supported
$.addresses.postalDeliveryPoints: up to 3 sub concepts supported
$.addresses.thoroughfares: up to 3 sub concepts supported
$.addresses.premises: up to 6 sub concepts supported

Max limit allowed is 1000.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

affectedConcepts

Array of strings (BusinessPartnerConceptParam)

Only show updates which affected these concepts.

Items Enum:	Description
NAME	Name of the Business Partner.
IDENTIFIER	Identifier of the Business Partner.
LEGAL_FORM	Legal form of the Business Partner.
MINORITY_INDICATOR	Minority indicator of the Business Partner.
STATUS	Status of the Business Partner.
ADDRESS	Address of the Business Partner.
COUNTRY	Country of the Business Partner.
ADMINISTRATIVE_AREA	Administrative area of the Business Partner.
POST_CODE	Post code of the Business Partner.
LOCALITY	Locality of the Business Partner.
THOROUGHFARE	Thoroughfare of the Business Partner.
PREMISE	Premise of the Business Partner.
POSTAL_DELIVERY_POINT	Postal delivery point of the Business Partner.
GEOGRAPHIC_COORDINATES	Geographic coordinates of the Business Partner.
BUSINESS_PARTNER_RELATION	Relation of the Business Partner.

Example: affectedConcepts=MINORITY_INDICATOR

affectedProperties

Array of strings (BusinessPartnerPropertyParam)

Only show updates which affected these properties.

Items Enum:	Description
NAME_VALUE	Value of Name of the Business Partner.
IDENTIFIER_VALUE	Value of Identifier of the Business Partner
MINORITY_INDICATOR_VALUE	Value of Minority indicator of the Business Partner.
ADMINISTRATIVE_AREA_VALUE	Value of Administrative area of the Business Partner.
LOCALITY_VALUE	Value of Locality of the Business Partner.
POST_CODE_VALUE	Value of Post code of the Business Partner.
THOROUGHFARE_VALUE	Value of Thoroughfare of the Business Partner.
THOROUGHFARE_NUMBER	Thoroughfare number of the Business Partner.
BUSINESS_PARTNER_STATUS_TYPE	Status of the Business Partner.
LEGAL_FORM_NAME	Legal form of the Business Partner.
RECORD	Record status of the Business Partner.

Example: affectedProperties=MINORITY_INDICATOR_VALUE

businessPartnerIds

Array of strings (BusinessPartnerId) <= 500 items

Only show updates for listed Business Partner IDs. When providing list of Business Partner IDs, limit is ignored to provide full page.

Example: businessPartnerIds=63e635235c06b7396330fe40

changeClassification

string (PropertyChangeClassificationParam)

Filter for change classifications.

Enum:	Description
UNMODIFIED	The attribute was not changed.
TRIVIAL	The attribute was changed, but the change is not important.
MINOR	The attribute was changed, but the change is minor.
MAJOR	The attribute was changed, and the change is major.
REJECTED	The attribute was changed, but the change was rejected.
CRITICAL	The attribute was changed, and the change is critical.

Example: changeClassification=TRIVIAL

changeType

string

Filter for change types.

Enum: "ADDED" "MODIFIED" "DELETED"

Example: changeType=ADDED

countryShortName

Array of strings

Filter for countries.

Example: countryShortName=CH

dataSource

Array of strings

Filter for a data source (name or id).

Example: dataSource=VIES

exceptProvenanceTechnicalKeys

Array of strings (ProvenanceTechnicalKey)

Show updates for all provenances except provided by technical keys. By default, includes ORGANIZATION if not present on provenanceTechnicalKeys list.

Example: exceptProvenanceTechnicalKeys=VIES

externalIds

Array of strings (BusinessPartnerExternalId) <= 100 items

Filter updates by Business Partner externalId, limit is ignored to provide full page. When used with the businessPartnerIds parameter, only business partners that have one of the specified externalIds AND one of the specified businessPartnerIds will be returned.

Example: externalIds=The ID managed in the customer's SAP systems.

featuresOff

Array of strings (BusinessPartnerUpdatesFeatureParam)

Features to be used during the read Business Partner updates:

APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to Business Partners in $.values[*].storageBusinessPartner if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default, deactivated.
FETCH_STORAGE_BUSINESS_PARTNER - Fetch Business Partner from a storage and set in $.values[*].storageBusinessPartner. By default, deactivated.
FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS - Fetch Business Partner from a storage and set in $.values[*].storageBusinessPartner including relations. By default, deactivated.
NUMBER_OF_TOTAL - Allows to switch fetching the total number of records to improve performance. By default, turned on.
SHOW_BUSINESS_PARTNER - Show Business Partner merged out of updates in $.values[*].businessPartner. By default, deactivated.

Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_STORAGE_BUSINESS_PARTNER" "FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS" "SHOW_BUSINESS_PARTNER"

Example: featuresOff=SHOW_BUSINESS_PARTNER

featuresOn

Array of strings (BusinessPartnerUpdatesFeatureParam)

Features to be used during the read Business Partner updates:

APPLY_CURATION_DECISIONS - Applies curation decisions from Decision Log to Business Partners in $.values[*].storageBusinessPartner if any decisions found. Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default, deactivated.
FETCH_STORAGE_BUSINESS_PARTNER - Fetch Business Partner from a storage and set in $.values[*].storageBusinessPartner. By default, deactivated.
FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS - Fetch Business Partner from a storage and set in $.values[*].storageBusinessPartner including relations. By default, deactivated.
NUMBER_OF_TOTAL - Allows to switch fetching the total number of records to improve performance. By default, turned on.
SHOW_BUSINESS_PARTNER - Show Business Partner merged out of updates in `$.values[*].businessPartner. By default, deactivated.

Items Enum: "APPLY_CURATION_DECISIONS" "FETCH_STORAGE_BUSINESS_PARTNER" "FETCH_STORAGE_BUSINESS_PARTNER_WITH_RELATIONS" "SHOW_BUSINESS_PARTNER"

Example: featuresOn=SHOW_BUSINESS_PARTNER

from

string

Only show updates which have been modified after this date (ISO 8601). Default is to show the 'last seven days' and farthest in the past is 'since three month'.

Example: from=2024-04-26T15:08:00Z

limit

integer <int32> >= 1

Default: 500

Number of items to be returned on the page.

Example: limit=100

provenanceTechnicalKeys

Array of strings (ProvenanceTechnicalKey)

Show updates for selected provenances by technical keys.

Example: provenanceTechnicalKeys=VIES

startAfter

string

Only items with an ID greater than the given one will be retrieved.

When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page.

Example: startAfter=5712566172571652

Responses

200

get/v4/storages/{storageId}/businesspartners/updates

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"limit": "100",
"total": "67",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"values": [{"businessPartnerId": "63e635235c06b7396330fe40",
"externalBusinessPartnerId": "The ID managed in the customer's SAP systems.",
"changeSets": [{"modifiedAt": "2024-04-26T15:08:00Z",
"propertyChanges": [{"externalIds": [null
],
"property": {"parentConcept": null,
"name": null,
"technicalKey": null,
"contentSelector": null,
"instanceSelectors": [ ]
},
"newContent": "AAB",
"previousContent": "AAB",
"provenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"changeType": "MODIFIED",
"changeClassification": "MAJOR",
"confidenceScore": "0.0",
"maxConfidenceScore": "1.0"
}
],
"provenances": [{"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
}
]
}
],
"businessPartner": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": null,
"technicalKey": null
},
"trigger": {"processedAt": null,
"provenance": null,
"type": null
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": null
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "+41 71 571 10 40"
}
],
"websites": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": null
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": null,
"technicalKey": null
},
"characterSet": "International"
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
}
},
"storageBusinessPartner": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-04-26T15:08:00Z",
"lastModifiedAt": "2024-04-26T15:08:00Z",
"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": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"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": "2024-04-26T15:08:00Z",
"triggerType": {"name": null,
"technicalKey": null
},
"trigger": {"processedAt": null,
"provenance": null,
"type": null
},
"jobProcessedAt": "2024-04-26T15:08:00Z",
"processedAt": "2024-04-26T15:08:00Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"additionalInformation": [{"key": "KEY",
"value": "1"
}
],
"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": null
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": "In Liquidation",
"officialDenotation": "Good Standing",
"validFrom": "2024-04-26T15:08:00Z",
"validUntil": "2024-04-26T15:08:00Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"value": "+41 71 571 10 40"
}
],
"websites": ["www.cdq.com"
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": null
}
}
],
"vatPayerStatus": {"publicationDate": "2024-04-26T15:08:00Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": ["Commercial ultimate"
],
"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": null,
"technicalKey": null
},
"characterSet": "International"
},
"identifyingName": {"value": "John Doe"
},
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": null
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": null,
"shortName": null,
"isoCode": null,
"type": null,
"language": null
}
],
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
],
"premises": [{"value": null,
"shortName": null,
"number": null,
"type": null,
"language": null
}
],
"postalDeliveryPoints": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"language": null
}
],
"geographicCoordinates": "47.439549, 9.395275",
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"metadata": "DE, Google"
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-04-26T15:08:00Z",
"lastPaymentDate": "2024-04-26T15:08:00Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
}
},
"provenances": [{"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
}
]
}
]
}

Start Toggle Update Monitoring Job

To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:

A complete Data Source identified by the parameter 'dataSourceId'
Or for a certain Country of a Data Source. This requires both parameters 'dataSourceId' and 'countryShortName' to be set

After the job is finished, the following actions are taken for Business Partners which match the dataSourceId and countryShortName criteria:

businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
if enable is true then:
- an attempt is taken to find Business Partner in all configured update monitors for non-commercial reference data sources and links are created if matches are found via defined linkage strategies
- if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to Business Partner updates
if enable is false then:
- all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
- updates are no more propagated for this Business Partner
- linkage is not performed for any non-commercial reference data source

For toggling via a list of Business Partners, identified by their ID, please go to Toggle Update Monitoring of Business Partners.

SecurityapiKey

Request

Request Body schema: application/json
required

countryShortName	string (schemas-CountryShortName) Country code (ISO 3166-1 alpha-2). Example: "CH"
dataSourceId required	string (BusinessPartnerStorageDataSourceId) Unique identifier for a Data Source of the Storage. Example: "648824a691d8d2503d65103e"
description	string (JobDescription) Detailed description of a Job. Example: "I started this job to improve quality of our data."
enable required	boolean (ToggleUpdateMonitoringRequestEnable) Parameter to describe if the Business Partners should be activated for update monitoring (true) or deactivated (false) for non-commercial reference data sources. Example: "true"
name	string (JobName) Name of a Job. Example: "Process vendor data."
storageId required	string (BusinessPartnerStorageId) Unique identifier of the Storage. Example: "72d6900fce6b326088f5d9d91049e3e6"

Responses

200

400

The sent request is malformed.

post/jobs/toggleUpdateMonitoringJobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"enable": "true",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"name": "Process vendor data.",
"description": "I started this job to improve quality of our data.",
"dataSourceId": "648824a691d8d2503d65103e",
"countryShortName": "CH"
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"createdBy": "76248934691294444",
"createdAt": "2024-04-26T15:08:00Z",
"modifiedAt": "2024-04-26T15:08:00Z",
"progress": "77",
"status": "RUNNING",
"statusMessage": "The job failed because storage is empty.",
"enable": "true",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"dataSourceId": "648824a691d8d2503d65103e",
"countryShortName": "CH"
}

Toggle Update Monitoring of Business Partners

To toggle update monitoring on multiple BusinessPartners, the permission can be changed via a list of Business Partners, identified by their ID.

After the job is finished, the following actions are taken for Business Partners which match the businessPartnerIds criteria:

businessPartner.updateMonitoring fields takes a value of ToggleUpdateMonitoringJobRequest#enable
if enable is true then:
- an attempt is taken to find Business Partner in all configured update monitors for non-commercial reference data sources and links are created if matches are found via defined linkage strategies
- if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to Business Partner updates
if enable is false then:
- all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
- updates are no more propagated for this Business Partner
- linkage is not performed for any non-commercial reference data source

For toggling a complete Data Source or for a certain Country of a Data Source, please go to Start Toggle Update Monitoring Job.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

businessPartnerIds required	Array of strings (BusinessPartnerId) [ 1 .. 1000 ] items List of Business Partner IDs to identify all those Business Partners that should be activated/deactivated. Example: ["63e635235c06b7396330fe40"]
enable required	boolean (ToggleUpdateMonitoringRequestEnable) Parameter to describe if the Business Partners should be activated for update monitoring (true) or deactivated (false) for non-commercial reference data sources. Example: "true"

Responses

204

put/storages/{storageId}/businesspartners/toggleUpdateMonitoring

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"enable": "true",
"businessPartnerIds": ["63e635235c06b7396330fe40"
]
}

Update Disclosure

To un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:

A complete data source identified by the parameter 'dataSourceId' (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)
Or for a certain country of a data source. This requires both parameters 'dataSourceId' and 'countryCode' to be set (deprecated - use Sharing Scopes instead. Still applicable, but can be overwritten by Sharing Scopes)
Or a list of Business Partners, identified by their ID. The other parameters should be left empty. Note: disclosure set via Business Partner ID can be overwritten by creation or deletion of a Sharing Scope.

Any other combination may result in a Bad Request.

For more details, you can read about Sharing Scopes.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

businessPartnerIds	Array of strings (BusinessPartnerId) non-empty List of BusinessPartner IDs to identify all those BusinessPartners that should be un-/disclose. Example: ["63e635235c06b7396330fe40"]
countryCode	string Deprecated A country code (ISO 3166-2), to be used in combination with a DataSource ID to un-/disclose all matching BusinessPartners. Example: "DE"
dataSourceId	string Deprecated A DataSource ID for which all related BusinessPartners should be un-/disclose. Example: "648824a691d8d2503d65103e"
disclosed required	boolean Parameter to describe if the BusinessPartners should be disclosed (true) or undisclosed (false). Example: "true"

Responses

200

post/v3/storages/{storageId}/businesspartners/updateDisclosure

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"disclosed": "true",
"dataSourceId": "648824a691d8d2503d65103e",
"countryCode": "DE",
"businessPartnerIds": ["63e635235c06b7396330fe40"
]
}

Upsert Business PartnersWSDL

Upsert Business Partners in a Business Partner storage in batches. Maximum of 1000 Business Partners are allowed per batch.

If no data source (via field: dataSource) is provided and the storage has only one, then this data source will be used/set. Other options are to provide an existing data source in the request, which will then be taken for all the Business Partner or to provide a data source for each Business Partner individually.

In the following cases an API error will be thrown:

given data source in the Request or the BusinessPartner is unknown
no data source given and more than one data source is attached to the storage

To start upserting Business Partners into a storage, use the following request.

PUT https://api.corporate-data-league.ch/data-exchange/rest/v4/storages/{YOUR STORAGE ID}/businesspartners
{
  "dataSource": "{YOUR DATA SOURCE}",
  "featuresOn": ["UPSERT_BY_EXTERNAL_ID"],
  "businessPartners": [
   {
     "externalId": "123",
     "record": "{\"MyId\":\"123\", \"City\":\"St. Gallen\"}"
   }]
}

The response is shown below.

{
   "numberOfAccepted": "1",
   "numberOfFailed": "0",
}

Upserting Business Partners enables automated data transformation from the record field to the Business Partner model. It requires a Data Mapper Definition and assigned to dataMapperDefinitionId field of a data source Business Partner is being upserted to.

record field requires stringified JSON. Characters: backslash \ and double quote " must be escaped (respectively: \\\\ and \"). Fields containing . are unallowed."

To enable automated data transformation, one of the following features is required:

TRANSFORM_RECORD - synchronous transformation, limited for batch size <= 250,
ENABLE_ASYNC - asynchronous transformation. Enabled by default when TRANSFORM_RECORD is not requested.

Automated data transformation can be executed together with the UPSERT_BY_EXTERNAL_ID feature, but it requires to provide external ID as a field externalId of a Business Partner, which is preserved during the transformation.

If there is no name typed LOCAL in businessPartner.names and exists any name with empty type or not filled type.technicalKey, it becomes name of type LOCAL.

Warn: in order to support multiple data sources, include dataSource into the request, either in $.dataSource or $.businessPartners[*].dataSource. Otherwise, multiple data sources with no selection of data source will lead to "No DataSource was provided for the given Business Partners and the storage has more than one attached to it." exception.

Limits

Business Partner and Address fields have defined array size limits

Path	Max array size
$.businessPartners[*].names	20
$.businessPartners[*].identifiers	20
$.businessPartners[*].categories	20
$.businessPartners[*].addresses	20
$.businessPartners[*].relations	20
$.businessPartners[*].types	20
$.businessPartners[*].bankAccounts	50
$.businessPartners[*].profile.websites	20
$.businessPartners[*].profile.classifications	20
$.businessPartners[*].profile.contactEmails	20
$.businessPartners[*].profile.phoneNumbers	20
$.businessPartners[].addresses[].contexts	100
$.businessPartners[].addresses[].administrativeAreas	20
$.businessPartners[].addresses[].postCodes	20
$.businessPartners[].addresses[].localities	20
$.businessPartners[].addresses[].thoroughfares	20
$.businessPartners[].addresses[].premises	20
$.businessPartners[].addresses[].postalDeliveryPoints	20
$.businessPartners[].addresses[].types	20

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

Parameters for Business Partners Upsert.

required

Array of objects (BusinessPartner) [ 1 .. 1000 ] items

List of Business Partners.

dataSource

string (BusinessPartnerDataSource)

Name or ID of a data source. Reflects the associated external system where the record originates from.

Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""

featuresOff

Array of strings (UpsertFeatureParam)

Features to be deactivated during the upsert.

Items Enum:	Description
UPSERT_BY_EXTERNAL_ID	Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage.
API_ERROR_ON_FAILURES	Throws exception instead of default Upsert Failure Log.
TRANSFORM_RECORD	Transforms record into Business Partner model using the dataMapperDefinition attached to the dataSource. Supported only for batch size up to 250 Business Partners.
ENABLE_SETTINGS	Enables usage of user and organization settings in upsert process. Enabled by default.
ENABLE_ASYNC	Stores data to the storage. Enables asynchronous data processing for transformation, updates, indexing and sharing processes. Requires externalId to be present in the businessPartner. Enabled by default when TRANSFORM_RECORD not used.

Example: ["UPSERT_BY_EXTERNAL_ID"]

featuresOn

Array of strings (UpsertFeatureParam)

Features to be activated during the upsert.

Items Enum:	Description
UPSERT_BY_EXTERNAL_ID	Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage.
API_ERROR_ON_FAILURES	Throws exception instead of default Upsert Failure Log.
TRANSFORM_RECORD	Transforms record into Business Partner model using the dataMapperDefinition attached to the dataSource. Supported only for batch size up to 250 Business Partners.
ENABLE_SETTINGS	Enables usage of user and organization settings in upsert process. Enabled by default.
ENABLE_ASYNC	Stores data to the storage. Enables asynchronous data processing for transformation, updates, indexing and sharing processes. Requires externalId to be present in the businessPartner. Enabled by default when TRANSFORM_RECORD not used.

Example: ["UPSERT_BY_EXTERNAL_ID"]

Responses

200

put/v4/storages/{storageId}/businesspartners

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataSource": "YOUR_DATASOURCE_ID",
"featuresOn": ["UPSERT_BY_EXTERNAL_ID"
],
"businessPartners": [{"externalId": "YOUR_EXTERNAL_ID",
"record": "{\"Customer number\":\"YOUR_EXTERNAL_ID\", \"Name\":\"COMPANY_NAME\", \"Country\":\"COUNTRY_CODE\", \"City\":\"CITY\", \"Street\":\"STREET\", \"Postal code\":\"POSTAL_CODE\"}"
}
]
}

Response samples

application/json

{"numberOfAccepted": "10",
"numberOfFailed": "10",
"failures": [{"id": "567326478287468742",
"externalId": "LFA1.1234567",
"message": "This record could not be stored due to timeout."
}
],
"featuresOn": ["UPSERT_BY_EXTERNAL_ID"
]
}

Business Partners

Create Business Partner Tags

path Parameters

Request Body schema: application/jsonrequired

Delete Business Partner Tags

path Parameters

Request Body schema: application/jsonrequired

Delete Business PartnersWSDL

path Parameters

Request Body schema: application/jsonrequired

Fetch Business Partner

path Parameters

Request Body schema: application/jsonrequired

Lookup Business PartnerWSDL

path Parameters

Request Body schema: application/jsonrequired

Poll Toggle Update Monitoring Job

path Parameters

Read Business Partner

path Parameters

query Parameters

Read Business PartnersWSDL

path Parameters

query Parameters

Read Business Partners Updates

path Parameters

query Parameters

Start Toggle Update Monitoring Job

Request Body schema: application/jsonrequired

Toggle Update Monitoring of Business Partners

path Parameters

Request Body schema: application/jsonrequired

Update Disclosure

path Parameters

Request Body schema: application/jsonrequired

Upsert Business PartnersWSDL

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required