AM/TA - Dispose Digitized Asset (Lot)

Throughout the API flows, an asset represents multiple shares, or a lot, of a given security.

Details

/external/v1/offline-transactions/asset/{assetId}/dispose

Synopsis

Dispose Digitized Asset

put

This route is used to trigger the disposal of an unallocated digitized asset for a particular security. Once processed, the asset will be disposed. It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "disposeOfflineAsset".

Required scopes

This endpoint requires the following scopes:

• : disposeOfflineAsset

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

assetIdanyRequired

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.

Example: US9QIMAOAS1Q

Query parameters

isAssetCorrelationIdanyOptional

This 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.

Example: true

assetCorrelationOrgIdanyOptional

This 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".

Example: US9QI

Body

application/json

processIdstringOptional

This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this. If provided, it must have a v4 UUID format.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

securityIdstringOptional

This is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional. Either "securityId" or "securityCorrelationData" must be provided, but not both.

Example: USS3JKS01I00

Responses

200

Successfully triggered the process to dispose the digitized asset.

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

assetIdstringRequired

The ID of the digital asset that uniquely identifies it on the ledger

Example: US9QIMAOAS1Q

fileIdsstring[]Optional

The created document(s) file ID(s). Each ID uniquely identifies a file on the ledger.

Example: ["US9QIFILE1","US9QIFILE2"]

dryRunbooleanOptional

This property reflects if the request was executed in dry run mode.

Example: true

positionIdstringOptional

The unique identifier of the position where the asset is being held. A position is defined by its id or alternative by the unique pair account id + security id.

Example: US9QIMAOAS1Q

400

The following error codes can be returned: - GN0002 - AS0003 - IS0008 - IS0106 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 - AU0003 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 - AS0002 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 - AS0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0119 - IS0013 - IS0012 - IS0002 - AS0005 - AS0004 - AS0012 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/offline-transactions/asset/{assetId}/dispose

HTTPcURLJavaScriptPython

PUT /external/v1/offline-transactions/asset/{assetId}/dispose HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "signer": {
    "email": "[email protected]",
    "name": "John Doe"
  },
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "securityId": "USS3JKS01I00",
  "securityCorrelationData": {
    "correlationId": "USS3JKS01I00",
    "orgId": "US9QIMA"
  }
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "assetId": "US9QIMAOAS1Q",
  "fileIds": [
    "US9QIFILE1",
    "US9QIFILE2"
  ],
  "referenceData": {
    "account": {
      "accountId": "US9QIMAOAS1Q",
      "custodian": {
        "custodianId": "US9ZIMAOAS1Q"
      }
    },
    "investors": [
      {
        "investorId": "US9QIM123S1Q"
      }
    ]
  },
  "completedByAdvisor": {
    "advisorId": "OG12JUS03I04"
  },
  "dryRun": true,
  "positionId": "US9QIMAOAS1Q"
}