AM/TA - Mark Assets Batch as Accepted

Details

/external/v1/primary/batch-mark-accepted

Synopsis

Mark Assets batch as Accepted

put

This route is used to trigger the process to mark a list of assets of a given security as accepted. This means the issuer has accepted the investments and the assets will move on to the next stage of the lifecycle. This triggers an asynchronous process (the id of which is returned on the success response) to persist this information on the blockchain which can be monitored using the "Transactions API" endpoints. This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"]. This endpoint can be invoked if the assets are in one of the following statuses: ["created","remediation_pending","remediated","modified"]. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "acceptSubscription".

Required scopes

This endpoint requires the following scopes:

• : acceptSubscription

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

Responses

200

Successfully triggered the process to mark a list of assets as accepted.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

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

400

The following error codes can be returned: - GN0002 - IS0008 - IS0106 - AS0018 - AS0013 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 - IS0099 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 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 - IS0117 - AS0004 - AS0024 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/primary/batch-mark-accepted

HTTPcURLJavaScriptPython

PUT /external/v1/primary/batch-mark-accepted HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 553

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "assetsActionData": [
    {
      "assetIdentifier": {
        "assetId": "USS3JKS01I00"
      },
      "correlationData": [
        {
          "broadcastToCounterparty": true,
          "correlationId": "123245573717",
          "origin": "Identifies asset on backoffice",
          "extraData": {
            "some": "Custom Property"
          }
        }
      ]
    },
    {
      "assetIdentifier": {
        "assetId": "USS3JKS01I10"
      }
    },
    {
      "assetIdentifier": {
        "correlationIdentifier": {
          "correlationId": "123456789987654"
        }
      },
      "externalEntityState": {
        "status": "PENDING",
        "extraData": {
          "some": "custom property"
        }
      }
    }
  ]
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}