Inv - Accept Assignment to Exclusive Offering

Details

/external/v1/exclusivity/accept

Synopsis

Accept Assignment to Exclusive Offering

put

This route is used for an investing organization to accept 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. After acceptance it will be possible to perform investments in this 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 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 accept 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

omnibusAccountIdstringRequired

The unique identifier of the omnibus account on the blockchain, in case of 'omnibus' booking model.

Example: USS3JKS01I00

400

The following error codes can be returned: - GN0002 - IS0004 - AC0013 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 - OG0028 - OG0038 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 - EX0009 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/exclusivity/accept

HTTPcURLJavaScriptPython

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

{
  "shareClassSecurityIds": [
    "USS3JKS01I00"
  ],
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "bookingModel": {
    "fbo": {
      "qualifiedTypes": [
        "Retirement"
      ]
    },
    "omnibus": {
      "qualifiedTypes": [
        "Individual",
        "Joint"
      ],
      "account": {
        "name": "Omnibus Account",
        "bankAccount": {
          "accountNumber": "111111111",
          "accountName": "savings account",
          "bankABA": "555555555",
          "bankName": "Test Bank",
          "bankSwift": "AAAA-BB-CC-123",
          "extraData": {
            "settlementInstructions": "Please wire the amount within 72 hours",
            "some": "Other Property"
          }
        },
        "contactInfo": [
          {
            "email": "[email protected]",
            "phoneNumber": "832-426-4242",
            "type": "primary"
          },
          {
            "email": "[email protected]",
            "phoneNumber": "987-564-1234",
            "type": "tax",
            "name": "John Doe",
            "description": "Use this contact for Tax Related Information (K-1, 1099 or other tax related information)"
          }
        ]
      }
    }
  }
}

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

Important Notes

• The current organization must be assigned as an investing org for this security.

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