AM/TA/Inv - Get Security Details

Details

/external/v1/securities

Synopsis

Get Security Details

get

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".

Required scopes

This endpoint requires the following scopes:

• : readIssuance

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

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).

securityStatusFilterstringOptional

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

Example: active,closed

securityTypeFilterstringOptional

The comma delimited list of security types to filter the security records. Up to 8 entries can be provided.Available values: equity, lpUnits, llcUnits, spcUnits, convertible, lpInterest, llcUnitShares, cash

Example: equity,llcUnitShares

securityIdsFilterstringOptional

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.

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationIdsFilterstringOptional

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. Any entry on this list that could contain commas should be withing "" like so: "this is , the correlation id".

Example: 1234,5678,7890

securityCorrelationOrgIdstring · 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

namestringRequired

Name of the security

Example: Test U.S. Real Estate Fund II Access Fund, L.P.

shortNamestringOptional

Short name of the security. This can be provided if the commonly used name of the security is different than its legal name (captured on the “name” property). It is optional.

Example: Test Real Estate Fund II

securityIdstringRequired

The id that uniquely identifies this security on the ledger

Example: USCCWSF01I01

isMoneyMarketbooleanOptional

True if the security is a money market fund.

Default: falseExample: true

campaignCompletedDateone ofOptional

Issuance campaign completion date

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

restrictedbooleanRequired

True if the security is restricted, false otherwise. It is not possible to execute any transaction on this security while it is restricted.

Example: false

exemptionall ofOptional

The exemption type configuration. It should be compatible with an investor accreditation level. If this is property is defined, then only investors with compatible accreditation levels will be allowed to create new assets.

Example: REIT

string · enumOptional

The exemption type configuration. It should be compatible with an investor accreditation level. If this is property is defined, then only investors with compatible accreditation levels will be allowed to create new assets.

Possible values:

parentSecurityIdstringOptional

The security id of the parent offering. This parent security will contain the aggregated values of all share classes. Only applicable for registered products with share classes

Example: USCCWSF01I01

exclusivityTypeall ofRequired

The exclusive type configuration. If it is private then only the organizations that were invited to invest in this security can actually do it

Example: private

string · enumOptional

The exclusive type configuration. If it is private then only the organizations that were invited to invest in this security can actually do it

Possible values:

statusall ofRequired

The status of the security

Example: active

string · enumOptional

The status of the security

Possible values:

accountIdstringOptional

The unique identifier of the internal account linked to the security. This account is to be used for receiving payment from primary market or capital calls. It will also be the account that will be used to perform lifecycle events like tender offers where payments need to be made to the underlying investors.

Example: US9QIMAOAS1Q

deploymentStatusall ofOptional

The status of the issuance deployment

Example: success

string · enumOptional

The status of the orchestration.

Possible values:

lockedbooleanOptional

True if the issuance is locked for edit (e.g. while executing certain blockchain actions), false otherwise.

Example: false

isSynchronizingDatabooleanOptional

If this property is set to true it means that a data synchronization job is running in background and no actions can be performed until this is finished.

Example: false

facilitationAccountIdsstring[]Optional

The unique identifier of the facilitation accounts linked to the security.

Example: ["US9QIMAOAS1Q"]

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

/external/v1/securities

HTTPcURLJavaScriptPython

GET /external/v1/securities HTTP/1.1
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,
    "isSynchronizingData": 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": "[phone]"
        }
      ],
      "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
      }
    },
    "facilitationAccountIds": [
      "US9QIMAOAS1Q"
    ],
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies security on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
]