openapi: 3.0.1 info: title: Envestnet Aggregation APIs Account Token Derived API description: 'This file describes the Yodlee Aggregation product APIs using the swagger notation that you can use to build your financial application. You can generate the client SDK in Python, JavaScript, PHP, or any other languages according to your development needs. For more details about the APIs, refer to Yodlee API v1.1 - Overview.

You will have to set the header before making the API call. The following headers apply to all the APIs:Note: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.' termsOfService: https://developer.yodlee.com/terms/condition contact: email: developer@yodlee.com license: name: Yodlee Developer License url: https://developer.yodlee.com/terms/condition#_Services_1 version: 1.1.0 servers: - url: / tags: - name: Derived description: Derived API paths: /derived/transactionSummary: get: tags: - Derived summary: Envestnet Get Transaction Summary description: The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.

Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.

Notes:
  1. Details can be requested for only one system-defined category
  2. Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE
  3. Dates will not be respected for monthly, yearly, and weekly details
  4. When monthly details are requested, only the fromDate and toDate month will be respected
  5. When yearly details are requested, only the fromDate and toDate year will be respected
  6. For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate
  7. This service supports the localization feature and accepts locale as a header parameter
operationId: getTransactionSummary parameters: - name: accountId in: query description: comma separated account Ids allowEmptyValue: false schema: type: string - name: categoryId in: query description: comma separated categoryIds allowEmptyValue: false schema: type: string - name: categoryType in: query description: LOAN, INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION allowEmptyValue: false schema: type: string - name: fromDate in: query description: YYYY-MM-DD format allowEmptyValue: false schema: type: string - name: groupBy in: query description: CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY required: true allowEmptyValue: false schema: type: string - name: include in: query description: details allowEmptyValue: false schema: type: string - name: includeUserCategory in: query description: TRUE/FALSE allowEmptyValue: false schema: type: boolean - name: interval in: query description: D-daily, W-weekly, M-mothly or Y-yearly allowEmptyValue: false schema: type: string - name: toDate in: query description: YYYY-MM-DD format allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DerivedTransactionSummaryResponse' 400: description: 'Y010 : Invalid session
Y800 : Invalid value for accountId
Y800 : Invalid value for groupBy
Y803 : groupBy required
Y803 : categoryType required
Y800 : Invalid value for categoryId
Y800 : Invalid value for fromDate
Y800 : Invalid value for toDate
Y800 : Invalid value for fromDate or toDate
Y814 : Exchange rate not available for currency
Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE
Y816 : User-defined category details can only be requested for one system categoryId with groupBy=''CATEGORY''
Y824 : The maximum number of accountIds permitted is 100
Y824 : The maximum number of categoryIds permitted is 100
Y824 : The maximum number of categoryTypes permitted is 100' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /derived/networth: get: tags: - Derived summary: Envestnet Get Networth Summary description: The get networth service is used to get the networth for the user.
If the include parameter value is passed as details then networth with historical balances is returned.
operationId: getNetworth parameters: - name: accountIds in: query description: comma separated accountIds allowEmptyValue: false schema: type: string - name: container in: query description: bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities allowEmptyValue: false schema: type: string - name: fromDate in: query description: from date for balance retrieval (YYYY-MM-DD) allowEmptyValue: false schema: type: string - name: include in: query description: details allowEmptyValue: false schema: type: string - name: interval in: query description: D-daily, W-weekly or M-monthly allowEmptyValue: false schema: type: string - name: skip in: query description: skip (Min 0) allowEmptyValue: false schema: type: integer format: int32 - name: toDate in: query description: toDate for balance retrieval (YYYY-MM-DD) allowEmptyValue: false schema: type: string - name: top in: query description: top (Max 500) allowEmptyValue: false schema: type: integer format: int32 responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DerivedNetworthResponse' 400: description: 'Y800 : Invalid value for accountIds
Y800 : Invalid value for fromDate
Y800 : Invalid value for toDate
Y809 : Invalid date range
Y800 : Invalid value for interval
Y802 : Future date not allowed
Y814 : Exchange rate not available for currency
Y800 : Invalid value for container' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /derived/holdingSummary: get: tags: - Derived summary: Envestnet Get Holding Summary description: The get holding summary service is used to get the summary of asset classifications for the user.
By default, accounts with status as ACTIVE and TO BE CLOSED will be considered.
If the include parameter value is passed as details then a summary with holdings and account information is returned.
operationId: getHoldingSummary parameters: - name: accountIds in: query description: Comma separated accountIds allowEmptyValue: false schema: type: string - name: classificationType in: query description: e.g. Country, Sector, etc. allowEmptyValue: false schema: type: string - name: include in: query description: details allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DerivedHoldingSummaryResponse' 400: description: 'Y800 : Invalid value for classificationType
Y814 : Exchange rate not available for currency
Y824 : The maximum number of accountIds permitted is 100
' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false components: schemas: DerivedCategorySummary: title: DerivedCategorySummary type: object properties: creditTotal: $ref: '#/components/schemas/Money' details: type: array description: 'Credit and debit summary per date.

