AM - Reject Assignment to Exclusive Offering

Details

/external/v1/exclusivity/reject

Synopsis

Reject Assignment to Exclusive Offering

put

This route is used for an investing organization to reject the assignment to an exclusive offering (i.e. when the exclusivity type of the offering is set to "private"). This can be invoked if the current organization has been assigned as an investing org to this particular security. Use this endpoint to express that you will not be performing investments in this security. This can be reverted by using the "accept" endpoint. 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 called by applications with access to scope "manageExclusivityOptions".

Required scopes

This endpoint requires the following scopes:

• : manageExclusivityOptions

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

shareClassSecurityIdsstring[]Optional

For registered products with multiple share classes, use this as a filter to specify to which share classes the action applies to. If not provided, then all will be affected the same way. This should only be provided if the security has multiple share classes (e.g. security with multiple share classes and accepting/rejecting the assignment to just a subset of them).

Example: ["USS3JKS01I00"]

Responses

200

Successfully triggered the process to reject the assignment to the exclusive list of this security. 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 - IS0004 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 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 - IS0010 - IS0019 - IS0003 - IS0102 - IS0103 - IS0117 - EX0001 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/exclusivity/reject

HTTPcURLJavaScriptPython

PUT /external/v1/exclusivity/reject HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "shareClassSecurityIds": [
    "USS3JKS01I00"
  ],
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
}

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

Important Notes

• Revert using the /accept endpoint.

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