AM/FA/Inv - Get Security Details
Details
Synopsis
This route is used to retrieve the details of securities given a set of search filters.
This endpoint is paginated, up to 10 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readIssuance".
Authorizations
Query parameters
pageSizenumberOptional
The number of rows being retrieved. Must be a positive integer.
offsetnumberOptional
The offset (i.e. row start index). Must be a positive integer (or 0).
securityStatusFilterstringOptionalExample:
The comma delimited list of statuses to filter the security records. Up to 14 entries can be provided. Available values: deleted, preSync, active, closed, completed, bust_in_progress, busted, cancel_in_progress, canceled, refund_in_progress, retired, approved_revert_to_active, paused, archived
active,closedsecurityTypeFilterstringOptionalExample:
The comma delimited list of security types to filter the security records. Up to 7 entries can be provided. Available values: equity, lpUnits, llcUnits, spcUnits, convertible, lpInterest, llcUnitShares
equity,llcUnitSharessecurityIdsFilterstringOptionalExample:
The comma delimited list of security ids to filter the security records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01securityCorrelationIdsFilterstringOptionalExample:
The comma delimited list of security correlation ids to filter the security records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890securityCorrelationOrgIdstring · max: 12Optional
The 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.
Responses
200
Successfully retrieved the Issuance details
application/json
400
The following error codes can be returned:
- GN0002
- GN0004
- GN0005
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
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
get
GET /external/v1/securities HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"name": "Test U.S. Real Estate Fund II Access Fund, L.P.",
"shortName": "Test Real Estate Fund II",
"externalIdentifiers": {
"isin": "US0004026250",
"cusip": "056833100",
"ticker": "NYSE"
},
"settings": {
"bankAccount": {
"bankABA": "979384247",
"bankName": "Test Bank",
"accountName": "Test U.S. Real Estate Fund II Access Fund, L.P.",
"accountNumber": "457349587349587"
}
},
"securityId": "USCCWSF01I01",
"isMoneyMarket": true,
"termSheetInfo": {
"securityType": "lpUnits",
"campaignType": "NonContingent",
"allowBelowMinimum": true,
"mannerOfSaleInfo": {
"endDate": "2024-09-12T00:00:00.000Z",
"maxAmount": 750000000,
"minAmount": 0,
"startDate": "2024-09-12T00:00:00.000Z"
},
"regulation": "RegS",
"priceOptions": {
"unitized": false,
"unitPrice": 12,
"minimumInvestment": 120,
"allowsReinvestment": true,
"type": "static",
"currency": "USD",
"totalSold": 0
},
"navOptions": {
"navCurrency": "USD",
"navFrequency": "Monthly"
},
"dividendOptions": {
"dividendOption": "Mandatory Dividend",
"dividendPercentage": 3,
"dividendPaymentSchedule": "Annually",
"dividendType": "cumulative"
},
"redemptionOptions": {
"redemptionTenderOfferOptionEnabled": true,
"redemptionPercentage": 2,
"redemptionFrequency": "Monthly",
"redemptionLockupPeriodMonth": 30,
"redemptionNoticePeriod": 10
},
"shareClassInfo": [
{
"securityId": "USCCWSF01I01",
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies share class on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
]
}
],
"feesInfo": {
"feesTemplateInfo": {
"feesTemplateId": "FT123456",
"name": "Charles Schwab Fees Template",
"status": "created",
"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"
}
]
}
]
}
]
},
"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"
}
]
}
}
}
},
"campaignCompletedDate": "2024-09-12T00:00:00.000Z",
"restricted": false,
"exemption": "REIT",
"parentSecurityId": "USCCWSF01I01",
"exclusivityType": "private",
"status": "active",
"shareClassOptions": {
"description": "This share class is offered to brokerage accounts",
"accountEligibility": "Brokerage"
},
"accountId": "US9QIMAOAS1Q",
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"deploymentStatus": "success",
"locked": false,
"legalEntityInfo": {
"legalEntityId": "US1G14EGN",
"status": "preSync",
"locked": false,
"name": "Test Legal Entity",
"type": "LP",
"taxId": "987654321",
"address": {
"addressLineOne": "8 Greenway Plaza",
"city": "New York",
"state": "NY",
"country": "US",
"zipCode": "10165"
},
"isUsEntity": true,
"contactInfo": [
{
"email": "[email protected]",
"phoneNumber": "+1234950987"
}
],
"incorporationDate": "2024-09-12",
"incorporationState": "DE",
"incorporationCountry": "US",
"fundInfo": {
"name": "Test Fund",
"description": "This data is for test purposes",
"taxReporting": "K-1",
"exemption": "3(C)(1)",
"type": "Hedge Fund",
"strategy": "Long/Short",
"is1031Eligible": false
}
},
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies security on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
]
}
]Last updated
Was this helpful?