Envestnet · Schema

Security

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
stockExchangeDetails array Securities exchange provide the securities information at the corresponding exchanges.

Applicable containers: investment, insurance
issueTypeMultiplier number Price units corresponding to the security style. This is used to derive actual price of the security from market value.

Applicable containers: investment, insurance
stateTaxable boolean The state in which the security is taxed.

Applicable containers: investment, insurance
callDate string Next call date of the security.

Applicable containers: investment, insurance
cdscFundFlag boolean cdsc fund flag of the security.

Applicable containers: investment, insurance
cusip string A CUSIP is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.

Applicable containers
federalTaxable boolean Flag indicating federal taxable.

Applicable containers: investment, insurance
sAndPRating string Unique identifier for S&P rating on Envestnet platform.

Applicable containers: investment, insurance
shareClass string Share class of the security.

Applicable containers: investment, insurance
isEnvestnetDummySecurity boolean Flag indicating a dummy security.

Applicable containers: investment, insurance
description string The description (name) of the security. For example, Cisco Systems.

Applicable containers: investment, insurance
minimumPurchase integer Minimum purchase of security.

Applicable containers: investment, insurance
type string Indicates the type of security like stocks, mutual fund, etc.

Applicable containers: investment, insurance
firstCouponDate string First coupon date of security.

Applicable containers: investment, insurance
frequency integer Coupon Frequency.

Applicable containers: investment, insurance
accrualMethod string The method in which interest is accrued or earned.

Applicable containers: investment, insurance
incomeCurrency string ISO 4217 currency code indicating income currency of the security.

Applicable containers: investment, insurance
maturityDate string Maturity date of the security.

Applicable containers: investment, insurance
callPrice number Next call price of the security.

Applicable containers: investment, insurance
id integer The unique identifier of the security.

Applicable containers: investment, insurance
issueDate string Issue date of the security.

Applicable containers: investment, insurance
sector string Identifier of the sector to which the security belongs to.

Applicable containers: investment, insurance
agencyFactor number Agency factor of the security.

Applicable containers: investment, insurance
interestRate number The rate of interest paid annually, expressed as a percentage of the bond's par or face value.

Applicable containers: investment, insurance
lastModifiedDate string The last updated date of the security.

Applicable containers: investment, insurance
gicsSector string GICS Sector is a categorization the S&P assigns to all publically traded companies.

Applicable containers: investment, insurance
closedFlag boolean true:Closed for all investors , false: Open to all investors.

Applicable containers: investment, insurance
sedol string The Stock Exchange Daily Official List (SEDOL) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.
Note: The SEDOL field is only applicable to the
subSector string GICS sector ID to which the security belongs to.

Applicable containers: investment, insurance
lastCouponDate string Last coupon date of security.

Applicable containers: investment, insurance
isSyntheticSecurity boolean Indicates whether the security is a simulated security.

Applicable containers: investment, insurance
tradeCurrencyCode string ISO 4217 currency code indicating trading currency of the security.

Applicable containers: investment, insurance
isDummySecurity boolean Indicates whether the security is a dummy security.

Applicable containers: investment, insurance
moodyRating string Unique identifier for Moody rating on Envestnet platform.

Applicable containers: investment, insurance
style string Classification of the style for the security.

Applicable containers: investment, insurance
firmEligible string 1- indicates Eligible,0- indicates firm is not eligible.

Applicable containers: investment, insurance
fundFamily string Mutual Fund Family Name.

Applicable containers: investment, insurance
isin string The International Securities Identification Number (ISIN) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

Applicable containers: i
View JSON Schema on GitHub

JSON Schema

envestnet-security-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Security",
  "title": "Security",
  "type": "object",
  "properties": {
    "stockExchangeDetails": {
      "type": "array",
      "description": "Securities exchange provide the securities information at the corresponding exchanges. <br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/StockExchangeDetail"
      }
    },
    "issueTypeMultiplier": {
      "type": "number",
      "description": "Price units corresponding to the security style. This is used to derive actual price of the security from market value.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "stateTaxable": {
      "type": "boolean",
      "description": "The state in which the security is taxed.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "callDate": {
      "type": "string",
      "description": "Next call date of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "cdscFundFlag": {
      "type": "boolean",
      "description": "cdsc fund flag of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "cusip": {
      "type": "string",
      "description": "A CUSIP is a nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "federalTaxable": {
      "type": "boolean",
      "description": "Flag indicating federal taxable.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "sAndPRating": {
      "type": "string",
      "description": "Unique identifier for S&P rating on Envestnet platform.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "shareClass": {
      "type": "string",
      "description": "Share class of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "isEnvestnetDummySecurity": {
      "type": "boolean",
      "description": "Flag indicating a dummy security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "The description (name) of the security. For example, Cisco Systems.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "minimumPurchase": {
      "type": "integer",
      "description": "Minimum purchase of security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "int32",
      "readOnly": true
    },
    "type": {
      "type": "string",
      "description": "Indicates the type of security like stocks, mutual fund, etc. <br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "firstCouponDate": {
      "type": "string",
      "description": "First coupon date of security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "frequency": {
      "type": "integer",
      "description": "Coupon Frequency.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "int32",
      "readOnly": true
    },
    "accrualMethod": {
      "type": "string",
      "description": "The method in which interest is accrued or earned.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "incomeCurrency": {
      "type": "string",
      "description": "ISO 4217 currency code indicating income currency of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "maturityDate": {
      "type": "string",
      "description": "Maturity date of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "callPrice": {
      "type": "number",
      "description": "Next call price of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The unique identifier of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "int64",
      "readOnly": true
    },
    "issueDate": {
      "type": "string",
      "description": "Issue date of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "sector": {
      "type": "string",
      "description": "Identifier of the sector to which the security belongs to.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "agencyFactor": {
      "type": "number",
      "description": "Agency factor of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "interestRate": {
      "type": "number",
      "description": "The rate of interest paid annually, expressed as a percentage of the bond's par or face value.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "format": "double",
      "readOnly": true
    },
    "lastModifiedDate": {
      "type": "string",
      "description": "The last updated date of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "gicsSector": {
      "type": "string",
      "description": "GICS Sector is a categorization the S&P assigns to all publically traded companies. <br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "closedFlag": {
      "type": "boolean",
      "description": "<b>true</b>:Closed for all investors , <b>false</b>: Open to all investors.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "sedol": {
      "type": "string",
      "description": "The Stock Exchange Daily Official List (SEDOL) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><b>Note</b>: The SEDOL field is only applicable to the trade related transactions.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "subSector": {
      "type": "string",
      "description": "GICS sector ID to which the security belongs to.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "lastCouponDate": {
      "type": "string",
      "description": "Last coupon date of security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "isSyntheticSecurity": {
      "type": "boolean",
      "description": "Indicates whether the security is a simulated security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "tradeCurrencyCode": {
      "type": "string",
      "description": "ISO 4217 currency code indicating trading currency of the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "isDummySecurity": {
      "type": "boolean",
      "description": "Indicates whether the security is a dummy security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "moodyRating": {
      "type": "string",
      "description": "Unique identifier for Moody rating on Envestnet platform.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "style": {
      "type": "string",
      "description": "Classification of the style for the security.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "firmEligible": {
      "type": "string",
      "description": "<b>1</b>- indicates Eligible,<b>0</b>- indicates firm is not eligible.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "fundFamily": {
      "type": "string",
      "description": "Mutual Fund Family Name.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    },
    "isin": {
      "type": "string",
      "description": "The International Securities Identification Number (ISIN) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.<br><br><b>Applicable containers</b>: investment, insurance<br>",
      "readOnly": true
    }
  }
}