openapi: 3.0.1
info:
title: Envestnet Aggregation APIs Account Token DataExtracts 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 <a href="https://developer.envestnet.com/resources/yodlee/yodlee-api-overview/docs">Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: 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: DataExtracts
description: DataExtracts API
paths:
/dataExtracts/userData:
get:
tags:
- DataExtracts
summary: Envestnet Get userData
description: The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.<br>The time difference between fromDate and toDate fields cannot be more than 60 minutes.<br>By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.<br>In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.<br>This service is only invoked with either admin access token or a cobrand session.<br/>Refer to <a href="https://developer.envestnet.com/resources/yodlee/data-extracts/docs/overview">dataExtracts</a> page for more information.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.</li>
operationId: getDataExtractsUserData
parameters:
- name: fromDate
in: query
description: From DateTime (YYYY-MM-DDThh:mm:ssZ)
required: true
allowEmptyValue: false
schema:
type: string
- name: loginName
in: query
description: Login Name
required: true
allowEmptyValue: false
schema:
type: string
- name: toDate
in: query
description: To DateTime (YYYY-MM-DDThh:mm:ssZ)
required: true
allowEmptyValue: false
schema:
type: string
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/DataExtractsUserDataResponse'
400:
description: 'Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
deprecated: false
/dataExtracts/events:
get:
tags:
- DataExtracts
summary: Envestnet Get Events
description: The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.<br>Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the <a href="https://developer.envestnet.com/resources/yodlee/data-extracts/docs/overview">Data Extracts</a> page.<br>You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.<br>This service is only invoked with either admin access token or a cobrand session.<br>
operationId: getDataExtractsEvents
parameters:
- name: eventName
in: query
description: Event Name
required: true
allowEmptyValue: false
schema:
type: string
- name: fromDate
in: query
description: From DateTime (YYYY-MM-DDThh:mm:ssZ)
required: true
allowEmptyValue: false
schema:
type: string
- name: toDate
in: query
description: To DateTime (YYYY-MM-DDThh:mm:ssZ)
required: true
allowEmptyValue: false
schema:
type: string
responses:
200:
description: OK
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/DataExtractsEventResponse'
400:
description: 'Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than toDate.'
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/YodleeError'
401:
description: Unauthorized
content: {}
404:
description: Not Found
content: {}
deprecated: false
components:
schemas:
DataExtractsProviderAccount:
title: DataExtractsProviderAccount
type: object
properties:
destinationProviderAccountId:
type: integer
description: The providerAccountId that is retained as part of the many-to-one OAuth migration process.<br><b>Endpoints</b>:<ul><li>GET dataExtracts/userData</li></ul>
format: int64
readOnly: true
oauthMigrationStatus:
type: string
description: Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>GET providerAccounts/{providerAccountId}</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
enum:
- IN_PROGRESS
- TO_BE_MIGRATED
- COMPLETED
- MIGRATED
isManual:
type: boolean
description: Indicates whether account is a manual or aggregated provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
lastUpdated:
type: string
description: 'Indicate when the providerAccount is last updated successfully.<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET dataExtracts/userData</li></ul>'
readOnly: true
createdDate:
type: string
description: The date on when the provider account is created in the system.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>
readOnly: true
aggregationSource:
type: string
description: The source through which the providerAccount is added in the system.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>
readOnly: true
enum:
- SYSTEM
- USER
isDeleted:
type: boolean
description: 'Indicates if the provider account is deleted from the system.<b>Applicable containers</b>: All Containers<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET dataExtracts/userData</li></ul>'
readOnly: true
providerId:
type: integer
description: Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
format: int64
readOnly: true
requestId:
type: string
description: Unique id generated to indicate the request.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>
readOnly: true
sourceProviderAccountIds:
type: array
description: The providerAccountIds that are deleted and merged into the destinationProviderAccountId as part of the many-to-one OAuth migration process.<br><b>Endpoints</b>:<ul><li>GET dataExtracts/userData</li></ul>
readOnly: true
items:
type: integer
format: int64
id:
type: integer
description: Unique identifier for the provider account resource. This is created during account addition.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
format: int64
readOnly: true
authType:
type: string
description: The authentication type enabled at the provider site. <br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>
readOnly: true
enum:
- OAUTH
- CREDENTIALS
- MFA_CREDENTIALS
dataset:
type: array
description: Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul>
readOnly: true
items:
$ref: '#/components/schemas/AccountDataset'
status:
type: string
description: The status of last update attempted for the account. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>
readOnly: true
enum:
- LOGIN_IN_PROGRESS
- USER_INPUT_REQUIRED
- IN_PROGRESS
- PARTIAL_SUCCESS
- SUCCESS
- FAILED
- MIGRATION_IN_PROGRESS
- DATA_RETRIEVAL_FAILED
DataExtractsUserData:
title: DataExtractsUserData
type: object
properties:
holding:
type: array
readOnly: true
items:
$ref: '#/components/schemas/DataExtractsHolding'
totalTransactionsCount:
type: integer
format: int64
readOnly: true
user:
$ref: '#/components/schemas/DataExtractsUser'
account:
type: array
readOnly: true
items:
$ref: '#/components/schemas/DataExtractsAccount'
transaction:
type: array
readOnly: true
items:
$ref: '#/components/schemas/DataExtractsTransaction'
providerAccount:
type: array
readOnly: true
items:
$ref: '#/components/schemas/DataExtractsProviderAccount'
DataExtractsHolding:
title: DataExtractsHolding
type: object
properties:
symbol:
type: string
description: 'The symbol of the security.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
exercisedQuantity:
type: number
description: 'The quantity of the employee stock options that are already exercised or bought by the employee.<br><b>Note</b>: 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.<br><br><b>Applicable containers</b>: investment<br>'
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.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
vestedQuantity:
type: number
description: 'The quantity of units or shares that are already vested on a vest date.<br><b>Note</b>: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
format: double
readOnly: true
description:
type: string
description: 'The description (name) for the holding (E.g., Cisco Systems)<br>For insurance container, the field is only applicable for insurance annuity and variable life insurance types. <br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
unvestedValue:
$ref: '#/components/schemas/Money'
securityStyle:
type: string
description: 'Indicates the security style of holding identified through the security service.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
vestedValue:
$ref: '#/components/schemas/Money'
optionType:
type: string
description: 'The type of the option position (i.e., put or call).<br><b>Note</b>: The option type field is only applicable to options.<br><br><b>Applicable containers</b>: investment<br><b>Applicable Values</b><br>'
readOnly: true
enum:
- put
- call
- unknown
- other
lastUpdated:
type: string
description: 'The date when the information was last updated in the system.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
matchStatus:
type: string
description: 'Indicates the security match status id of the investment option identified during security normalization.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
holdingType:
type: string
description: 'Type of holding<br><br><b>Applicable containers</b>: investment, insurance<br>'
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.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
price:
$ref: '#/components/schemas/Money'
term:
type: string
description: 'The fixed duration for which the bond or CD is issued.<br><b>Note</b>: The term field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
contractQuantity:
type: number
description: 'The quantity of tradeable units in a contract.<br><b>Note</b>: The contract quantity field is only applicable to commodity and currency.<br><br><b>Applicable containers</b>: investment<br>'
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.<br><br><b>Applicable containers</b>: investment, insurance<br>'
format: int64
readOnly: true
isShort:
type: boolean
description: 'Indicates that the holding is a short trading.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
value:
$ref: '#/components/schemas/Money'
expirationDate:
type: string
description: 'The date on which an option, right or warrant expires.<br><b>Note</b>: The expiration date field is only applicable to options and employee stock options.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
interestRate:
type: number
description: 'The interest rate on a CD.<br><b>Note</b>: The interest rate field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br>'
format: double
readOnly: true
quantity:
type: number
description: 'The quantity held for the holding.<br><b>Note</b>: 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.<br>For insurance container, the field is only applicable for insurance annuity and variable life insurance types.<br><br><b>Applicable containers</b>: investment, insurance<br>'
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.<br><b>Note</b>: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
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.<br><b>Note</b>: The SEDOL field is only applicable to the trade related transactions<br><br><b>Applicable containers</b>: investment<br>'
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.<br><b>Note</b>: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
format: double
readOnly: true
spread:
$ref: '#/components/schemas/Money'
accountId:
type: integer
description: 'Unique identifier of the account to which the security is linked.<br><br><b>Applicable containers</b>: investment, insurance<br>'
format: int64
readOnly: true
enrichedDescription:
type: string
description: 'The enrichedDescription is the security description of the normalized holding<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
couponRate:
type: number
description: 'The stated interest rate for a bond.<br><br><b>Applicable containers</b>: investment<br>'
format: double
readOnly: true
createdDate:
type: string
description: 'The date on which the holding is created in the Yodlee system.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
accruedIncome:
$ref: '#/components/schemas/Money'
securityType:
type: string
description: 'Indicates the security type of holding identified through the security service.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
providerAccountId:
type: integer
description: 'Unique identifier for the user''s association with the provider.<br><br><b>Applicable containers</b>: investment, insurance<br>'
format: int64
readOnly: true
unvestedQuantity:
type: number
description: 'Indicates the number of unvested quantity or units.<br><b>Note</b>: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
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.<br><b>Note</b>: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
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.<br><br><b>Note</b>: The ISIN field is only applicable to the trade related transactions<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
strikePrice:
$ref: '#/components/schemas/Money'
DataExtractsEvent:
title: DataExtractsEvent
type: object
properties:
data:
$ref: '#/components/schemas/DataExtractsEventData'
info:
type: string
readOnly: true
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
BankTransferCode:
title: BankTransferCode
type: object
properties:
id:
type: string
description: 'The FI''s branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). <br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul>'
type:
type: string
description: 'The bank transfer code type varies depending on the region of the account origination. <br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: bank, investment<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST verification</li></ul><b>Applicable Values</b><br>'
enum:
- BSB
- IFSC
- ROUTING_NUMBER
- SORT_CODE
RewardBalance:
title: RewardBalance
type: object
properties:
expiryDate:
type: string
description: 'The date on which the balance expires.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
balanceToReward:
type: string
description: 'The balance required to qualify for a reward such as retaining membership, business reward, etc.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
balanceType:
type: string
description: 'The type of reward balance.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>'
readOnly: true
enum:
- EXPIRING_BALANCE
- BALANCE_TO_LEVEL
- BALANCE_TO_REWARD
- BALANCE
- TOTAL_BALANCE
balance:
type: number
description: 'The actual reward balance.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
format: double
readOnly: true
description:
type: string
description: 'The description for the reward balance as available at provider source.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
balanceToLevel:
type: string
description: 'The balance required to reach a reward level.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
units:
type: string
description: 'Unit of reward balance - miles, points, segments, dollars, credits.<br><br><b>Account Type</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>'
readOnly: true
AccountDataset:
title: AccountDataset
type: object
properties:
lastUpdated:
type: string
description: 'Indicate when the dataset is last updated successfully for the given provider account.<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>'
readOnly: true
updateEligibility:
type: string
description: 'Indicate whether the dataset is eligible for update or not.<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul><b>Applicable Values</b><br>'
readOnly: true
enum:
- ALLOW_UPDATE
- ALLOW_UPDATE_WITH_CREDENTIALS
- DISALLOW_UPDATE
additionalStatus:
type: string
description: 'The status of last update attempted for the dataset. <br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul><b>Applicable Values</b><br>'
readOnly: true
enum:
- LOGIN_IN_PROGRESS
- DATA_RETRIEVAL_IN_PROGRESS
- ACCT_SUMMARY_RECEIVED
- AVAILABLE_DATA_RETRIEVED
- PARTIAL_DATA_RETRIEVED
- DATA_RETRIEVAL_FAILED
- DATA_NOT_AVAILABLE
- ACCOUNT_LOCKED
- ADDL_AUTHENTICATION_REQUIRED
- BETA_SITE_DEV_IN_PROGRESS
- CREDENTIALS_UPDATE_NEEDED
- INCORRECT_CREDENTIALS
- PROPERTY_VALUE_NOT_AVAILABLE
- INVALID_ADDL_INFO_PROVIDED
- REQUEST_TIME_OUT
- SITE_BLOCKING_ERROR
- UNEXPECTED_SITE_ERROR
- SITE_NOT_SUPPORTED
- SITE_UNAVAILABLE
- TECH_ERROR
- USER_ACTION_NEEDED_AT_SITE
- SITE_SESSION_INVALIDATED
- NEW_AUTHENTICATION_REQUIRED
- DATASET_NOT_SUPPORTED
- ENROLLMENT_REQUIRED_FOR_DATASET
- CONSENT_REQUIRED
- CONSENT_EXPIRED
- CONSENT_REVOKED
- INCORRECT_OAUTH_TOKEN
- MIGRATION_IN_PROGRESS
nextUpdateScheduled:
type: string
description: 'Indicates when the next attempt to update the dataset is scheduled.<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>'
readOnly: true
name:
type: string
description: 'The name of the dataset requested from the provider site<br><br><b>Account Type</b>: Manual<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>'
enum:
- BASIC_AGG_DATA
- ADVANCE_AGG_DATA
- ACCT_PROFILE
- DOCUMENT
lastUpdateAttempt:
type: string
description: 'Indicate when the last attempt was performed to update the dataset for the given provider account<br><br><b>Account Type</b>: Aggregated<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li></ul>'
readOnly: true
Description:
title: Description
type: object
properties:
security:
type: string
description: 'The description will provide the actual name of the security.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
original:
type: string
description: 'Original transaction description as it appears at the FI site.<br><br><b>Applicable containers</b>: creditCard, insurance, loan<br>'
readOnly: true
simple:
type: string
description: 'The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field.Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.<br><br><b>Applicable con
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/envestnet/refs/heads/main/openapi/envestnet-dataextracts-api-openapi.yml