All pages
Powered by GitBook
1 of 1

Loading...

AM/FA/Inv - Remove Account Correlation ID

Details

/external/v1/investor/{investorId}/correlation-id/remove

Synopsis

Remove Investor Correlation ID

put

This route is used to remove a correlation ID from an existing investor. This correlation ID is an externally provided id that uniquely identifies the investor within the organization making this call.

This correlation ID should be in use by the investor involved in this call.

This action can be broadcast to all the counterparties that have access to this investor and that have a relationship with the organization making this call.

If the action 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".

Authorizations
Path parameters
investorIdstringRequired

The unique identifier of the investor on the blockchain

Example: USS3JKS01I00
Body
correlationIdstring · max: 100Required

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

Example: 123245573717
transactionDataall ofRequired

This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed

Example: {"signer":{"email":"[email protected]","name":"John Doe"}}
Responses
200
Successfully removed (or, if the action is being broadcast, triggered the removal of) the correlation id from the investor.
application/json
400
The following error codes can be returned: - GN0002 - IV0031 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: - false Please refer to the error code dictionary for the details of each error code.
application/json
409
The following error codes can be returned: - IV0027 - IV0028 - IV0029 Please refer to the error code dictionary for the details of each error code.
application/json
put
PUT /external/v1/investor/{investorId}/correlation-id/remove HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  },
  "correlationId": "123245573717",
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
}
{
  "processData": {
    "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
  }
}