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

Business Partner IDs in a storage which should be filtered.

cdqIds

Array of strings

CDQ IDs which should be filtered

dataSourceId

Array of strings

IDs of data sources which should be filtered

externalId

Array of strings

Business Partner externalIDs which should be filtered.

featuresOff

Array of strings (BusinessPartnerIdentityLinksReadFeatureParam)

Features to be turned off.

Items Enum:	Description
ACCEPT_REPLICATION_DELAYS	Accepts replication delays in persisting to the database. Allows faster data access. By default, turned off.
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 turned on.

Items Enum:	Description
ACCEPT_REPLICATION_DELAYS	Accepts replication delays in persisting to the database. Allows faster data access. By default, turned off.
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 (e.g. CDQ.POOL) as ALEI prefix of the linked Business Partner used to filter the result of links returned OR in case of link between Business Partners in own data sources, string consisting of storageId:dataSourceId

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=10

storageId

required

string

ID of a storage which should be filtered.

Responses

200

get/v4/businesspartners/identitylinks

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "string",
"nextStartAfter": "string",
"limit": 0,
"total": 0,
"values": [{"id": "string",
"createdAt": "string",
"organization": "cdq_monitor",
"storageId": "string",
"businessPartnerId": "string",
"referenceBusinessPartnerId": "string",
"addressId": "string",
"addressVersion": {"languageTechnicalKey": "DE",
"characterSetTechnicalKey": "INTERNATIONAL"
},
"externalBusinessPartnerId": "The ID managed in the customer's SAP systems.",
"externalAddressId": "1",
"referenceAddressVersion": {"languageTechnicalKey": "DE",
"characterSetTechnicalKey": "INTERNATIONAL"
},
"cdqId": "string",
"linkageParameter": {"id": "63e635235c06b7396330fe40",
"createdAt": "string",
"lastModifiedAt": "string",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": false,
"updateMonitoring": true,
"updateCommercialMonitoring": [{"type": {"technicalKey": "string"
},
"value": false
}
],
"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
},
"trigger": {"processedAt": null,
"provenance": null,
"type": null
},
"jobProcessedAt": "string",
"processedAt": "string",
"status": "string",
"description": "string"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "string",
"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"
},
"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": "2022-02-26",
"validUntil": "2022-02-26"
},
"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": "2020-07-21T17:32:28Z",
"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": "string",
"externalId": "1",
"cdqId": "string",
"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,
"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": "2020-08-31T16:47+00:00",
"lastPaymentDate": "2020-08-31T16:47+00:00",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": null
}
}
]
}
},
"linkageStatus": "string",
"referenceDataSource": "string",
"storageDataSource": {"id": "648824a691d8d2503d65103e"
}
}
]
}