company

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

Authorizations
Body
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"]
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"}}
bookingModelall ofOptional

This property contains the booking model for each account.

If not provided, the booking model for all accounts will be defaulted to 'directlyHeld' which means that the securities will be held directly by the investors.

If this is provided, it is possible to define which accounts are qualified for 'fullyDisclosedFBO' structure, where the assets are held for the benefit of the investor, or 'omnibus' structure.

If not provided on accepting after a reject it will clear previous set model.

Example: {"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)"}]}}}
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
put
PUT /external/v1/exclusivity/accept HTTP/1.1
Host: 
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.

PreviousAM - Add Organization to Exclusivity ListNextAM - Reject Assignment to Exclusive Offering

Last updated

Was this helpful?