AM - Remove Organization from Exclusive Offering List

Details

/external/v1/exclusivity/remove

Synopsis

Removes Organization from Exclusivity Offering list

put

This route is used to remove an organization from the exclusivity list. This will prevent that organization from executing further investments in this security.

This should only be triggered by the organization that owns the security.

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

Authorizations

oauth2

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security being affected by this action

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

orgIdstring · max: 50Required

The id of the organization. Used to uniquely identify the organization on the ledger

Example: US9QIMA

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 adding/removing an organizations to just a subset of them).

Example: ["USS3JKS01I00"]

Responses

200

Successfully triggered the process to remove an existing organization from the exclusive list of investing organizations.

The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

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

• OG0025

• 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

• OG0001

Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned:

• IS0013

• IS0010

• IS0019

• IS0003

• IS0062

• IS0117

• EX0005

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/exclusivity/remove HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

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

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

Important Notes

• Should only be triggered either by the organization that owns the security or by a channel admin.

• securityId: uniquely identifies the fund/offering. See Managing the SecurityId.

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