Applicable containers: creditCard, bank, investment
' readOnly: true items: $ref: '#/components/schemas/DerivedCategorySummaryDetails' links: $ref: '#/components/schemas/DerivedTransactionsLinks' categoryName: type: string description: 'The name of the category.

Applicable containers: creditCard, bank, investment
' readOnly: true categoryId: type: integer description: 'Id of the category. This information is provided by transactions/categories service.

Applicable containers: creditCard, bank, investment
' format: int64 readOnly: true debitTotal: $ref: '#/components/schemas/Money' DerivedCategorySummaryDetails: title: DerivedCategorySummaryDetails type: object properties: date: type: string description: 'Date on which the credit and debit transactions had occured.

Applicable containers: creditCard, bank, investment
' readOnly: true creditTotal: $ref: '#/components/schemas/Money' debitTotal: $ref: '#/components/schemas/Money' DerivedHoldingSummaryResponse: title: DerivedHoldingSummaryResponse type: object properties: holdingSummary: type: array readOnly: true items: $ref: '#/components/schemas/DerivedHoldingsSummary' link: $ref: '#/components/schemas/DerivedHoldingsLinks' DerivedTransactionsLinks: title: DerivedTransactionsLinks type: object properties: transactions: type: string description: 'Link of the transaction API service that corresponds to the value derivation.

Applicable containers: creditCard, bank, investment
' readOnly: true DerivedHoldingsAccount: title: DerivedHoldingsAccount type: object properties: id: type: integer description: 'The primary key of the account resource and the unique identifier for the account.
Required Feature Enablement: Asset classification feature.

Applicable containers: investment, insurance
' format: int64 readOnly: true value: $ref: '#/components/schemas/Money' DerivedNetworthResponse: title: DerivedNetworthResponse type: object properties: networth: type: array readOnly: true items: $ref: '#/components/schemas/DerivedNetworth' DerivedHolding: title: DerivedHolding type: object properties: symbol: type: string description: 'The symbol of the security.

Applicable containers: investment
' readOnly: true exercisedQuantity: type: number description: 'The quantity of the employee stock options that are already exercised or bought by the employee.
Note: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.

Applicable containers: investment
' format: double readOnly: true cusipNumber: type: string description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.

Applicable containers: investment
' readOnly: true assetClassification: $ref: '#/components/schemas/AssetClassification' vestedQuantity: type: number description: 'The quantity of units or shares that are already vested on a vest date.
Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

Applicable containers: investment
' format: double readOnly: true description: type: string description: 'The description (name) for the holding (E.g., Cisco Systems)
For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

Applicable containers: investment, insurance
' readOnly: true unvestedValue: $ref: '#/components/schemas/Money' securityStyle: type: string description: 'Indicates the security style of holding identified through the security service.

Applicable containers: investment, insurance
' readOnly: true vestedValue: $ref: '#/components/schemas/Money' optionType: type: string description: 'The type of the option position (i.e., put or call).
Note: The option type field is only applicable to options.

