Subscriptions

Everything about Subscriptions

Read Links

Reads a page of links of the Business Partners starting from the 'startAfter' and with a size of 'limit'.

SecurityapiKey

Request

query Parameters

businessPartnerId

Array of strings (BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40

cdqIds

Array of strings

CDQ IDs which should be filtered.

Example: cdqIds=VIES:PL8660001429

dataSourceId

Array of strings (BusinessPartnerStorageDataSourceId)

Filter by specified Data Source ID.

Example: dataSourceId=648824a691d8d2503d65103e

externalId

Array of strings (BusinessPartnerExternalId)

Business Partner externalIDs.

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

featuresOff

Array of strings (BusinessPartnerIdentityLinksReadFeatureParam)

Features to be deactivated.

Items Enum:	Description
ACCEPT_REPLICATION_DELAYS	Accepts replication delays in persisting to the database. Allows faster data access. By default, deactivated.
NUMBER_OF_TOTAL	Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.

Example: featuresOff=ACCEPT_REPLICATION_DELAYS

featuresOn

Array of strings (BusinessPartnerIdentityLinksReadFeatureParam)

Features to be activated.

Items Enum:	Description
ACCEPT_REPLICATION_DELAYS	Accepts replication delays in persisting to the database. Allows faster data access. By default, deactivated.
NUMBER_OF_TOTAL	Allows to switch fetching the total number of Business Partners to improve performance. By default, turned on.

Example: featuresOn=ACCEPT_REPLICATION_DELAYS

limit

integer <int32> >= 1

Default: 500

Number of items to be returned on the page.

Example: limit=100

referenceDataSource

Array of strings

Reference data source as ALEI prefix of the linked Business Partner.

Example: referenceDataSource=CDQ.POOL

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

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: storageId=72d6900fce6b326088f5d9d91049e3e6

Responses

200

get/v4/businesspartners/identitylinks

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"id": "CDQ.POOL:5E580DD08E8B454820E8F67E0",
"createdAt": "2024-07-26T11:08:06Z",
"organization": "cdq_monitor",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"businessPartnerId": "63e635235c06b7396330fe40",
"referenceBusinessPartnerId": "VIES:ATU12345678",
"addressId": "0",
"addressVersion": {"languageTechnicalKey": "DE",
"characterSetTechnicalKey": "INTERNATIONAL"
},
"externalBusinessPartnerId": "The ID managed in the customer's SAP systems.",
"externalAddressId": "1",
"referenceAddressVersion": {"languageTechnicalKey": "DE",
"characterSetTechnicalKey": "INTERNATIONAL"
},
"cdqId": "VIES:PL8660001429",
"linkageParameter": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-07-26T11:08:06Z",
"lastModifiedAt": "2024-07-26T11:08:06Z",
"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-07-26T11:08:06Z",
"triggerType": {"name": null,
"technicalKey": null
},
"trigger": {"processedAt": null,
"provenance": null,
"type": null
},
"jobProcessedAt": "2024-07-26T11:08:06Z",
"processedAt": "2024-07-26T11:08:06Z",
"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": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-07-26T11:08:06Z",
"validUntil": "2024-07-26T11:08:06Z"
},
"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": [{"url": "https://cdq.com",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": null
}
}
],
"vatPayerStatus": {"publicationDate": "2024-07-26T11:08:06Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": [{"startedAt": "2024-07-26T11:08:06Z",
"endedAt": "2024-07-26T11:08:06Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": "FR.RC:5664645",
"startNodeDataSource": "648824a691d8d2503d65103e",
"startNodeBusinessPartner": {"names": [null
],
"addresses": [null
],
"metadata": {"identityLinks": [ ]
}
},
"endNode": "FR.RC:5664645",
"endNodeDataSource": "648824a691d8d2503d65103e",
"endNodeBusinessPartner": {"names": [null
],
"addresses": [null
],
"metadata": {"identityLinks": [ ]
}
},
"deactivatedAt": "2024-07-26T11:08:06Z"
}
],
"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": {"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
}
],
"metadata": {"primaryProvenance": {"name": null,
"url": null,
"technicalKey": null,
"cdqId": null
},
"language": {"name": null,
"technicalKey": null
}
}
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-07-26T11:08:06Z",
"lastPaymentDate": "2024-07-26T11:08:06Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
}
},
"linkageStatus": "SUCCESSFULLY_LINKED",
"referenceDataSource": "VIES",
"storageDataSource": {"id": "648824a691d8d2503d65103e"
}
}
]
}