AM - Launch New Offering

Details

/external/v1/security-admin/create-and-launch

Synopsis

Launch new Offering

post

This route is used to create and launch new offering. Once this action is complete it will be possible to submit new subscriptions or proceed to the next stages of the security lifecycle. 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 "launchOffering".

Required scopes

This endpoint requires the following scopes:

• : launchOffering

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

processIdstringOptional

This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this. If provided, it must have a v4 UUID format.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

dryRunbooleanOptional

Set this to true if you want the request to go through the typical request validation stages up until persisting objects to database. If this is set to true then no data will actually be persisted neither on the database nor the blockchain, but all the request validations will be executed.

Default: falseExample: true

Responses

201

Successfully triggered the process to launch new offering

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

securityIdstringRequired

The security id of the issuance

Example: USCCWSF01I00

legalEntityIdstringRequired

This is the id that uniquely identifies a legal entity of the issuance.

Example: USCCWSF01

accountIdstringRequired

This is the id that uniquely identifies the internal account used for this security.

Example: USCCWST33

shareClassSecurityIdsstring[]Optional

The security id of each share class created

Example: ["USCCWSF01I00"]

dryRunbooleanOptional

This property reflects if the request was executed in dry run mode.

Example: true

400

The following error codes can be returned: - GN0002 - IS0036 - IS0037 - IS0038 - IS0039 - IS0040 - IS0041 - IS0042 - IS0043 - IS0044 - IS0045 - IS0097 - IS0046 - IS0049 - IS0050 - IS0051 - IS0052 - IS0055 - IS0056 - IS0058 - IS0061 - IS0060 - IS0109 - IS0110 - IS0111 - IS0112 - IS0113 - LE0001 - LE0003 - LE0004 - LE0005 - CI0001 - CI0002 - CI0003 - CI0004 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

409

The following error codes can be returned: - IS0053 - IS0054 - IS0057 - LE0002 Please refer to the error code dictionary for the details of each error code.

application/json

425

The following error codes can be returned: - GN0003 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/security-admin/create-and-launch

HTTPcURLJavaScriptPython

POST /external/v1/security-admin/create-and-launch HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4727