Applicable containers: investment
Applicable Values
' readOnly: true enum: - put - call - unknown - other lastUpdated: type: string description: 'The date when the information was last updated in the system.

Applicable containers: investment, insurance
' readOnly: true matchStatus: type: string description: 'Indicates the security match status id of the investment option identified during security normalization.

Applicable containers: investment
' readOnly: true holdingType: type: string description: 'Type of holding

Applicable containers: investment, insurance
' readOnly: true enum: - stock - mutualFund - bond - CD - option - moneyMarketFund - other - remic - future - commodity - currency - unitInvestmentTrust - employeeStockOption - insuranceAnnuity - unknown - preferredStock - ETF - warrants - digitalAsset maturityDate: type: string description: 'The stated maturity date of a bond or CD.

Applicable containers: investment
' readOnly: true price: $ref: '#/components/schemas/Money' term: type: string description: 'The fixed duration for which the bond or CD is issued.
Note: The term field is only applicable to CD.

Applicable containers: investment
' readOnly: true contractQuantity: type: number description: 'The quantity of tradeable units in a contract.
Note: The contract quantity field is only applicable to commodity and currency.

Applicable containers: investment
' format: double readOnly: true id: type: integer description: 'Unique identifier for the security added in the system. This is the primary key of the holding resource.

Applicable containers: investment, insurance
' format: int64 readOnly: true isShort: type: boolean description: 'Indicates that the holding is a short trading.

Applicable containers: investment
' readOnly: true value: $ref: '#/components/schemas/Money' expirationDate: type: string description: 'The date on which an option, right or warrant expires.
Note: The expiration date field is only applicable to options and employee stock options.

Applicable containers: investment
' readOnly: true interestRate: type: number description: 'The interest rate on a CD.
Note: The interest rate field is only applicable to CD.

Applicable containers: investment
' format: double readOnly: true quantity: type: number description: 'The quantity held for the holding.
Note: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.
For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

Applicable containers: investment, insurance
' format: double readOnly: true accruedInterest: $ref: '#/components/schemas/Money' grantDate: type: string description: 'The date on which equity awards like ESOP, RSU, etc., are issued or granted.
Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

Applicable containers: investment
' readOnly: true sedol: type: string description: 'The SEDOL (Stock Exchange Daily Official List) 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 trade related transactions

Applicable containers: investment
' readOnly: true vestedSharesExercisable: type: number description: 'The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

Applicable containers: investment
' format: double readOnly: true spread: $ref: '#/components/schemas/Money' accountId: type: integer description: 'Unique identifier of the account to which the security is linked.

Applicable containers: investment, insurance
' format: int64 readOnly: true enrichedDescription: type: string description: 'The enrichedDescription is the security description of the normalized holding

Applicable containers: investment, insurance
' readOnly: true couponRate: type: number description: 'The stated interest rate for a bond.

Applicable containers: investment
' format: double readOnly: true createdDate: type: string description: 'The date on which the holding is created in the Yodlee system.

Applicable containers: investment, insurance
' readOnly: true accruedIncome: $ref: '#/components/schemas/Money' securityType: type: string description: 'Indicates the security type of holding identified through the security service.

Applicable containers: investment, insurance
' readOnly: true providerAccountId: type: integer description: 'Unique identifier for the user''s association with the provider.

Applicable containers: investment, insurance
' format: int64 readOnly: true unvestedQuantity: type: number description: 'Indicates the number of unvested quantity or units.
Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

Applicable containers: investment
' format: double readOnly: true costBasis: $ref: '#/components/schemas/Money' vestingDate: type: string description: 'The date on which a RSU, RSA, or an employee stock options become vested.
Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

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

Note: The ISIN field is only applicable to the trade related transactions

Applicable containers: investment
' readOnly: true strikePrice: $ref: '#/components/schemas/Money' DerivedTransactionsSummary: title: DerivedTransactionsSummary type: object properties: categoryType: type: string description: 'Type of categories provided by transactions/categories service.

