Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
/external/v1/exclusivity/accept
The current organization must be assigned as an investing org for this security.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
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.
securityId: identifier for the fund/offering. See Managing the SecurityId.
An active fund is visible only to those investing organizations that have accepted assignment to the exclusivity list for that fund. These steps are included as part of the standard setup flow for a new offering, but can be performed after the initial setup.
Mapping Your IDs to Corastone IDs
The following list summarizes the primary endpoints required to support the exclusivity life cycle:
Add Organization to Exclusivity List
Accept Assignment to Exclusive Offering
Reject Assignment to Exclusive Offering
Remove Organization from Exclusive Offering List
Get Assigned Investing Organizations
Get Investor Org Assignment History
/external/v1/exclusivity/reject
Revert using the /accept endpoint.
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
/external/v1/exclusivity/remove
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.
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".
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).
["USS3JKS01I00"]This property contains the transactional data information, i.e. which is the security being affected by this action
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}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.
{"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)"}]}}}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"
}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".
This property contains the transactional data information, i.e. which is the security being affected by this action
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}The id of the organization. Used to uniquely identify the organization on the ledger
US9QIMASet 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
falseExample: trueThe exclusive offering's fees template details. If not provided, then new empty fees template will be created.
{"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"}]}]}]}}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"
}This route is used to extract all the investing organizations that have been assigned to an offering specified by a set of search filters.
This endpoint is paginated, up to 50 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readExclusivityOptions".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of organization ids to filter the assignment records. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security ids to filter the assignment records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the assignment records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of statuses to filter the assignment records. Up to 4 entries can be provided.
Available values: assigned, accepted, rejected, inactive
assigned,acceptedGET /external/v1/exclusivity HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"orgId": "US9QIMA",
"name": "State Street",
"status": "assigned",
"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)"
}
]
}
}
},
"isRepLetterProvided": true,
"feesInfo": {
"feesTemplateId": "US9QIMA",
"name": "Fees Template Name",
"status": "created",
"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"
}
]
}
]
}
],
"maxFrontendFee": 1,
"backendFee": 0
},
"role": "investor",
"securityId": "USCCWSF01I01"
}
]This route is used for an investing organization to reject 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.
Use this endpoint to express that you will not be performing investments in this security. This can be reverted by using the "accept" endpoint.
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".
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).
["USS3JKS01I00"]This property contains the transactional data information, i.e. which is the security being affected by this action
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/exclusivity/reject HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150
{
"shareClassSecurityIds": [
"USS3JKS01I00"
],
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to remove an organization from the exclusivity list. This will prevent that organization from executing further investments 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".
This property contains the transactional data information, i.e. which is the security being affected by this action
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}The id of the organization. Used to uniquely identify the organization on the ledger
US9QIMAFor 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 adding/removing an organizations to just a subset of them).
["USS3JKS01I00"]PUT /external/v1/exclusivity/remove HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"orgId": "US9QIMA",
"shareClassSecurityIds": [
"USS3JKS01I00"
]
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is used to update the value of the isRepLetterProvided field for the organization on the exclusivity list.
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 called by applications with access to scope "manageExclusivityOptions".
This property contains the transactional data information, i.e. which is the security being affected by this action
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}The id of the organization. Used to uniquely identify the organization on the ledger
US9QIMASet this value to true if the issuer of the security has a rep letter from the distribution partner being assigned to the exclusivity list.
falseExample: truePUT /external/v1/exclusivity/update-rep-letter-provided HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"orgId": "US9QIMA",
"isRepLetterProvided": true
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}This route is to get the history of investor assignments, given a set of filters such as blockchain details or organization or security identifiers.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readExclusivityOptions".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of organization ids to filter the assignment history records. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security ids to filter the assignment history records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the assignment history records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/exclusivity/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"securityId": "USCCWSF01I00",
"event": "Added",
"update": {
"status": "assigned",
"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)"
}
]
}
}
},
"isRepLetterProvided": false,
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]This route is used to get the pending assignment requests for this current organization.
This endpoint can be called by applications with access to scope "readExclusivityOptions".
GET /external/v1/exclusivity/pending-assignments HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"securityId": "USS3JKS01I00",
"assignerOrg": {
"name": "Test Issuer",
"orgId": "US9QIMA"
},
"createdDate": "2024-09-12T00:00:00.000Z",
"details": [
{
"securityId": "USS3JKS01I00",
"status": "assigned"
}
],
"syncJobStatus": "success",
"blockNumber": "text",
"blockchainTransactionId": "text"
}
]