{
  "signer": {
    "email": "[email protected]",
    "name": "John Doe"
  },
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "issuanceInfo": {
    "name": "Series A",
    "shortName": "A",
    "correlationData": [
      {
        "broadcastToCounterparty": true,
        "correlationId": "123245573717",
        "origin": "Identifies security on backoffice",
        "extraData": {
          "some": "Custom Property"
        }
      }
    ],
    "externalIdentifiers": {
      "ticker": "AAPL",
      "cusip": "037833100",
      "isin": "US-000402625-0"
    },
    "legalEntityInfo": {
      "data": {
        "name": "Test Issuing Legal Entity",
        "type": "LP",
        "taxId": "123456789",
        "description": "This is a test legal entity",
        "incorporationCountry": "US",
        "incorporationState": "NY",
        "domicileCountry": "US",
        "jurisdictionCountry": "US",
        "isUsEntity": true,
        "incorporationDate": "1987-17-12",
        "address": {
          "addressLineOne": "8 Greenway Plaza",
          "addressLineTwo": "Suite 1515",
          "country": "US",
          "state": "Texas",
          "city": "Houston",
          "zipCode": "TX 77046"
        },
        "mailingAddress": {
          "addressLineOne": "9 Blackway Plaza",
          "addressLineTwo": "Suite 9876",
          "country": "US",
          "state": "New York",
          "city": "New York",
          "zipCode": "NY 77046"
        },
        "extraData": {
          "some": "Custom Property"
        },
        "fundInfo": {
          "name": "Test fund",
          "type": "Hedge Fund",
          "strategy": "Hedge Funds",
          "exemption": "3(C)(1)",
          "is1031Eligible": false,
          "taxReporting": "1099",
          "commoditiesInfo": {
            "CFTCRegisteredCommodityPoolOperator": false,
            "CFTCRegisteredCommodityTradingAdvisor": false,
            "CFTCRegisteredFuturesCommissionMerchant": false,
            "CFTCRegisteredIntroducingBroker": false,
            "CFTCRegisteredLeverageTransactionMerchant": false,
            "CFTCRegisteredNFAMember": false,
            "CFTCRule4_5Exemption": true,
            "CFTCRule4_13_a_3Exemption": true
          },
          "description": "This is a test fund"
        },
        "contactInfo": [
          {
            "email": "[email protected]",
            "phoneNumber": "832-426-4242",
            "name": "General Contact",
            "type": "primary",
            "description": "Use this from Monday to Friday, 9-5 ET"
          }
        ]
      }
    },
    "settings": {
      "bankAccount": {
        "bankABA": "0260-0959-3",
        "bankSwift": "AAAA-BB-CC-123",
        "accountName": "Test account",
        "accountNumber": "123456789",
        "bankName": "Test Bank",
        "reference": "This may contain further payment instructions"
      }
    },
    "termSheetInfo": {
      "securityType": "lpInterest",
      "campaignType": "NonContingent",
      "mannerOfSaleInfo": {
        "minAmount": 0,
        "maxAmount": 500000000,
        "startDate": "2023-01-01T00:00:00.000Z",
        "endDate": "2025-01-01T00:00:00.000Z"
      },
      "regulation": "RegD:506(B)",
      "navOptions": {
        "navFrequency": "Quarterly"
      },
      "priceOptions": {
        "currency": "USD",
        "minimumInvestment": 250000,
        "allowsReinvestment": false
      },
      "capitalCallOptions": {
        "enabled": false
      },
      "feesInfo": {
        "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": 4999999.99,
                "feesInfo": [
                  {
                    "value": 75,
                    "unit": "basisPoints",
                    "frequency": "One-Off"
                  }
                ]
              },
              {
                "minAmount": 5000000,
                "maxAmount": 9999999.99,
                "feesInfo": [
                  {
                    "value": 50,
                    "unit": "basisPoints",
                    "frequency": "One-Off"
                  }
                ]
              },
              {
                "minAmount": 10000000,
                "feesInfo": [
                  {
                    "value": 25,
                    "unit": "basisPoints",
                    "frequency": "One-Off"
                  }
                ]
              }
            ],
            "otherFees": [
              {
                "groupName": "Bank fees",
                "groupDetails": [
                  {
                    "maxAmount": 4999.99,
                    "feesInfo": [
                      {
                        "description": "Bank fees - tier 1 - up to $4999.99",
                        "value": 1,
                        "unit": "percentage",
                        "frequency": "Annually"
                      }
                    ]
                  },
                  {
                    "minAmount": 5000,
                    "maxAmount": 999999.99,
                    "feesInfo": [
                      {
                        "description": "Bank fees - tier 2 - $5000 - $999999.99",
                        "value": 0.5,
                        "unit": "percentage",
                        "frequency": "Annually"
                      }
                    ]
                  }
                ]
              },
              {
                "groupName": "Placement Fees",
                "groupDetails": [
                  {
                    "minAmount": 250000,
                    "maxAmount": 999999.99,
                    "feesInfo": [
                      {
                        "description": "Client Pays",
                        "value": 1.25,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      },
                      {
                        "description": "GP Pays",
                        "value": 0.75,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      },
                      {
                        "description": "Total FA Comp",
                        "value": 2,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      }
                    ]
                  },
                  {
                    "minAmount": 1000000,
                    "feesInfo": [
                      {
                        "description": "Client Pays",
                        "value": 0.25,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      },
                      {
                        "description": "GP Pays",
                        "value": 0.75,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      },
                      {
                        "description": "Total FA Comp",
                        "value": 1,
                        "unit": "percentage",
                        "frequency": "One-Off"
                      }
                    ]
                  }
                ]
              },
              {
                "groupName": "Global fees",
                "groupDetails": [
                  {
                    "feesInfo": [
                      {
                        "description": "Some global fee",
                        "value": 75,
                        "unit": "basisPoints",
                        "frequency": "One-Off"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        },
        "commonFees": {
          "performanceFees": {
            "hurdleRate": 1,
            "highWatermark": {
              "enabled": true,
              "frequency": "Quarterly"
            },
            "grossOrNet": "Net",
            "fees": [
              {
                "description": "The performance fee details during the IP period",
                "value": 1,
                "unit": "percentage",
                "frequency": "Annually"
              },
              {
                "description": "Some other description about the fee structure in the Post-IP period",
                "value": 0.5,
                "unit": "basisPoints",
                "frequency": "Semi-Annually"
              }
            ]
          }
        }
      },
      "allowBelowMinimum": false
    }
  },
  "dryRun": true
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "securityId": "USCCWSF01I00",
  "legalEntityId": "USCCWSF01",
  "accountId": "USCCWST33",
  "shareClassSecurityIds": [
    "USCCWSF01I00"
  ],
  "dryRun": true
}

Important Notes

• The response may include the security ID of each share class created. See Parent and Child Securities (Share Classes) for more information.

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

• Use the dryRun option to check the submission for completeness and correctness without persisting the information.