Applicable containers: creditCard, bank, investment
Applicable Values
' readOnly: true enum: - TRANSFER - DEFERRED_COMPENSATION - UNCATEGORIZE - INCOME - EXPENSE - LOAN - DUMMY categorySummary: type: array description: 'Summary of transaction amouts at category level.

Applicable containers: creditCard, bank, investment
' readOnly: true items: $ref: '#/components/schemas/DerivedCategorySummary' creditTotal: $ref: '#/components/schemas/Money' links: $ref: '#/components/schemas/DerivedTransactionsLinks' debitTotal: $ref: '#/components/schemas/Money' AssetClassification: title: AssetClassification type: object properties: allocation: type: number description: 'The allocation percentage of the holding.

Required Feature Enablement: Asset classification feature

Applicable containers: investment
' format: double readOnly: true classificationType: type: string description: 'The type of classification to which the investment belongs (assetClass, country, sector, and style).
Required Feature Enablement: Asset classification feature

Applicable containers: investment
' readOnly: true classificationValue: type: string description: 'The value for each classificationType.
Required Feature Enablement: Asset classification feature

Applicable containers: investment
' readOnly: true DerivedNetworthHistoricalBalance: title: DerivedNetworthHistoricalBalance type: object properties: date: type: string description: 'Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance. AdditIonal Details: scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates. carryForward : Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc. calculated: Balances that gets calculated for the days that are prior to the account added date.

Account Type: Aggregated and Manual
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoints:' readOnly: true accountId: type: integer format: int64 readOnly: true isAsset: type: boolean description: 'Indicates whether the balance is an asset or liability.

Account Type: Aggregated and Manual
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoints:' readOnly: true balance: $ref: '#/components/schemas/Money' asOfDate: type: string description: 'Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system.

Account Type: Aggregated and Manual
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoints:' readOnly: true dataSourceType: type: string description: 'The source of balance information.

