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 delete, but the data source itself will not be deleted.
OK
Created
Unauthorized
Forbidden
Not Found
{- "dataSource": "YOUR_DATASOURCE_ID",
- "businessPartners": [
- {
- "externalId": "BP_EXTERNAL_ID"
}
], - "featuresOn": [
- "DELETE_BY_EXTERNAL_ID"
]
}
{- "numberOfDeletes": 0,
- "numberOfFailures": 0,
- "failures": [
- {
- "id": 567326478287468740,
- "dataSource": "string",
- "externalId": "LFA1.1234567",
- "message": "This record could not be stored due to timeout."
}
]
}
Fetch a Business Partner from this storage
OK
Unauthorized
Forbidden
{- "externalId": "string",
- "dataSource": "string",
- "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
{- "businessPartner": {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "addresses": [
- {
- "country": {
- "shortName": null,
- "value": null
}, - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
]
}
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": null,
- "name": null,
- "technicalKey": null
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "addresses": [
- {
- "country": {
- "shortName": null,
- "value": null
}, - "postCodes": [
- null
], - "localities": [
- null
], - "thoroughfares": [
- null
]
}
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": "string"
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "string",
- "shortName": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postCodes": [
- {
- "value": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "localities": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "value": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "name": "string",
- "direction": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "premises": [
- {
- "value": "string",
- "shortName": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "geographicCoordinates": {
- "latitude": 0,
- "longitude": 0
}, - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}, - "status": "string",
- "message": "string"
}
Lookup a Business Partner in this storage.
cmd
OK
Unauthorized
Forbidden
Not Found
{- "matchingThreshold": 0,
- "pageSize": 10,
- "page": 0,
- "dataSources": [
- "string"
], - "businessPartner": {
- "externalId": "string",
- "record": "string",
- "names": [
- {
- "value": "string"
}
], - "identifiers": [
- {
- "value": "string",
- "type": {
- "technicalKey": "ABN_AU"
}
}
], - "legalForm": {
- "name": "string"
}, - "addresses": [
- {
- "country": {
- "shortName": "CH"
}, - "administrativeAreas": [
- {
- "value": "string"
}
], - "localities": [
- {
- "value": "string"
}
], - "postCodes": [
- {
- "value": "string"
}
], - "thoroughfares": [
- {
- "value": "string",
- "number": "string"
}
]
}
]
}, - "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
{- "pageSize": 0,
- "total": 0,
- "page": 0,
- "values": [
- {
- "businessPartner": {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": 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": 0,
- "longitude": 0
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}, - "matchingProfile": {
- "matchingScores": {
- "overall": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}, - "businessPartner": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}, - "address": {
- "classification": {
- "technicalKey": "string",
- "name": "string"
}, - "value": 0
}
}
}
}
], - "debugInfo": {
- "features": [
- {
- "feature": "string",
- "active": true
}
], - "request": {
- "matchingThreshold": 0,
- "pageSize": 10,
- "page": 0,
- "dataSources": [
- "string"
], - "businessPartner": {
- "externalId": "string",
- "record": "string",
- "names": [
- {
- "value": "string"
}
], - "identifiers": [
- {
- "value": "string",
- "type": {
- "technicalKey": "ABN_AU"
}
}
], - "legalForm": {
- "name": "string"
}, - "addresses": [
- {
- "country": {
- "shortName": "CH"
}, - "administrativeAreas": [
- {
- "value": null
}
], - "localities": [
- {
- "value": null
}
], - "postCodes": [
- {
- "value": null
}
], - "thoroughfares": [
- {
- "value": null,
- "number": null
}
]
}
]
}, - "featuresOn": [
- "FETCH_RECORD"
], - "featuresOff": [
- "FETCH_RECORD"
]
}
}
}
curl -i -X GET \ 'https://api.cdq.com/data-exchange/rest/jobs/toggleUpdateMonitoringJobs/{jobId}' \ -H 'X-API-KEY: YOUR_API_KEY_HERE'
{- "job": {
- "id": "string",
- "createdBy": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "progress": 0,
- "status": "RUNNING",
- "statusMessage": "string",
- "enable": true,
- "storageId": "string",
- "dataSourceId": "18d06d2d-bc67-4d2b-944e-a8fc52fa981a",
- "countryShortName": "CH"
}, - "status": "string"
}
Get random Business Partners from this storage
OK
Unauthorized
Forbidden
curl -i -X GET \ 'https://api.cdq.com/data-exchange/rest/v4/storages/{storageId}/businesspartners/random?countryCode=string&dataSource=string&featureOff=FETCH_RECORD&featureOn=FETCH_RECORD&limit=1&modifiedAfter=string&modifiedBefore=string' \ -H 'X-API-KEY: YOUR_API_KEY_HERE'
{- "limit": 0,
- "values": [
- {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": "string"
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "string",
- "shortName": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postCodes": [
- {
- "value": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "localities": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "value": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "name": "string",
- "direction": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "premises": [
- {
- "value": "string",
- "shortName": "string",
- "number": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "geographicCoordinates": {
- "latitude": 0,
- "longitude": 0
}, - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}
]
}
OK
curl -i -X GET \ 'https://api.cdq.com/data-exchange/rest/v4/storages/{storageId}/businesspartners/{id}?featureOff=APPLY_CURATION_DECISIONS&featureOn=APPLY_CURATION_DECISIONS' \ -H 'X-API-KEY: YOUR_API_KEY_HERE'
{- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "addresses": [
- {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "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
}
]
}
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "addresses": [
- {
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "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
}
]
}
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": "string"
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "string",
- "shortName": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postCodes": [
- {
- "value": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "localities": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "value": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "name": "string",
- "direction": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "premises": [
- {
- "value": "string",
- "shortName": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "geographicCoordinates": {
- "latitude": 0,
- "longitude": 0
}, - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}
OK
Bad Request
Unauthorized
curl -i -X GET \ 'https://api.cdq.com/data-exchange/rest/v4/storages/{storageId}/businesspartners?businessPartnerId=string&countryCode=string&curationLogResultStatus=LEVEL_1&dataSource=string&externalId=string&featuresOff=APPLY_CURATION_DECISIONS&featuresOn=APPLY_CURATION_DECISIONS&fromJobProcessedAt=string&fromTriggerProcessedAt=string&hasRawData=false&limit=500&logResultTriggerType=CREATED&modifiedAfter=string&modifiedBefore=string&query=string&reviewStatus=REVIEWED&sharingStatus=string&startAfter=string&toJobProcessedAt=string&toTriggerProcessedAt=string&updateMonitoring=true&validationLogResultStatus=ERROR&validationSharingLogResultStatus=ERROR' \ -H 'X-API-KEY: YOUR_API_KEY_HERE'
{- "startAfter": "string",
- "limit": 0,
- "total": 0,
- "values": [
- {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": "string",
- "technicalKey": "string"
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- {
- "type": null,
- "value": null,
- "shortName": null,
- "language": null
}
], - "addresses": [
- {
- "country": null,
- "postCodes": [ ],
- "localities": [ ],
- "thoroughfares": [ ]
}
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": "string"
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "string",
- "shortName": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postCodes": [
- {
- "value": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "localities": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "value": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "name": "string",
- "direction": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "premises": [
- {
- "value": "string",
- "shortName": "string",
- "number": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "string",
- "number": "string",
- "value": "string",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "geographicCoordinates": {
- "latitude": 0,
- "longitude": 0
}, - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "metadata": {
- "primaryProvenance": {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}
], - "nextStartAfter": "string"
}
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.
OK
curl -i -X GET \ 'https://api.cdq.com/data-exchange/rest/v4/storages/{storageId}/businesspartners/updates?affectedConcepts=MINORITY_INDICATOR&affectedProperties=MINORITY_INDICATOR_VALUE&businessPartnerIds=string&changeClassification=MINOR&changeType=ADDED&countryShortName=string&dataSource=string&exceptProvenanceTechnicalKeys=string&featuresOff=SHOW_BUSINESS_PARTNER&featuresOn=SHOW_BUSINESS_PARTNER&from=2019-12-31T16%3A47&limit=500&provenanceTechnicalKeys=string&startAfter=string' \ -H 'X-API-KEY: YOUR_API_KEY_HERE'
{- "limit": 0,
- "total": 0,
- "startAfter": "string",
- "nextStartAfter": "string",
- "values": [
- {
- "businessPartnerId": "string",
- "externalBusinessPartnerId": "string",
- "changeSets": [
- {
- "modifiedAt": "2007-08-31T16:47+00:00",
- "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,
- "maxConfidenceScore": 0
}
], - "provenances": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}
]
}
], - "businessPartner": {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": 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": 0,
- "longitude": 0
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}, - "storageBusinessPartner": {
- "id": "string",
- "createdAt": "string",
- "lastModifiedAt": "string",
- "externalId": "string",
- "dataSource": "string",
- "disclosed": true,
- "updateMonitoring": true,
- "metadata": {
- "status": {
- "recordStatus": "string",
- "explanations": [
- "string"
]
}, - "sharingStatus": {
- "status": "string",
- "description": "string"
}, - "identityLinks": [
- {
- "linkId": "string",
- "cdqId": "string",
- "addressId": "string",
- "externalAddressId": "string"
}
], - "logResultStatuses": [
- {
- "processingLogId": "CURATION_LOG",
- "triggerProcessedAt": "string",
- "triggerType": {
- "name": null,
- "technicalKey": null
}, - "jobProcessedAt": "string",
- "status": "string",
- "description": "string"
}
], - "decisionLogResult": {
- "reviewStatus": "REVIEWED",
- "naturalPersonsReviewStatus": "REVIEWED",
- "duplicatesReviewStatus": "REVIEWED"
}
}, - "record": "string",
- "additionalInformation": [
- {
- "key": "KEY",
- "value": 1
}
], - "names": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "shortName": "string",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}
], - "legalForm": {
- "name": "string",
- "technicalKey": "DE_9866",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}, - "mainAbbreviation": "string"
}, - "identifiers": [
- {
- "type": {
- "url": "string",
- "name": "string",
- "technicalKey": "string"
}, - "value": "string",
- "issuingBody": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "status": {
- "name": "string",
- "technicalKey": "string"
}
}
], - "categories": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "status": {
- "type": {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}, - "officialDenotation": "string",
- "validFrom": "string",
- "validUntil": "string"
}, - "profile": {
- "minorityIndicator": {
- "value": "string"
}, - "classifications": [
- {
- "value": "string",
- "code": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "phoneNumbers": [
- {
- "countryPrefix": "string",
- "number": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "value": "string"
}
], - "websites": [
- {
- "url": "string",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}
], - "contactEmails": [
- {
- "value": "string"
}
]
}, - "relations": [
- {
- "startedAt": "2019-08-31T16:47+00:00",
- "endedAt": "2019-08-31T16:47+00:00",
- "type": {
- "name": "Organizational Unit",
- "technicalKey": "BRANCH"
}, - "class": {
- "name": "CDQ Hierarchy",
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}, - "startNode": "FR.RC:5664645",
- "startNodeDataSource": "string",
- "startNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}, - "endNode": "FR.RC:5664645",
- "endNodeDataSource": "string",
- "endNodeBusinessPartner": {
- "names": [
- null
], - "addresses": [
- null
]
}
}
], - "types": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string"
}
], - "addresses": [
- {
- "id": "string",
- "externalId": "string",
- "cdqId": "string",
- "version": {
- "language": {
- "name": null,
- "technicalKey": null
}, - "characterSet": {
- "name": null,
- "technicalKey": null
}
}, - "identifyingName": {
- "value": "string"
}, - "careOf": {
- "value": "string"
}, - "contexts": [
- {
- "value": null
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": 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": 0,
- "longitude": 0
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "metadata": {
- "primaryProvenance": {
- "name": null,
- "url": null,
- "technicalKey": null,
- "cdqId": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "string",
- "internationalBankIdentifier": "string",
- "nationalBankAccountIdentifier": "string",
- "nationalBankIdentifier": "string",
- "countryCode": "string"
}
]
}, - "provenances": [
- {
- "name": "string",
- "url": "string",
- "technicalKey": "string",
- "cdqId": "string"
}
]
}
]
}
To toggle update monitoring on multiple BusinessPartners, the permission can be changed in two ways:
After the job is finished, the following actions are taken for business partners which match the dataSourceId and countryShortName criteria:
For toggling via a list of Business Partners, identified by their ID, please go to Toggle Update Monitoring of Business Partners.
OK
{- "enable": true,
- "storageId": "string",
- "dataSourceId": "18d06d2d-bc67-4d2b-944e-a8fc52fa981a",
- "countryShortName": "CH"
}
{- "id": "string",
- "createdBy": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "progress": 0,
- "status": "RUNNING",
- "statusMessage": "string",
- "enable": true,
- "storageId": "string",
- "dataSourceId": "18d06d2d-bc67-4d2b-944e-a8fc52fa981a",
- "countryShortName": "CH"
}
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:
For toggling a complete Data Source or for a certain Country of a Data Source, please go to Start Toggle Update Monitoring Job.
OK
{- "enable": true,
- "businessPartnerIds": [
- "string"
]
}
To un-/disclose multiple BusinessPartners, the disclosure can be changed in three ways:
Any other combination may result in a Bad Reqeust.
For more details, you can read about Sharing Scopes.
OK
{- "disclosed": true,
- "dataSourceId": "string",
- "countryCode": "string",
- "businessPartnerIds": [
- "string"
]
}
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, than 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:
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:
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.
BusinessPartnersUpsertRequest
OK
{- "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\"}"
}
]
}
{- "numberOfAccepted": 0,
- "numberOfFailed": 0,
- "failures": [
- {
- "id": 567326478287468740,
- "externalId": "LFA1.1234567",
- "message": "This record could not be stored due to timeout."
}
], - "featuresOn": [
- "string"
]
}