Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Security Administration (or Offering Administration) refers to the tasks related to launching, onboarding, and maintaining an offering on the platform.
Mapping Your IDs to Corastone IDs
/external/v1/security-admin/approve-revert-completed-to-active
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
/external/v1/security-admin/allow-below-minimum
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
/external/v1/security-admin/revert-completed-to-active
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
/external/v1/security-admin/pause
securityId: uniquely identifies the fund/offering. See Managing the SecurityId.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
/external/v1/security-admin/extend-end-date
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
This route is used to approve a completed offering to revert back to active.
This will allow for the "revert-completed-to-active" endpoint to be called.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["completed"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "approveRevertCompletedToActive".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/approve-revert-completed-to-active HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the update of security's property "allowBelowMinimum".
This is a non-reversible action that will allow the minimum investment validation to be bypassed and effectively start receiving subscriptions that are below the minimum investment threshold.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "updateAllowBelowMinimum".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/allow-below-minimum HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used for a service provider (e.g. Fund Admin) or Issuer to resume activity on an existing "paused" 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 invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["paused"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "pauseOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/unpause HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the restriction of an offering.
This will block all activity on this security.
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can't be invoked if the security is restricted.
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 "restrictOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/restrict HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to revert a completed security back to active.
This can be used by either the issuer that owns the security or by a service provider that is assigned to the security after aproval of this action on the "approve-revert-completed-to-active" endpoint.
Once this action is complete the security will be back in "active" status and can continue receiving new subscriptions.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["approved_revert_to_active"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "revertCompletedToActive".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/revert-completed-to-active HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to add a correlation ID to an existing security. This correlation ID is an externally provided id that uniquely identifies the security within the organization making this call.
This correlation ID can't be in use by another security. This correlation ID can be broadcast to all the counterparties that have access to this security.
If the ID is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
Externally provided id that uniquely identifies an entity within an organization.
123245573717This property defines if correlation information will be sent to all counterparties.
falseExample: trueThe organization origin system that created this entity correlation id
Backoffice-system-123This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/security-admin/correlation-id/add HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"broadcastToCounterparty": true,
"origin": "Backoffice-system-123",
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to trigger the complete of an offering.
This should be called when the minimum amount being raised has been reached.
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
Once processed, no further investments can be performed unless the offering is reverted back to active (be aware that contingent offerings cannot be reverted back to active so this action will be irreversible in that case).
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "completeOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/complete HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}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".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfInformation about the security that will be created
{"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}}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.
falseExample: truePOST /external/v1/security-admin/create-and-launch HTTP/1.1
Host:
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
}This route is used to refund canceled / busted Offerings. It is the last step of the security lifecycle for failed campaigns.
It should be executed once all the investments (if any) have been refunded.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["busted","canceled"].
This endpoint can be called by applications with access to scope "refundOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/refund HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the confirmation of an offering completion.
It is the last step of the primary market and should be executed after the offering was completed. This action is irreversible and is the last step of the security lifecycle.
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["completed"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "confirmCompleting".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/confirm HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used for a service provider (e.g. Fund Admin) or an Issuer to pause an existing active offering.
Once this action is complete it will not be possible to receive new subscriptions or proceed to the next stages of the security lifecycle until the "unpause" action is invoked.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "pauseOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/pause HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to remove a correlation ID from an existing security. This correlation ID is an externally provided id that uniquely identifies the security within the organization making this call.
This correlation ID should be in use by the security involved in this call.
This action can be broadcast to all the counterparties that have access to this security.
If the action is to be broadcast, then it will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageReferenceData".
Externally provided id that uniquely identifies an entity within an organization.
123245573717This property contains the transactional data information, i.e. which is the security where we are adding a correlation id to a entity
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/security-admin/correlation-id/remove HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"correlationId": "123245573717",
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}This route is used to update the end date of an offering.
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","service_provider"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "extendOfferingEndDate".
This property contains the transactional data information, i.e. which is the security where the end date is being extended
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}The new date. Must be after end date.
2024-09-12T00:00:00.000ZDate-time string
2024-09-12T00:00:00.000ZDate string
1980-01-01Epoch timestamp (milliseconds)
1185106460000PUT /external/v1/security-admin/extend-end-date HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"endDate": "2024-09-12T00:00:00.000Z"
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the process to recover a restricted security.
This will allow all activity on this security to be resumed.
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","service_provider"].
This endpoint can only be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "recoverOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/recover HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to trigger the bust of an offering. It should be called when the minimum amount being raised was not reached and it is after the end date.
For contingent offerings, all the investments (if any) need to be refunded after this action.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "bustOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/bust HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to update the maximum amount to be raised.
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","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active"].
This endpoint can only be invoked for non-contingent or continuous offerings.
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "updateOfferingMaxAmount".
This property contains the transactional data information, i.e. which is the security where the maximum amount is being updated.
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}Maximum amount to be sold. The unit is the issuance's currency.
This parameter should not be lower than the total amount already raised.
Up to 2 fractional digits may be provided.
2500000PUT /external/v1/security-admin/update-max-amount HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"maxAmount": 2500000
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to cancel an offering. It requires the offering to be restricted first using the "Security Admin API".
It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.
This action is irreversible. Once persisted on the blockchain all the investments (if any) need to be refunded.
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].
This endpoint can be invoked if the security is in one of the following statuses: ["active","completed"].
This endpoint can be called by applications with access to scope "cancelOffering".
This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.
This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.
{"email":"[email protected]","name":"John Doe"}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.
2159457f-0167-4e93-a969-9cf0db05e0bfThis is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both.
USS3JKS01I00This property contains the correlation data that is used to identify a particular security within an organization. It is optional.
Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".
PUT /external/v1/security-admin/cancel HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"securityId": "USS3JKS01I00",
"securityCorrelationData": {
"correlationId": "USS3JKS01I00",
"orgId": "US9QIMA"
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}