Account Type: Aggregated and Manual
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoints:Applicable Values
' readOnly: true enum: - S - C - CF DerivedTransactionSummaryResponse: title: DerivedTransactionSummaryResponse type: object properties: links: $ref: '#/components/schemas/DerivedTransactionsLinks' transactionSummary: type: array readOnly: true items: $ref: '#/components/schemas/DerivedTransactionsSummary' YodleeError: title: YodleeError type: object properties: errorMessage: type: string description: The descriptive message that explains the error scenario. readOnly: true errorCode: type: string description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities. readOnly: true referenceCode: type: string description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end. readOnly: true DerivedNetworth: title: DerivedNetworth type: object properties: date: type: string description: 'The date as of when the networth information is provided.

Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
' readOnly: true liability: $ref: '#/components/schemas/Money' historicalBalances: type: array description: 'Balances of the accounts over the period of time.

Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
' readOnly: true items: $ref: '#/components/schemas/DerivedNetworthHistoricalBalance' networth: $ref: '#/components/schemas/Money' asset: $ref: '#/components/schemas/Money' Money: title: Money type: object properties: amount: type: number description: Value of amount. format: double convertedAmount: type: number description: Value of the converted amount. format: double currency: type: string description: Currency should be a valid three-letter ISO Code. enum: - USD - AUD - BRL - CAD - EUR - GBP - HKD - IDR - INR - JPY - NZD - SGD - ZAR - CNY - VND - MYR - CHF - AED - AFA - ALL - AMD - ANG - AOA - ARS - AWG - AZM - BAM - BBD - BDT - BGL - BHD - BIF - BMD - BND - BOB - BSD - BTN - BWP - BYR - BZD - CDF - CLP - COP - CRC - CUP - CVE - CYP - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - FJD - FKP - GEL - GGP - GHC - GIP - GMD - GNF - GTQ - GYD - HNL - HRK - HTG - HUF - ILS - IMP - IQD - IRR - ISK - JEP - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGF - MKD - MMK - MNT - MOP - MRO - MTL - MUR - MVR - MWK - MXN - MZM - NAD - NGN - NIO - NOK - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - ROL - RUR - RWF - SAR - SBD - SCR - SDD - SEK - SHP - SIT - SKK - SLL - SOS - SPL - SRG - STD - SVC - SYP - SZL - THB - TJR - TMM - TND - TOP - TRL - TTD - TVD - TWD - TZS - UAH - UGX - UYU - UZS - VEB - VUV - WST - XAF - XAG - XAU - XCD - XDR - XOF - XPD - XPF - XPT - YER - YUM - ZMK - ZWD - ADP - ATS - BEF - BUK - CSD - CSK - DDM - DEM - ECS - ESP - FIM - GRD - GWP - IEP - ITL - LUF - MLF - NLG - PTE - SUR - TPE - UAK - XBA - XBB - XBC - XBD - XEU - XFO - XFU - XGF - XMK - XRM - XTS - YDD - YUD - ZRN - TJS - RON - BGN - BTC - XBT - CNH - RUB - TRY - GHS - TMT - ZMW - VEF - SSP - ALK convertedCurrency: type: string description: Currency should be a valid three-letter ISO Code. enum: - USD - AUD - BRL - CAD - EUR - GBP - HKD - IDR - INR - JPY - NZD - SGD - ZAR - CNY - VND - MYR - CHF - AED - AFA - ALL - AMD - ANG - AOA - ARS - AWG - AZM - BAM - BBD - BDT - BGL - BHD - BIF - BMD - BND - BOB - BSD - BTN - BWP - BYR - BZD - CDF - CLP - COP - CRC - CUP - CVE - CYP - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - FJD - FKP - GEL - GGP - GHC - GIP - GMD - GNF - GTQ - GYD - HNL - HRK - HTG - HUF - ILS - IMP - IQD - IRR - ISK - JEP - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGF - MKD - MMK - MNT - MOP - MRO - MTL - MUR - MVR - MWK - MXN - MZM - NAD - NGN - NIO - NOK - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - ROL - RUR - RWF - SAR - SBD - SCR - SDD - SEK - SHP - SIT - SKK - SLL - SOS - SPL - SRG - STD - SVC - SYP - SZL - THB - TJR - TMM - TND - TOP - TRL - TTD - TVD - TWD - TZS - UAH - UGX - UYU - UZS - VEB - VUV - WST - XAF - XAG - XAU - XCD - XDR - XOF - XPD - XPF - XPT - YER - YUM - ZMK - ZWD - ADP - ATS - BEF - BUK - CSD - CSK - DDM - DEM - ECS - ESP - FIM - GRD - GWP - IEP - ITL - LUF - MLF - NLG - PTE - SUR - TPE - UAK - XBA - XBB - XBC - XBD - XEU - XFO - XFU - XGF - XMK - XRM - XTS - YDD - YUD - ZRN - TJS - RON - BGN - BTC - XBT - CNH - RUB - TRY - GHS - TMT - ZMW - VEF - SSP - ALK DerivedHoldingsSummary: title: DerivedHoldingsSummary type: object properties: holding: type: array description: 'Securities that belong to the asset classification type and contributed to the summary value.
Required Feature Enablement: Asset classification feature.

Applicable containers: investment, insurance
' readOnly: true items: $ref: '#/components/schemas/DerivedHolding' classificationType: type: string description: 'The classification type of the security. The supported asset classification type and the values are provided in the /holdings/assetClassificationList.
Required Feature Enablement: Asset classification feature.

Applicable containers: investment, insurance
' readOnly: true classificationValue: type: string description: 'The classification value that corresponds to the classification type of the holding. The supported asset classification type and the values are provided in the /holdings/assetClassificationList.
Required Feature Enablement: Asset classification feature.

Applicable containers: investment, insurance
' readOnly: true value: $ref: '#/components/schemas/Money' account: type: array description: 'Accounts that contribute to the classification.
Required Feature Enablement: Asset classification feature.

Applicable containers: investment, insurance
' readOnly: true items: $ref: '#/components/schemas/DerivedHoldingsAccount' DerivedHoldingsLinks: title: DerivedHoldingsLinks type: object properties: holdings: type: string readOnly: true