Use a correlation ID to associate external identifiers with platform IDs. An asset represents multiple shares, or a lot, of a given security.
/external/v1/asset/{assetId}/correlation-id/add
This route is used to add a correlation ID to an existing asset. This correlation ID is an externally provided id that uniquely identifies the asset within the organization making this call.
This correlation ID can't be in use by another asset. This correlation ID can be broadcast to all the counterparties that have access to this asset.
If the ID is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
The unique identifier of the asset on the blockchain.
This can be a 12 characters platform generated identifier or a correlation id provided by the client. If its length is different from 12 it will be treatead as a correlation id.
Particularly relevant for correlation ids, it is recommended that the ID is url encoded if it contains any special characters.
US9QIMAOAS1QThis property is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.
If set to "true" then the platform will try to obtain the asset data using the path parameter as a correlation id instead of a platform generated id.
trueThis is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.
This is the organization identifier linked to that path param. If not provided the organization id will be inferred from the access token.
This will be ignored if the value in the path parameter is 12 characters long and the isAssetCorrelationId is either absent or not "true".
US9QIExternally provided id that uniquely identifies an entity within an organization.
123245573717This property defines if correlation information will be sent to all counterparties.
falseExample: trueThe organization origin system that created this entity correlation id
Backoffice-system-123This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/asset/{assetId}/correlation-id/add HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"broadcastToCounterparty": true,
"origin": "Backoffice-system-123",
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}