Inv - Remediate Digital Asset (Lot)

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

Details

/external/v1/primary/asset/{assetId}/remediate

Synopsis

Request Digital Asset Remediation

put

This route is used to trigger the request of a digital asset remediation on the blockchain for a particular security. This means the issuer has not accepted the investment yet, so they are requesting the investment remediation. This is typically called when the subscription is not in good order (NIGO) and this action triggers the asset to go back to the investor organization to be updated using the remediate endpoint. 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 asset is 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 "requestSubscriptionRemediation".

Required scopes

This endpoint requires the following scopes:

• : requestSubscriptionRemediation

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

Responses

200

Successfully triggered the process to request the asset remediation on the ledger. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process. The "assetId" property can be used on the "Assets API" to get the details of the digital asset.

application/json

400

The following error codes can be returned: - GN0002 - IS0106 - AS0003 - AS0032 - CM0011 - CM0014 - FL0002 - FL0003 - FL0019 - FL0004 - FL0005 - FL0020 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 - 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 - CM0005 - FL0008 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 - IS0016 - IS0012 - IS0013 - IS0117 - AS0005 - AS0004 - CM0012 - CM0013 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/primary/asset/{assetId}/request-remediation

HTTPcURLJavaScriptPython

PUT /external/v1/primary/asset/{assetId}/request-remediation HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 946

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "reviewData": {
    "comments": [
      {
        "data": {
          "message": "Invalid SSN was provided",
          "category": "EC002"
        }
      },
      {
        "data": {
          "message": "Invalid signature was provided",
          "userInfo": {
            "name": "John Doe",
            "email": "[email protected]",
            "team": "Compliance"
          },
          "category": "EC003",
          "flaggedDocument": {
            "document": {
              "fileId": "FILE3JUS03I4"
            },
            "details": {
              "issueType": "mismatch",
              "pageNumber": 1,
              "additionalNotes": "The signature on the top of the page is different than expected according to the provided ID document",
              "issueTypeDetails": "mismatch"
            }
          },
          "extraData": {
            "custom": "This is a custom field"
          }
        }
      },
      {
        "commentId": "USS3JKS01I00SW24"
      }
    ]
  },
  "externalEntityState": {
    "status": "PENDING",
    "extraData": {
      "some": "custom property"
    }
  },
  "correlationData": [
    {
      "broadcastToCounterparty": true,
      "correlationId": "123245573717",
      "origin": "Identifies asset on backoffice",
      "extraData": {
        "some": "Custom Property"
      }
    }
  ]
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "assetId": "US9QIMAOAS1Q",
  "reviewData": [
    {
      "commentId": "US9QICOMM1",
      "fileIds": [
        "US9QIFILE1",
        "US9QIFILE2"
      ]
    }
  ]
}

Important Notes

• Issuer requested remediation first.

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.

• The dryRun option is included in the response, but is not yet used for this method.

\