AM/TA/Inv - Update Assets External State

Details

/external/v1/asset/external-state

Synopsis

Update Assets External State

put

This route is used to update the external state of a batch of assets. All the assets provided in the payload should not be restricted and should belong to the same security. The security should also not be restricted. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["investor","issuer","service_provider"]. 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 called by applications with access to scope "manageAssetExternalState".

Required scopes

This endpoint requires the following scopes:

• : manageAssetExternalState

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

Responses

200

Successfully triggered the process to update the external state for a batch of assets.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 - AS0036 - AS0035 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 - AS0001 - AS0006 - AS0007 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 - AS0004 - AS0037 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/asset/external-state

HTTPcURLJavaScriptPython

PUT /external/v1/asset/external-state HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 431

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

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