AM - Add Organization to Exclusivity List

Details

/external/v1/exclusivity/add

Synopsis

Add Organization to Exclusivity Offering List

post

This route is used to add an organization to the exclusivity list. This will enable that organization to invest 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
Body
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
isRepLetterProvidedbooleanOptional

Set this value to true if the issuer of the security has a rep letter from the distribution partner being assigned to the exclusivity list. It is an optional field with default value set to false

Default: falseExample: true
feesTemplateDataall ofOptional

The exclusive offering's fees template details. If not provided, then new empty fees template will be created.

Example: {"data":{"managementFees":[{"feesInfo":[{"description":"IP: annually of capital commitments | 6 years from the date of initial investment","value":2,"unit":"percentage","frequency":"Annually"},{"description":"Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options","value":1.5,"unit":"percentage","frequency":"Annually"}]}],"investorServicingFees":[{"maxAmount":9999.99,"feesInfo":[{"description":"IP: annually of capital commitments | 6 years from the date of initial investment","value":3,"unit":"percentage","frequency":"Annually"},{"description":"Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options","value":2.5,"unit":"percentage","frequency":"Annually"}]},{"minAmount":10000,"maxAmount":49999.99,"feesInfo":[{"description":"IP: annually of capital commitments | 6 years from the date of initial investment","value":2,"unit":"percentage","frequency":"Annually"},{"description":"Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options","value":1.5,"unit":"percentage","frequency":"Annually"}]}],"otherFees":[{"groupName":"Global fees","groupDetails":[{"feesInfo":[{"description":"Some global fee","value":75,"unit":"basisPoints","frequency":"One-Off"}]}]},{"groupName":"Bank fees","groupDetails":[{"maxAmount":4999.99,"feesInfo":[{"description":"Bank fees - tier 1 - $5,000,000 - $9,999,999","value":50,"unit":"basisPoints","frequency":"One-Off"}]},{"minAmount":5000,"maxAmount":999999.99,"feesInfo":[{"description":"Bank fees - tier 2 - $10,000,000+","value":25,"unit":"basisPoints","frequency":"One-Off"}]}]}]}}
Responses
201
Successfully triggered the process to add the new organization to 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
post
POST /external/v1/exclusivity/add HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3763

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "orgId": "US9QIMA",
  "isRepLetterProvided": true,
  "feesTemplateData": {
    "data": {
      "managementFees": [
        {
          "feesInfo": [
            {
              "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
              "value": 2,
              "unit": "percentage",
              "frequency": "Annually"
            },
            {
              "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
              "value": 1.5,
              "unit": "percentage",
              "frequency": "Annually"
            }
          ]
        }
      ],
      "investorServicingFees": [
        {
          "maxAmount": 9999.99,
          "feesInfo": [
            {
              "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
              "value": 3,
              "unit": "percentage",
              "frequency": "Annually"
            },
            {
              "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
              "value": 2.5,
              "unit": "percentage",
              "frequency": "Annually"
            }
          ]
        },
        {
          "minAmount": 10000,
          "maxAmount": 49999.99,
          "feesInfo": [
            {
              "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
              "value": 2,
              "unit": "percentage",
              "frequency": "Annually"
            },
            {
              "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
              "value": 1.5,
              "unit": "percentage",
              "frequency": "Annually"
            }
          ]
        }
      ],
      "otherFees": [
        {
          "groupName": "Global fees",
          "groupDetails": [
            {
              "feesInfo": [
                {
                  "description": "Some global fee",
                  "value": 75,
                  "unit": "basisPoints",
                  "frequency": "One-Off"
                }
              ]
            }
          ]
        },
        {
          "groupName": "Bank fees",
          "groupDetails": [
            {
              "maxAmount": 4999.99,
              "feesInfo": [
                {
                  "description": "Bank fees - tier 1 - $5,000,000 - $9,999,999",
                  "value": 50,
                  "unit": "basisPoints",
                  "frequency": "One-Off"
                }
              ]
            },
            {
              "minAmount": 5000,
              "maxAmount": 999999.99,
              "feesInfo": [
                {
                  "description": "Bank fees - tier 2 - $10,000,000+",
                  "value": 25,
                  "unit": "basisPoints",
                  "frequency": "One-Off"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "shareClassSecurityInfo": [
    {
      "shareClassId": "USS3JKS01I00",
      "feesTemplateData": {
        "data": {
          "maxFrontendFee": 1,
          "backendFee": 0,
          "managementFees": [
            {
              "feesInfo": [
                {
                  "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
                  "value": 2,
                  "unit": "percentage",
                  "frequency": "Annually"
                },
                {
                  "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
                  "value": 1.5,
                  "unit": "percentage",
                  "frequency": "Annually"
                }
              ]
            }
          ],
          "investorServicingFees": [
            {
              "maxAmount": 9999.99,
              "feesInfo": [
                {
                  "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
                  "value": 3,
                  "unit": "percentage",
                  "frequency": "Annually"
                },
                {
                  "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
                  "value": 2.5,
                  "unit": "percentage",
                  "frequency": "Annually"
                }
              ]
            },
            {
              "minAmount": 10000,
              "maxAmount": 49999.99,
              "feesInfo": [
                {
                  "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
                  "value": 2,
                  "unit": "percentage",
                  "frequency": "Annually"
                },
                {
                  "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
                  "value": 1.5,
                  "unit": "percentage",
                  "frequency": "Annually"
                }
              ]
            }
          ],
          "otherFees": [
            {
              "groupName": "Global fees",
              "groupDetails": [
                {
                  "feesInfo": [
                    {
                      "description": "Some global fee",
                      "value": 75,
                      "unit": "basisPoints",
                      "frequency": "One-Off"
                    }
                  ]
                }
              ]
            },
            {
              "groupName": "Bank fees",
              "groupDetails": [
                {
                  "maxAmount": 4999.99,
                  "feesInfo": [
                    {
                      "description": "Bank fees - tier 1 - $5,000,000 - $9,999,999",
                      "value": 50,
                      "unit": "basisPoints",
                      "frequency": "One-Off"
                    }
                  ]
                },
                {
                  "minAmount": 5000,
                  "maxAmount": 999999.99,
                  "feesInfo": [
                    {
                      "description": "Bank fees - tier 2 - $10,000,000+",
                      "value": 25,
                      "unit": "basisPoints",
                      "frequency": "One-Off"
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    }
  ]
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}

Important Notes

  • This 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.

Last updated

Was this helpful?