The Read Business Partner Updates endpoint provides an updated Business Partner structure and comprehensive
Business Partner information from the Reference Data Sources. By default, only the latest version of a Business Partner
from a single data source is provided. However, it's possible to access all historical updates (up to 3 months) by enabling
the FeaturesOn: FETCH_HISTORICAL_UPDATES
option.
Filtration
A list of updated Business Partners can be filtered in various ways, with tags being the most powerful and important.
Tags combine concepts (e.g., NAME_LOCAL
, IDENTIFIER
, LOCALITY
) with actions (e.g., ADDED
, MODIFIED
).
There are two types of classification filters:
Filtration by tag and conceptClassification
works in pairs and identifies Business Partners where, for example, the LOCAL_NAME
was MODIFIED
and this change was classified as MAJOR
. When filtering by tag and summaryClassification
, the endpoint returns all Business Partners
where the specified tags were added to the summary and the general summary classification is, for example,
IDENTIFIER_ADDED, + highest classification for all updates =MINOR
. Additional filtering options include country, provenance, and external IDs.
Providing the data source (or your mirror) in the request can enhance response speed.
It's possible to check the total number of updates using featuresOn NUMBER_OF_TOTAL, but can slow down the response.
Recommendations
We recommend periodically reading all Business Partners (at least once) to improve the efficiency of specific filtrations.
OK
Bad Request
{- "limit": "100",
- "total": "67",
- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "values": [
- {
- "id": "5712566172571652",
- "businessPartnerId": "63e635235c06b7396330fe40",
- "externalBusinessPartnerId": "The ID managed in the customer's SAP systems.",
- "updatedBusinessPartner": {
- "id": "63e635235c06b7396330fe40",
- "summary": {
- "tags": [
- "IDENTIFIER_ADDED"
], - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}
}, - "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- null
], - "before": {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
], - "updateAssessment": {
- "action": {
- "technicalKey": "ADDED"
}, - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}, - "provenances": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null,
- "subscribers": null
}
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- "IDENTIFIER_ADDED"
], - "before": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": null,
- "technicalKey": null
}, - "mainAbbreviation": "AG",
- "categories": [
- null
]
}
}
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen",
- "jurisdiction": {
- "country": null
}
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}, - "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- null
], - "before": {
- "type": null,
- "value": null,
- "issuingBody": null,
- "status": null
}
}
}
], - "categories": [
- {
- "name": "Hotel",
- "technicalKey": "HOTEL",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- null
], - "before": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
}
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-06-27T13:34:43Z",
- "validUntil": "2025-06-27T13:34:43Z",
- "updateAssessment": {
- "action": {
- "technicalKey": "ADDED"
}, - "classification": {
- "technicalKey": "MAJOR",
- "reason": "The modified post code has deprecated format."
}, - "provenances": [
- {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null,
- "subscribers": null
}
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- "IDENTIFIER_ADDED"
], - "before": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-06-27T13:34:43Z",
- "validUntil": "2025-06-27T13:34:43Z"
}
}
}, - "addresses": [
- {
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "externalId": "1",
- "metadata": {
- "language": {
- "name": null,
- "technicalKey": null
}
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": null,
- "isoCode": null,
- "type": null,
- "language": null,
- "updateAssessment": null
}
], - "postCodes": [
- {
- "value": null,
- "type": null,
- "updateAssessment": null
}
], - "localities": [
- {
- "type": null,
- "shortName": null,
- "value": null,
- "language": null,
- "updateAssessment": null
}
], - "thoroughfares": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "name": null,
- "direction": null,
- "language": null,
- "updateAssessment": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null,
- "language": null,
- "updateAssessment": null
}
], - "postalDeliveryPoints": [
- {
- "type": null,
- "shortName": null,
- "number": null,
- "value": null,
- "language": null,
- "updateAssessment": null
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275",
- "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
]
}
], - "externalId": "The ID managed in the customer's SAP systems.",
- "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"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
], - "vatPayerStatus": {
- "publicationDate": "2025-06-27T13:34:43Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "RA000009",
- "registrationAuthorityEntityId": "RA000009",
- "otherRegistrationAuthorityId": "RA000009"
}
}, - "hcpProfile": {
- "generalLicense": {
- "professionType": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "licenseStatus": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}, - "operationalPermissions": [
- {
- "issuingAuthority": null,
- "permissionStatus": null,
- "activityStatus": null,
- "practiceLocations": [ ],
- "updateAssessment": null
}
]
}
}, - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- null
], - "before": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
}
], - "relations": [
- {
- "startedAt": "2025-06-27T13:34:43Z",
- "endedAt": "2025-06-27T13:34:43Z",
- "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-06-27T13:34:43Z",
- "updateAssessment": {
- "action": {
- "technicalKey": null
}, - "classification": {
- "technicalKey": null,
- "reason": null
}, - "provenances": [
- null
], - "modifiedAt": "2025-06-27T13:34:43Z",
- "tags": [
- null
], - "before": {
- "startedAt": null,
- "endedAt": null,
- "type": null,
- "class": null,
- "startNode": null,
- "endNode": null,
- "deactivatedAt": null
}
}
}
], - "jsonRecord": "{\"key\":\"value\"}",
- "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}, - "updateAssessment": {
- "action": null,
- "classification": null,
- "provenances": [ ],
- "modifiedAt": null,
- "tags": [ ],
- "before": null
}
}
]
}
}, - "storageBusinessPartner": {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "2025-06-27T13:34:44Z",
- "modifiedAt": "2025-06-27T13:34:43Z",
- "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-06-27T13:34:43Z",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "trigger": {
- "processedAt": null,
- "provenance": null,
- "type": null
}, - "jobProcessedAt": "2025-06-27T13:34:43Z",
- "processedAt": "2025-06-27T13:34:43Z",
- "status": "INFO",
- "description": "Validation Level",
- "processingStatus": {
- "technicalKey": null,
- "modifiedAt": null
}
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
- "names": [
- {
- "type": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG",
- "shortName": "CDQ AG",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "AG",
- "categories": [
- {
- "name": "Limited Liability Company",
- "shortName": "LLC",
- "technicalKey": "LIMITED"
}
]
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": {
- "name": "Amtsgericht Aachen",
- "technicalKey": "Amtsgericht Aachen",
- "jurisdiction": {
- "country": null
}
}, - "status": {
- "name": "ACTIVE",
- "technicalKey": "ACTIVE"
}
}
], - "categories": [
], - "status": {
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}, - "officialDenotation": "Good Standing",
- "validFrom": "2025-06-27T13:34:43Z",
- "validUntil": "2025-06-27T13:34:43Z"
}, - "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"
}
], - "contactEmails": [
- {
- "value": "developer-portal@cdq.com"
}
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": null
}
}
], - "vatPayerStatus": {
- "publicationDate": "2025-06-27T13:34:43Z",
- "status": {
- "name": "RELIABLE",
- "technicalKey": "VAT_PAYER_STATUS"
}, - "registrationAuthority": {
- "registrationAuthorityId": "RA000009",
- "registrationAuthorityEntityId": "RA000009",
- "otherRegistrationAuthorityId": "RA000009"
}
}, - "hcpProfile": {
- "generalLicense": {
- "professionType": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "licenseStatus": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}, - "operationalPermissions": [
- {
- "issuingAuthority": null,
- "permissionStatus": null,
- "activityStatus": null,
- "practiceLocations": [ ]
}
]
}
}, - "relations": [
- {
- "startedAt": "2025-06-27T13:34:43Z",
- "endedAt": "2025-06-27T13:34:43Z",
- "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-06-27T13:34:43Z"
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "addresses": [
- {
- "id": "0001",
- "externalId": "1",
- "cdqId": "CDQID-123456789",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "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": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
]
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "countryCode": "DE",
- "vendorPaymentSummary": {
- "firstPaymentDate": "2025-06-27T13:34:44Z",
- "lastPaymentDate": "2025-06-27T13:34:44Z",
- "numberOfPayments": "1"
}
}
], - "externalContext": {
- "identifiers": [
- {
- "value": "7250017031",
- "type": {
- "technicalKey": null
}
}
]
}
}
}
]
}