AM/FA/Inv - Add Capital Event Correlation ID

Use a correlation ID to associate external identifiers with platform IDs.

Details

/external/v1.capital-events/{capitalEventId}/correlation-id/add

Synopsis

Add Capital Event Correlation ID

put

This route is used to add a correlation ID to an existing capital event. This correlation ID is an externally provided id that uniquely identifies the capital event within the organization making this call. This correlation ID can't be in use by another capital event. This correlation ID can be broadcast to all the counterparties that have access to this capital event. 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".

Required scopes

This endpoint requires the following scopes:

• : manageReferenceData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

capitalEventIdanyRequired

The unique identifier of the capital event on the blockchain

Example: US9QIMAOAS1Q

Body

application/json

correlationIdstring · max: 100Required

Externally provided id that uniquely identifies an entity within an organization.

Example: 123245573717

broadcastToCounterpartybooleanOptional

This property defines if correlation information will be sent to all counterparties. If not provided then the system will set it to true and broadcast this correlation id to the counterparties that have access to the entity to which this id is connected to (account, investor, asset, etc...). If you want to keep this id available only for your organization, explicitly set this to false.

Default: trueExample: true

originstring · max: 100Optional

The organization origin system that created this entity correlation id

Example: Backoffice-system-123

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

Responses

200

Successfully added (or, if the action is being broadcast, triggered the addition of) the correlation id to the capital event.

application/json

400

The following error codes can be returned: - GN0002 - TX0006 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - IS0009 - CE0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - CE0032 - CE0040 - IS0015 - IS0119 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/capital-events/{capitalEventId}/correlation-id/add

HTTPcURLJavaScriptPython

PUT /external/v1/capital-events/{capitalEventId}/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"
  }
}