Sorry, you need to enable JavaScript to visit this website.
Skip to main content

Accounts Resource

Entity: account

Attribute Name Container Type Aggregated/ Manual Description Endpoints
401kLoan  investment money Aggregated The amount borrowed from the 401k account.
Note: The 401k loan field applies only to the 401k account type.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
accountName  All containers string Both The account name as it appears on the site. (The POST accounts service response returns this field as name) GET accounts
GET accounts/{accountId} 
POST accounts
GET dataExtracts/userData
accountNumber  bank
creditCard
investment
reward
insurance
loan
string Both The account number as it appears on the site. (The POST accounts service response returns this field as a number)
Additional Details:
  • Bank/ Loan/ Insurance/ Investment: The account number for the bank account as it appears at the site.
  • Credit Card: The account number of the card account as it appears at the site, i.e., the card number.The account number can be full or partial based on how it is displayed on the account summary page of the site. In most cases, the site does not display the full account number on the account summary page, and additional navigation is required to aggregate it. 
GET accounts
GET accounts/{accountId} 
POST accounts
GET dataExtracts/userData
aggregationSource All containers string Both The source through which the account(s) are added in the system.
Valid Values: Account Aggregation Source
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
amountDue  creditCard
loan
insurance
money Both The amount due to be paid for the account.
Additional Details:
  • Credit Card: The total amount due for the purchase of goods or services that must be paid by the due date. 
  • Loan: The amount due to be paid on the due date.
Note: The amount due at the account level can differ from the amount due at the statement level, as the information in the aggregated card account data provides more up-to-date information.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
annuityBalance  insurance
investment
money Both Indicates the contract value of the annuity.
Note: The annuity balance field is applicable only to annuities.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
interestPaidYTD  loan money Aggregated Interest paid from the start of the year to date.  GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
interestPaidLastYear  loan money Aggregated Interest paid in last calendar year.  GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
interestRateType loan string Aggregated The type of interest rate, for example, fixed or variable.
Valid Values: Account Interest Rate Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
collateral loan string Aggregated Property or possession offered to support a loan that can be seized on a default. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
annualPercentageYield bank decimal Aggregated Annual percentage yield (APY) is a normalized representation of an interest rate based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account.   GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
premium  insurance money Aggregated The financial cost that the policyholder pays to the insurance company to obtain insurance coverage. The premium is paid as a lump sum or in installments during the duration of the policy. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
remainingBalance   insurance money Aggregated The sum of the future payments due to be paid to the insurance company during a policy year. It is the policy rate minus the payments made to date.
Note: The remaining balance field applies only to auto and home insurance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
policyEffectiveDate  insurance date Aggregated The date on which the insurance policy coverage commences. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
policyFromDate  insurance date Aggregated The date the insurance policy began. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
policyToDate  insurance date Aggregated The date to which the policy exists. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
deathBenefit  insurance money Aggregated The death benefit amount on a life insurance policy and annuity. It is usually equal to the face amount of the policy but sometimes can vary for whole life and universal life insurance policies.
Note: The death benefit amount field is applicable only to annuities and life insurance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
policyTerm  insurance term Aggregated The duration for which the policy is valid or in effect. For example, one year, five years, etc. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
policyStatus  insurance string Aggregated The status of the policy.
Valid Values: Insurance Policy Status
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
apr  creditCard decimal Aggregated The annual percentage rate (APR) is the yearly rate of interest on the credit card account. 
Additional Details: Uses the same format as the provider site, which can be a fractional or a percentage rate.
The yearly percentage rate charged when a balance is held on a credit card. This interest rate is applied monthly to the outstanding credit card balance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
derivedApr  creditCard decimal Derived Derived APR is calculated based on the credit card transactions and statement level details only for the cards where APR data is not available through aggregation.
Note: Customer has to request for this feature to be enabled in order to access it.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
bankTransferCode bank
investment
entity[] Aggregated Bank and branch identification information. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
isAsset  All containers boolean Both Indicates if the account has to be considered an asset or liability.
Additional Details: The annuity account type under the insurance container and all the life insurance account types except TERM_LIFE_INSURANCE are asset accounts. For the insurance container, isAsset = false does not indicate the account is a liability.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
availableBalance bank money Aggregated The balance in the account that is available for spending. The value is aggregated from the FI site during the last refresh.
Note: For checking accounts with overdraft, the available balance amount may include the overdraft amount if the FI adds the overdraft balance to the available balance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
availableCash  creditCard money Aggregated The amount available for an ATM withdrawal, i.e., the cash available after deducting the amount already withdrawn from the total cash limit. (totalCashLimit-cashAdvance= availableCash)
Additional Details: The available cash amount at the account level can differ from the available cash at the statement level, as the information in the aggregated card account data provides more up-to-date information.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
availableCredit  creditCard
loan
money Aggregated
  • Credit Card: Amount that is available to spend on the credit card. It is usually the Total credit line- Running balance- pending charges.
  • Loan: The unused portion of  line of credit, on a revolving loan (such as a home-equity line of credit).
Note: The available credit amount at the account level can differ from the available credit field at the statement level, as the information in the aggregated card account data provides more up-to-date information.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
balance bank
creditCard
investment
insurance
loan
otherAssets
otherLiabilities,
realEstate
money Both The total account value.
Additional Details:
  • Bank: available balance or current balance.
  • Credit Card: running Balance.
  • Investment: The total value of all assets (cash and/or investment holdings) within the account, as aggregated from the FI site during the last refresh.
  • Insurance: CashValue or amountDue
  • Loan: principalBalance
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
cash investment money Aggregated The amount that is available for immediate withdrawal or the total amount available to purchase securities in a brokerage or investment account.
Note: The cash balance field applies only to brokerage-related accounts.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
cashValue  insurance money Aggregated The amount of cash value available in the consumer's life insurance policy account - except for term insurance policy - for withdrawals, loans, etc. This field is also used to capture the cash value of the home insurance policy. It is the standard that the insurance company generally prefers to reimburse the policyholder for his or her loss, i.e., the cash value is equal to the replacement cost minus depreciation. The cash value is also referred to as surrender value in India for life insurance policies.
Note: The cash value field is applicable to all types of life insurance (except for term life) and home insurance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
classification bank
creditCard
investment
reward
loan
insurance
string Aggregated The classification of the account, such as personal, corporate, etc., as set by the system.
Valid Values: Account Classifications
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
userClassification bank
creditCard
investment
reward
loan
insurance
string Aggregated The classification of the user's account, such as personal or business, as classified by the user.
Valid Values: User Account Classifications
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
container  All containers string Aggregated The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.
Valid Values: Container
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
currentBalance bank money Aggregated The total amount of money in the account aggregated from the FI site during the last refresh. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
dueDate  creditCard
loan
insurance
date Both The date on which the due amount has to be paid.
Additional Details:
  • Credit Card: The monthly date by which the minimum payment is due to be paid on the credit card account.
  • Loan: The date on or before which the due amount should be paid.
Note: The due date at the account level can differ from the due date field at the statement level, as the information in the aggregated card account data provides up-to-date information to the consumer.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
expirationDate  insurance date Aggregated The date on which the insurance policy expires or matures.
Additional Details: The due date at the account level can differ from the due date field at the statement level, as the information in the aggregated card account data provides up-to-date information to the consumer.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
faceAmount  insurance money Aggregated The amount stated on the face of a consumer's policy that will be paid in the event of his or her death or any other event as stated in the insurance policy. The face amount is also referred to as the sum insured or maturity value in India.
Note: The face amount field is applicable only to life insurance.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
id  All containers long Both The primary key of the account resource and the unique identifier for the account. GET accounts
GET accounts/{accountId}
GET investmentOptions
GET accounts/historicalBalances
POST accounts
GET dataExtracts/userData
interestRate  bank
loan
decimal Aggregated
  • Bank: The interest rate offered by a FI to its depositors on a bank account. 
  • Loan: Interest rate applied on the loan.
Additional Details: Uses the same format as the provider site, which can be a fractional or a percentage rate.
Note: The Interest Rate field applies only to the following account types: savings, checking, money market, and certificate of deposit.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lastPaymentAmount  creditCard
loan
insurance
money Aggregated Last/Previous payment amount on the account.  Portion of the principal and interest paid on the previous month or period to satisfy a loan.
Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the payment that was made for any of the previous billing cycles.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lastPaymentDate  creditCard
loan
insurance
date Aggregated The date on which the payment for the previous or current billing cycle is done. 
Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account level can differ from the last payment date at the statement level, as the information in the aggregated card account data provides up-to-date information to the consumer.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lastUpdated  All containers dateTime Both The date time the account information was last retrieved from the provider site and updated in the Yodlee system.  GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
isManual  All containers boolean Both Indicates if an account is aggregated from a site or it is a manual account, i.e., account information manually provided by the user. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
displayedName bank
creditCard
investment
insurance
loan
reward
string Aggregated The name or identification of the account owner, as it appears at the FI site.
Note: The account holder's name can be full or partial based on how it is displayed on the account summary page of the FI site. In most cases, the FI site does not display the full account holder's name on the account summary page.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
marginBalance  investment money Aggregated The amount of borrowed funds used to purchase securities.
Note: Margin balance is displayed only if the brokerage account is approved for margin. The margin balance field applies only to brokerage-related accounts.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
maturityAmount  bank money Aggregated The maturity amount on the CD is the amount(principal and interest) paid on or after the maturity date. 
Additional Details: The Maturity Amount field applies only to the account type CD(Fixed Deposits).
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
maturityDate  bank, loan date Aggregated The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan, at which point the principal amount (including pending interest) is due to be paid.
Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.
The final payment date of a loan, i.e., the principal amount (including pending interest), is due to be paid.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
minimumAmountDue creditCard
insurance
loan
money Aggregated The minimum amount due is the lowest amount of money that a consumer is required to pay each month. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
moneyMarketBalance  investment money Aggregated The amount in the money market fund or its equivalent, such as bank deposit programs.
Note: The money market balance field applies only to brokerage-related accounts.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
nickname All containers string Both The nickname of the account is provided by the consumer to identify an account. The account nickname can be used instead of the account name. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
runningBalance creditCard money Aggregated The amount currently owed on the credit card account. The value is aggregated from the FI site during the last refresh. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
accountStatus  All containers string Both The status of the account that is updated by the consumer through an application or an API.
Valid Values: Account Status
Additional Details:
  • ACTIVE: All the added manual and aggregated account statuses will be made “ACTIVE” by default.
  • TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED
  • INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services
  • CLOSED: Users can update the status as CLOSED if the account is closed with the provider. 
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
totalCashLimit  creditCard money Aggregated The maximum amount that can be withdrawn from an ATM using a credit card. Credit cards issuer allow cardholders to withdraw cash using their cards – the cash limit is a percent of the overall credit limit. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
totalCreditLine  creditCard money Aggregated Total credit line is the amount of money that can be charged to a credit card. If a credit limit of $5,000 is issued on a credit card, the total charges on the card cannot exceed this amount. GET accounts
GET accounts/{accountId}
totalUnvestedBalance investment money Aggregated The total unvested balance that appears in an investment account.Such as the 401k account or the equity award account that includes employer provided funding.
Note: The amount the employer contributes is generally subject to vesting and remains unvested for a specific period of time or until the fulfillment of certain conditions. The total unvested balance field applies only to the retirement-related accounts such as 401k, equity awards, etc.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
totalVestedBalance  investment money Aggregated The total vested balance that appears in an investment account. Such as the 401k account or the equity award account that includes employer-provided funding.
Note: The amount an employee can claim after he or she leaves the organization. The total vested balance field applies only to retirement-related accounts such as 401k, equity awards, etc.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
accountType  All containers string Both The aggregated type of account, such as savings, checking, charge, etc., and manual accounts. The account type is derived based on the attributes of the account.
Valid Values: Aggregated Account Type and Manual Account Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
escrowBalance  loan money Aggregated The amount a mortgage company holds to pay a consumer's non-mortgage-related expenses like insurance and property taxes. 
Note: The escrow balance field applies only to the mortgage account type.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
homeInsuranceType  insurance string Aggregated Type of home insurance, like
1. HOME_OWNER
2. RENTAL
3. RENTER
Valid Values: Home Insurance Account Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lifeInsuranceType  insurance string Aggregated Type of life insurance.
Valid Values: Life Insurance Account Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
originalLoanAmount  loan money Aggregated The amount of loan that the lender has provided. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
providerId  All containers string Both Identifier of the provider site. The primary key of provider resource.  GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
providerName All containers string Both Service provider or institution name where the account originates. This belongs to the provider resource.  GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
principalBalance loan money Aggregated The principal or loan balance is the outstanding balance on a loan account, excluding the interest and fees. The principal balance is the original borrowed amount plus applicable loan fees minus principal payments. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
premiumPaymentTerm insurance term Aggregated The number of years premium payments must be made in a policy. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
recurringPayment loan money Aggregated The monthly or periodic payment on a loan that is recurring in nature. The recurring payment amount is usually the same as the amount due unless late fees or other charges are added, eventually changing the amount due for a particular month. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
term  bank
loan
term Aggregated The tenure for which the CD account is valid  or in case of a loan, the number of years/months over which the loan amount  has to be repaid.
Additional Details: 
  • Bank: The term field applies only to the account type CD.
  • Loan: The period for which the loan agreement is in force. The period before or at the end of which the loan should either be repaid or renegotiated for another term.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
totalCreditLimit loan money Aggregated A financial institution's maximum amount of credit extends to a consumer through a line of credit or a revolving loan like HELOC. 
Note: The credit limit field is applicable only to LOC and HELOC account types.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
enrollmentDate reward date Aggregated Date on which the user is enrolled in the rewards program. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
primaryRewardUnit reward string Aggregated Primary reward unit for this reward program. E.g., miles, points, etc. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
rewardBalance reward entity[] Aggregated Information of different reward balances associated with the account. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
currentLevel reward string Aggregated Current level of the reward program the user is associated with. E.g. Silver, Jade etc. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
nextLevel reward string Aggregated The eligible next level of the rewards program. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
shortBalance investment money Aggregated The sum of the current market values of short positions held in a brokerage account.
Note: The short balance field applies only to brokerage-related accounts.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lastEmployeeContributionAmount investment money Aggregated Indicates the last amount contributed by the employee to the 401k account.
Note: The last employee contribution amount field is derived from the transaction data and not aggregated from the FI site. The field applies only to the 401k account type.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lastEmployeeContributionDate investment date Aggregated The date on which the last employee contribution was made to the 401k account.
Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field applies only to the 401k account type.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
providerAccountId  All containers long Both The primary key of the provider account resource. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
memo All containers string Both The additional description or notes are given by the user. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
originationDate loan date Both The date on which the loan is disbursed. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
createdDate All containers dateTime Both The date on which the account is created in the Yodlee system.
Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
frequency creditCard
insurance
loan
string Both The frequency of the account's billing cycle in the case of cards. The frequency in which premiums are paid in an insurance policy, such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan  account.
Valid Values: Account Frequency
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
overDraftLimit bank money Aggregated The overdraft Limit for the account.
Note: The overdraft Limit is provided only for AUS, INDIA, UK, and NZ locales.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
valuationType realEstate string Both The valuation Type indicates whether the home value is calculated either manually or by Yodlee Partners.
Valid Values: Real Estate Valuation Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
homeValue realEstate money Both The home value of the real estate account. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
estimatedDate realEstate date Both The date on which the home value was estimated. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
address realEstate address Both The home address of the real estate account. The address entity for the home address consists of state, ZIP, and city only GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
includeInNetWorth bank
creditCard
loan
investment
insurance
realEstate
otherAssets
otherLiabilities
boolean Both Used to determine  whether an account is to be considered in the net worth calculation. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
historicalBalances bank
creditCard
investment
insurance
realEstate
loan
entity[] Both Balance details of the accounts at daily, monthly, and weekly levels. GET accounts/historicalBalances
GET derived/networth
loanPayoffAmount loan money Aggregated The amount to be paid to close the loan account, i.e., the total amount required to meet a borrower's obligation on a loan. GET accounts
GET accounts/{accountId}
loanPayByDate loan date Aggregated The date by which the payoff amount should be paid. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
dataset All containers entity[] Aggregated Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile, and Document. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
fullAccountNumber
(Deprecated)
bank, investment, loan string Aggregated Full account number of the account that is included only when include=fullAccountNumber is provided in the request. For student loan accounts, the account number will be used for ACH or fund transfer. GET accounts
GET accounts/{accountId}
fullAccountNumberList bank, investment, loan entity Aggregated Includes payment account number and unmasked account number. The payment account number is used for ACH or funds transfers. The unmasked account number is used to refer to an account; it is not masked or partially displayed. GET accounts
GET accounts/{accountId}
profile bank entity Aggregated Profile information of the account. GET accounts
GET accounts/{accountId}
holder bank
investment
entity[] Aggregated Holder details of the account. GET accounts
GET accounts/{accountId}
associatedProviderAccountId All containers long[] Aggregated The providerAccountIds that share the account with the primary providerAccountId was created when the user added the account for the first time.
Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account ID indicating the account is owned by more than one user, for example, joint accounts.
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
paymentProfile loan entity Aggregated The payment profile attribute contains information such as payment address, payment identifier, etc., that are required to set up a payment. GET accounts
GET accounts/{accountId}
loanPayoffDetails loan entity Aggregated The loan payoff details, such as the date by which the payoff amount should be paid, the loan payoff amount, and the outstanding balance on the loan account. GET accounts
GET accounts/{accountId}
coverage insurance, Investment entity[] Aggregated The coverage-related details of the account. GET accounts
GET accounts/{accountId}
sourceAccountStatus loan string Aggregated Indicates the status of the loan account.
Valid Values: Source Account Status
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
guarantor loan string Aggregated A nonprofit or state organization that works with lenders, servicers, schools, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
lender loan string Aggregated The financial institution that provides the loan. GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
repaymentPlanType loan string Aggregated The type of repayment plan that the borrower prefers to repay the loan.
Valid Values: Loan Repayment Plan Types
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
isDeleted All containers boolean Both Indicates if the account is deleted from the system. GET dataExtracts/userData
autoRefresh All containers entity Both Information about the auto refresh status. GET /accounts
GET /accounts/{accountId}
cashAPR creditCard decimal Aggregated The APR applicable to cash withdrawals on the credit card account.
Additional Details: Uses the same format as the provider site, which can be a fractional or a percentage rate.
GET /accounts
GET /accounts/{accountId}
GET dataExtracts/userData
sourceId All containers string Aggregated The provider site has assigned a unique identifier to the account.
Note: The source is only available for the held accounts.
GET /accounts
GET /accounts/{accountId}
GET dataExtracts/userData
oauthMigrationStatus All containers string Aggregated Indicates the migration status of the account from the credential-based provider to the Open Banking provider.
Valid Values: Migration Status
GET /accounts
GET /accounts/{accountId}
GET dataExtracts/userData

Entity: fullAccountNumberList

Attribute Name Container Type Aggregated/ Manual >Description Endpoints
paymentAccountNumber bank
investment
string Aggregated The payment account number of the account that is included only when include=fullAccountNumberList is provided in the request. This is the payment account number used for payments in all regions. This may be looked at as an ACH account number in US. GET accounts
GET accounts/{accountId}
unmaskedAccountNumber bank
investment
loan
string Aggregated The unmasked account number of the account that is included only when include=fullAccountNumberList is provided in the request. This is the same as the account number that is used to refer to an account and is not partial or masked. In the case of investments, it is the number used for asset transfers. GET accounts
GET accounts/{accountId}

Entity: bankTransferCode

Attribute Name Container Type Aggregated/ Manual Description Endpoints
id bank
investment
string Aggregated The financial institution's branch identification number.
Additional Details: The bank account's routing number is in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom). 
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData
type bank
investment
string Aggregated The bank transfer code type varies depending on the region of the account origination.
Valid Values: Bank Transfer Code Type
GET accounts
GET accounts/{accountId}
GET dataExtracts/userData

Entity: rewardBalance

Attribute Name Container Type Aggregated/ Manual Description Endpoints
description  reward string Aggregated The description for the reward balance is available at the provider source. GET accounts/{accountId}
GET dataExtracts/userData
balance  reward decimal Aggregated The actual reward balance. GET accounts/{accountId}
GET dataExtracts/userData
units  reward string Aggregated Unit of reward balance - miles, points, segments, dollars, credits. GET accounts/{accountId}
GET dataExtracts/userData
balanceType  reward string Aggregated The type of reward balance.
Valid Values: Reward Account Balance Type
GET accounts/{accountId}
GET dataExtracts/userData
expiryDate  reward date Aggregated The date on which the balance expires. GET accounts/{accountId}
GET dataExtracts/userData
balanceToLevel  reward string Aggregated The balance required to reach a reward level. GET accounts/{accountId}
GET dataExtracts/userData
balanceToReward reward string Aggregated The balance required to qualify for a reward such as retaining membership, business reward, etc. GET accounts/{accountId}
GET dataExtracts/userData

Entity: historicalBalances

Attribute Name Container Type Aggregated/ Manual Description Endpoints
date  bank
creditCard
investment
insurance
realEstate
loan
date Both Date for which the account balance was provided.  This balance could be a carryforward, calculated, or scraped balance.
Additional Details:
  • Aggregated: Balance shown in the provider site. This balance gets stored in the Yodlee system during system/user account updates.
  • Carry forward: 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, errors in the site, credential changes, etc.
  • Calculated: Balances that get calculated for the days that are prior to the account added to date.  
GET accounts/historicalBalances
GET derived/networth
asOfDate  bank
creditCard
investment
insurance
realEstate
loan
date Both Date as of when the balance is last updated due to the auto account updates or user-triggered updates. This balance will be carried forward for the days when there is no balance available in the system.  GET accounts/historicalBalances
balance  bank
creditCard
investment
insurance
realEstate
loan
money Both Balance amount of the account. GET accounts/historicalBalances
isAsset  bank
creditCard
investment
insurance
realEstate
loan
boolean Both Indicates whether the balance is an asset or liability. GET accounts/historicalBalances
dataSourceType bank
creditCard
investment
insurance
realEstate
loan
string Both The source of balance information.
Valid Values: Balances Data Source Type
GET accounts/historicalBalances

Entity: dataset

Attribute Name Type Aggregated/ Manual Description Endpoints
name string Aggregated The name of the dataset requested from the provider site
Valid Values: Dataset Name
GET accounts
GET accounts/{accountId}
additionalStatus string Aggregated The status of the last update attempted for the dataset.
Valid Values: Dataset Additional Statuses
GET accounts
GET accounts/{accountId}
updateEligibility string Aggregated Indicate whether the dataset is eligible for update or not.
Valid Values: Update Eligibility Status
GET accounts
GET accounts/{accountId}
lastUpdated dateTime Aggregated Indicate when the dataset is last updated successfully for the given provider account. GET accounts
GET accounts/{accountId}
lastUpdateAttempt dateTime Aggregated Indicate when the last attempt was performed to update the dataset for the given provider account GET accounts
GET accounts/{accountId}
nextUpdateScheduled dateTime Aggregated Indicates when the next attempt to update the dataset is scheduled. GET accounts
GET accounts/{accountId}

Entity: profile

Attribute Name Type Aggregated/ Manual Description Endpoints
address address[] Aggregated Address is available on the profile page of the account. GET accounts
GET accounts/{accountId}
phoneNumber phoneNumber[] Aggregated Phone number available on the profile page of the account. GET accounts
GET accounts/{accountId}
identifier identifier[] Aggregated Identifiers are available on the profile page of the account. GET accounts
GET accounts/{accountId}
email email[] Aggregated Email ID available on the profile page of the account. GET accounts
GET accounts/{accountId}

Entity: holder

Attribute Name Type Aggregated/ Manual Description Endpoints
name name Aggregated Name of the account holder. GET accounts
GET accounts/{accountId}
dateOfBirth date Aggregated Date of birth. GET accounts
GET accounts/{accountId}
identifier identifier Aggregated Identifiers of the account holder. GET accounts
GET accounts/{accountId}
gender string Aggregated Gender of the account holder. GET accounts
GET accounts/{accountId}
ownership string Aggregated Indicates the ownership of the account. GET accounts
GET accounts/{accountId}

Entity: paymentProfile

Attribute Name Container Type Aggregated/ Manual Description Endpoints
address loan address[] Aggregated The address of the lender to which the monthly payments or the loan payoff amount should be paid.
Additional Details: The address field applies only to the student loan account type.
GET accounts
GET accounts/{accountId}
identifier loan identifier Aggregated The additional information, such as platform code or payment reference number that is required to make payments.
Additional Details: The identifier field applies only to the student loan account type.
GET accounts
GET accounts/{accountId}
paymentBankTransferCode loan entity[] Derived The bank and branch identification information associated with the lender.
Additional Details: The paymentBankTransferCode field applies only to the student loan account type.
GET accounts
GET accounts/{accountId}

Entity: identifier

Attribute Name Container Type Aggregated/ Manual Description Endpoints
type loan string Aggregated The type of payment profile identifier, i.e., platform code or payment reference number, that is required to make payments.
Additional Details: The paymentAddress field applies only to the student loan account type.
GET accounts
GET accounts/{accountId}
value loan string Aggregated The value of the payment profile identifier.
Additional Details: The paymentProfileIdentifier field applies only to the student loan account type.
GET accounts
GET accounts/{accountId}

Entity: paymentBankTransferCode

Attribute Name Container Type Aggregated/ Manual Description Endpoints
id loan string Derived The financial institution's branch identification number that is associated with the lender. GET accounts
GET accounts/{accountId}
type loan string Derived The payment bank transfer code type varies based on the region of the account originates from.
Valid Values: Bank Transfer Code Type
GET accounts
GET accounts/{accountId}

Entity: loanPayoffDetails

Attribute Name Container Type Aggregated/ Manual Description Endpoints
payByDate loan date Aggregated The date by which the payoff amount should be paid. GET accounts
GET accounts/{accountId}
payoffAmount loan money Aggregated The loan payoff amount. GET accounts
GET accounts/{accountId}
outstandingBalance loan money Aggregated The outstanding balance on the loan account. The outstanding balance amount may differ from the payoff amount. It is usually the sum of outstanding principal, unpaid interest, and fees, if any. GET accounts
GET accounts/{accountId}

Entity: coverage

Attribute Name Container Type Aggregated/ Manual Description Endpoints
amount insurance
investment
entity[] Aggregated The coverage amount-related details. GET accounts
GET accounts/{accountId}
type insurance
investment
string Aggregated The type of coverage provided to an individual or an entity.
Valid Values: Coverage Type
GET accounts
GET accounts/{accountId}
startDate insurance
investment
date Aggregated The date on which the coverage for the account starts. GET accounts
GET accounts/{accountId}
endDate insurance
investment
date Aggregated The date on which the coverage for the account ends or expires. GET accounts
GET accounts/{accountId}
planType insurance
investment
string Aggregated The plan type of health insurance provided to an individual or an entity.
Valid Values: Plan Type
GET accounts
GET accounts/{accountId}

Entity: amount

Attribute Name Container Type Aggregated/ Manual Description Endpoints
cover insurance
investment
money Aggregated The maximum amount that will be paid to an individual or an entity for a covered loss GET accounts
GET accounts/{accountId}
type insurance
investment
string Aggregated The type of coverage provided to an individual or an entity.
Valid Values: Coverage Amount Types
GET accounts
GET accounts/{accountId}
limitType insurance string Aggregated The type of coverage limit indicates if the coverage is in-network or out-of-network.
Valid Values: Coverage Limit Types
GET accounts
GET accounts/{accountId}
unitType insurance string Aggregated The type of coverage unit indicates if the coverage is for an individual or a family.
Valid Values: Coverage Unit Types
GET accounts
GET accounts/{accountId}
met insurance money Aggregated The amount the insurance company paid for the incurred medical expenses. GET accounts
GET accounts/{accountId}

Entity: autoRefresh

Attribute Name Container Type Aggregated/Manual Description

(* All the fields defined here are w.r.t aggregation. In case of manual accounts, these attributes are provided by the user)

Endpoints
status All containers string Both Indicates whether auto-refresh is enabled or disabled.
Valid Values: Auto Refresh Statuses
GET accounts
GET accounts/{accountId}
additionalStatus All containers string Both Indicates the reason for the status.
Valid Values: Auto Refresh Additional Statuses
GET accounts
GET accounts/{accountId}
asOfDate All containers date Both The date on which the auto-refresh status is determined. GET accounts
GET accounts/{accountId}

Enum: Bank Transfer Code Type

Type Description
BSB BSB is a Bank-State-Branch number used to identify the branch in Australia and is required for performing transfers. 
IFSC IFSC is Indian Financial System Code. It is an alphanumeric code that is used to identify the particular branch in India and is required for electronic funds settlement.
ROUTING_NUMBER Bank routing number or routing transit number (RTN) is a nine-digit number used in the US to identify a financial institution in a transaction. The most common transaction types where routing numbers are used are ACH and wire transfers.
SORT_CODE The sort code is a six-digit number used in the UK to identify both the bank and the branch where the account is held. 

Enum: Home Insurance Account Type

Home Insurance Type Description
HOME_OWNER Homeowner insurance policy for the house.
RENTAL Rental insurance is the insurance taken by the owner for the house when it is being rented out.
RENTER Renters insurance is for occupants who do not own the property but want to protect their personal belongings that are in the home.
OTHER The home insurance policy other than what has been listed here.
UNKNOWN The unknown type of home insurance policy.

Enum: Life Insurance Account Type

Life Insurance Type Description
ENDOWMENT An endowment policy is a life insurance contract designed to pay a lump sum after a specific term (on its 'maturity') or on death.
TERM_LIFE_INSURANCE Term insurance, a type of life insurance, provides coverage for a certain period of time or years. If the insured dies over the policy tenure, a death benefit (or sum assured) is paid out. No payout is made if the insured survives the tenure.
ULIP ULIP is a life insurance product that provides risk cover for the policyholder along with investment options to invest in any number of qualified investments, such as stocks, bonds, or mutual funds.
UNIVERSAL_LIFE_INSURANCE Universal life insurance (often shortened to UL) is a type of cash-value life insurance sold primarily in the United States of America. Under the terms of the policy, the excess premium payments above the current cost of insurance are credited to the policy's cash value.
VARIABLE_LIFE_INSURANCE Variable life insurance is a permanent life insurance policy with an investment component.
WHOLE_LIFE_INSURANCE Life insurance policy which is guaranteed to remain in force for the insured's entire lifetime, provided required premiums are paid, or to the maturity date.
OTHER Other type of insurances.

Enum: Insurance Policy Status

Policy Status Description
ACTIVE Denotes the policy is active.
IN_ACTIVE Denotes the policy is inactive.
OTHER The status could not be determined, or it is other than active/inactive.

Enum: Real Estate Valuation Type

Valuation Type Description
SYSTEM Home value provided by the system.
MANUAL Home value manually provided by the user.

Enum: Reward Account Balance Type

Balance Type Description
BALANCE Reward Balance.
BALANCE_TO_LEVEL The balance required to reach a reward level.
BALANCE_TO_REWARD The balance required to qualify for a reward.
EXPIRING_BALANCE Reward Balance that will be expired.
TOTAL_BALANCE Total reward balance available.

Enum: Account Frequency

Frequency Description
DAILY Occurs every day.
ONE_TIME Occurs once.
WEEKLY Occurs once a week.
EVERY_2_WEEKS Occurs once in two weeks.
SEMI_MONTHLY Occurs once in 15 days.
MONTHLY Occurs once a month.
QUARTERLY Occurs once in three months.
SEMI_ANNUALLY Occurs once in six months.
ANNUALLY Occurs once a year.
EVERY_2_MONTHS Occurs once in two months.
FIRST_DAY_MONTHLY Occurs on the first day of every month.
LAST_DAY_MONTHLY Occurs on the last day of every month.
EVERY_4_WEEKS Occurs once in four weeks.

Enum: Account Interest Rate Type

Interest Rate Type Description
UNKNOWN Unknown
OTHER Other
FIXED Fixed interest rate.
VARIABLE Variable interest rate.

Enum: Account Aggregation Source

Aggregation Source Description
SYSTEM Accounts that are pre-populated by the customers on behalf of their users in the Yodlee system.
USER Accounts that are added by the user.

Enum: Account Classification

Account Classification Description
CORPORATE  Corporate account.
OTHER  Other account.
PERSONAL  Personal account.
SMALL_BUSINESS  Small business account.
TRUST Trust account.
VIRTUAL_CARD Virtual card account.
ADD_ON_CARD Add on card account.

Enum: User Account Classification

User Classification Description
PERSONAL Indicates a personal account.
BUSINESS Indicates a small business account.

Enum: Container

Container Applicable for Aggregated/Manual Accounts?
bank  Both
creditCard Both
investment Both
insurance Both
loan Both
otherAssets Manual
otherLiabilities Manual
realEstate Both
reward Both

Enum: Account Status

Account Status Description
ACTIVE Active accounts.
INACTIVE Accounts that are made inactive by the users.
TO_BE_CLOSED Accounts that are found to be closed in the provider site and awaiting confirmation from users to get closed.
CLOSED Accounts that are closed by the users.
DELETED Accounts that are deleted by the user.
Note: Applies only to the GET dataExtracts/userData endpoint.

Enum: Balances Data Source Type

Data Source Type Description
S Scraped balance from the provider site.
Calculated balance by the system.
CF Last available balance that was carried forward for the days when the account was not updated.

Enum: Aggregated Account Type

Applicable Containers Account Type
bank CHECKING
Note: For the UK and Australia region, CHECKING indicates the current account type.
SAVINGS
CD
PPF
RECURRING_DEPOSIT
FSA
MONEY_MARKET
IRA
PREPAID
COMMUTER
OTHER
creditCard CREDIT
STORE
CHARGE
OTHER
investment BROKERAGE_CASH
BROKERAGE_MARGIN
INDIVIDUAL_RETIREMENT_ACCOUNT_IRA
EMPLOYEE_RETIREMENT_ACCOUNT_401K
EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B
TRUST
ANNUITY
SIMPLE_IRA
CUSTODIAL_ACCOUNT
BROKERAGE_CASH_OPTION
BROKERAGE_MARGIN_OPTION
INDIVIDUAL
CORPORATE_INVESTMENT_ACCOUNT
JOINT_TENANTS_TENANCY_IN_COMMON_JTIC
JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS
JOINT_TENANTS_COMMUNITY_PROPERTY
JOINT_TENANTS_TENANTS_BY_ENTIRETY
CONSERVATOR
ROTH_IRA
ROTH_CONVERSION 
ROLLOVER_IRA
EDUCATIONAL
EDUCATIONAL_SAVINGS_PLAN_529
DEFERRED_COMPENSATION_PLAN_457
MONEY_PURCHASE_RETIREMENT_PLAN_401A
PROFIT_SHARING_PLAN
MONEY_PURCHASE_PLAN
STOCK_BASKET_ACCOUNT
LIVING_TRUST
REVOCABLE_TRUST
IRREVOCABLE_TRUST
CHARITABLE_REMAINDER_TRUST
CHARITABLE_LEAD_TRUST
CHARITABLE_GIFT_ACCOUNT
SEP_IRA
UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA
UNIFORM_GIFT_TO_MINORS_ACT_UGMA
EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP
ADMINISTRATOR 
EXECUTOR
PARTNERSHIP
PROPRIETORSHIP
CHURCH_ACCOUNT
INVESTMENT_CLUB
RESTRICTED_STOCK_AWARD
CASH_MANAGEMENT_ACCOUNT
EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP
PERFORMANCE_PLAN
BROKERAGE_LINK_ACCOUNT
MONEY_MARKET_ACCOUNT
SUPERANNUATION
REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP
SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP
DEFERRED_PROFIT_SHARING_PLAN_DPSP
NON_REGISTERED_SAVINGS_PLAN_NRSP
REGISTERED_EDUCATION_SAVINGS_PLAN_RESP
GROUP_RETIREMENT_SAVINGS_PLAN_GRSP
LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP
RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP
LOCKED_IN_RETIREMENT_ACCOUNT_LIRA
REGISTERED_PENSION_PLAN_RPP
TAX_FREE_SAVINGS_ACCOUNT_TFSA
LIFE_INCOME_FUND_LIF
REGISTERED_RETIREMENT_INCOME_FUND_RIF
SPOUSAL_RETIREMENT_INCOME_FUND_SRIF
LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF
PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF
GUARANTEED_INVESTMENT_CERTIFICATES_GIC
REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP
DEFINED_CONTRIBUTION_PLAN 
DEFINED_BENEFIT_PLAN
EMPLOYEE_STOCK_OPTION_PLAN 
NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A
KEOGH_PLAN
EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K
DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP
EMPLOYEE_BENEFIT_PLAN
EMPLOYEE_SAVINGS_PLAN
HEALTH_SAVINGS_ACCOUNT_HSA
COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA
TESTAMENTARY_TRUST
ESTATE 
GRANTOR_RETAINED_ANNUITY_TRUST_GRAT
ADVISORY_ACCOUNT
NON_PROFIT_ORGANIZATION_501C
HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA
INDIVIDUAL_SAVINGS_ACCOUNT_ISA
CASH_ISA
STOCKS_AND_SHARES_ISA
INNOVATIVE_FINANCE_ISA
JUNIOR_ISA
EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO
PUBLIC_PROVIDENT_FUND_PPF
EMPLOYEES_PENSION_SCHEME_EPS
NATIONAL_PENSION_SYSTEM_NPS
INDEXED_ANNUITY
ANNUITIZED_ANNUITY
VARIABLE_ANNUITY
ROTH_403B
SPOUSAL_IRA
SPOUSAL_ROTH_IRA
SARSEP_IRA
SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP
OFFSHORE_TRUST
IRREVOCABLE_LIFE_INSURANCE_TRUST
INTERNATIONAL_TRUST
LIFE_INTEREST_TRUST
EMPLOYEE_BENEFIT_TRUST
PRECIOUS_METAL_ACCOUNT
INVESTMENT_LOAN_ACCOUNT
GRANTOR_RETAINED_INCOME_TRUST
PENSION_PLAN
OTHER
loan MORTGAGE
INSTALLMENT_LOAN
PERSONAL_LOAN
HOME_EQUITY_LINE_OF_CREDIT
LINE_OF_CREDIT
AUTO_LOAN
STUDENT_LOAN
HOME_LOAN
SECURITIES_BACKED_LINE_OF_CREDIT
Note: Contact Yodlee Client Services to use the account type in the US region.
OTHER
insurance AUTO_INSURANCE
HEALTH_INSURANCE
HOME_INSURANCE
LIFE_INSURANCE
ANNUITY
TRAVEL_INSURANCE
INSURANCE
realEstate REAL_ESTATE
reward REWARD_POINTS

Enum: Manual Account Type

Applicable Containers Account Type
bank CHECKING
SAVINGS
CD
PREPAID
creditCard CREDIT
loan PERSONAL_LOAN
HOME_LOAN
insurance INSURANCE
investment ANNUITY
BROKERAGE_CASH
otherAssets OTHER_ASSETS
otherLiabilities OTHER_LIABILITIES

Enum: Dataset Additional Statuses

Status Description Next Action
LOGIN_IN_PROGRESS Login to provider site is in progress Not applicable as it is not a final status.
DATA_RETRIEVAL_IN_PROGRESS Data aggregation is in progress.  Not applicable as it is not a final status.
ACCT_SUMMARY_RECEIVED Basic account data is retrieved.  Not applicable as it is not a final status.
AVAILABLE_DATA_RETRIEVED All the data available at the provider site is retrieved for the provided dataset. Not applicable.
PARTIAL_DATA_RETRIEVED Partial data is retrieved for the dataset. Instruct the user to try again if the mandatory data is missing. If the request fails repeatedly, report the issue to Yodlee Client Services.
DATA_RETRIEVAL_FAILED Failed to retrieve the data due to unexpected issues. Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
DATA_NOT_AVAILABLE The requested data or document is not available at the provider site.  Instruct the user to check with the respective data provider or provider site. 
ACCOUNT_LOCKED The account is locked at the provider site. The user has exceeded the maximum number of incorrect login attempts resulting in the account getting locked. Instruct the user to visit the provider site and take necessary actions to unlock the account.  
ADDL_AUTHENTICATION_REQUIRED Additional MFA information is needed at the provider site, or to download the document, additional verification is required. Instruct the user to provide the required additional MFA information or verification.
BETA_SITE_DEV_IN_PROGRESS The site for which the data is requested is in the development or beta stage.  Instruct the user to try again later or disable the beta sites. 
CREDENTIALS_UPDATE_NEEDED Unable to log in to the provider site due to outdated credentials. The site may be prompting the user to change or verify the credentials.   Instruct the user to visit the provider site, perform the required actions, and invoke the edit account flow to update the credentials in the Yodlee system.  
INCORRECT_CREDENTIALS Unable to log in to the provider site due to incorrect credentials. The credentials that the user has provided are incorrect.   Instruct the user to provide the correct credentials by invoking the edit account flow. 
PROPERTY_VALUE_NOT_AVAILABLE The property value is not available. Instruct the user to provide the property value.
INVALID_ADDL_INFO_PROVIDED The user has provided incorrect MFA information, or the MFA information provided has expired.  Instruct the user to provide the correct MFA information. 
REQUEST_TIME_OUT The request has timed out due to technical reasons. Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
SITE_BLOCKING_ERROR The Yodlee IP is blocked by the provider site. Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
UNEXPECTED_SITE_ERROR All errors indicating issues at the provider site, such as the site being down for maintenance. Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
SITE_NOT_SUPPORTED Indicates that the site does not support the requested data or support is not available to complete the requested action. For example, the site is not available, document download is not supported at the site, etc. Inform the user about the latest available status. 
SITE_UNAVAILABLE The provider site is unavailable due to issues such as the site being down for maintenance. Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
TECH_ERROR Indicates there is a technical error.  Instruct the user to try again later. If the request fails repeatedly, report the issue to Yodlee Client Services.
USER_ACTION_NEEDED_AT_SITE The errors that require users to take action at the provider site, for example, accept T&C, etc. Instruct the user to visit the provider site and perform the necessary action.
SITE_SESSION_INVALIDATED Indicates if multiple sessions or a session is terminated by the provider site. Instruct the user to try again later.
NEW_AUTHENTICATION_REQUIRED The site has requested for OAuth authentication. The OAUTH based authentication sites can be added or updated only using Yodlee FastLink and not Yodlee APIs. Instruct the user to add the account using FastLink.
DATASET_NOT_SUPPORTED The requested datasets are not supported. Either get the dataset/attribute enabled or remove the dataset/attribute from the input.
ENROLLMENT_REQUIRED_FOR_DATASET The dataset cannot be retrieved as the user has not enrolled for it. Instruct the user to enroll for the dataset and then request it.
CONSENT_REQUIRED Consent is required as the account information is migrated from the credential-based provider to the Open Banking provider site. Invoke the edit account flow and instruct the user to provide consent to access the account information.
CONSENT_EXPIRED The consent provided by the user to access the account information through Open Banking has expired. Invoke the edit account flow and instruct the user to provide consent to access the account information.
CONSENT_REVOKED The user has revoked the consent to access the account information through Open Banking. Invoke the edit account flow and instruct the user to provide consent to access the account information.
INCORRECT_OAUTH_TOKEN Failed to log in to the Open Banking provider site due to an incorrect token. Invoke the edit account flow and instruct the user to provide consent to access the account information.
MIGRATION_IN_PROGRESS The account information is being migrated from the credential-based provider to the Open Banking provider site. Not applicable, as it is not a final status.

Enum: Ownership Classification

Ownership Classification Description
PRIMARY The account holder is the primary holder of the account.
SECONDARY The account holder is a secondary holder of the account.
CUSTODIAN The account holder is a custodian of the account.
POWER_OF_ATTORNEY The account holder has a power of attorney authorizing him or her to access the account.
TRUSTEE The account holder is a trustee that controls funds for the benefit of another party – an individual, or a group.
JOINT_OWNER The account holder has joint ownership of the account.
BENEFICIARY The account holder is a beneficiary of the account. The beneficiary has no control or ownership of the account while the account owner is alive but is designated by the account owner to own the account upon the owner’s death.
AAS Indicates that the account holder is an authorized account signatory (AAS).
BUSINESS Indicates that the account holder is a business.
DBA Indicates that the account holder is a business using a different name, i.e., doing business as (DBA).
TRUST Indicates that the account holder is a trust.
OTHERS An account ownership other than what has been listed here.

Enum: Update Eligibility Status

Status Description
ALLOW_UPDATE This status indicates that the account is eligible for the next update.
ALLOW_UPDATE_WITH_CREDENTIALS The status indicates updating or refreshing the account by directing the user to edit the provided credentials.
DISALLOW_UPDATE The status indicates the account is not eligible for the update or refresh process due to a site issue or a technical error.

Enum: Dataset Name

Name Description
BASIC_AGG_DATA Indicates basic aggregation data like accounts, transactions, etc.
ADVANCE_AGG_DATA Indicates advanced aggregation data like interest details, payment details, and coverage.
ACCT_PROFILE Indicates account profile data like full account number, routing number, etc.
DOCUMENT Indicates document data like bank statements, tax documents, etc.

Enum: Source Account Status

Status Description
IN_REPAYMENT The borrower is currently repaying the student loan.
DEFAULTED The borrower has failed to repay the loan according to the terms of the promissory note.
FORBEARANCE The borrower is currently experiencing financial hardship and does not need to repay the student loan for the time being.
IN_SCHOOL Indicates the borrower is still in school.
IN_GRACE_PERIOD The specified period (usually six months) between the date the student graduates or drops below half-time status and the date the loan repayment begins.
DELINQUENCY The borrower has failed to make loan repayments when due. Delinquency begins with the first missed loan repayment.
DEFERMENT A period when the student postpones the loan repayments.

Enum: Loan Repayment Plan Types

Plan Type Description
STANDARD_REPAYMENT A 10-year payment plan where the borrower makes the same fixed payments every month.
GRADUATED_REPAYMENT A 10-year payment plan where the monthly payments start small and increase every two years.
EXTENDED_REPAYMENT A payment plan with low monthly payments and an extended repayment term of up to 25 years. The borrower can either choose fixed monthly payments or graduated payments that increase over time.
INCOME_BASED A payment plan with low monthly payments (caps at 10% or 15% based on the loan disbursement date) to help borrowers make student loan debt manageable. This plan calculates the monthly payment amount based on family size.
INCOME_CONTINGENT A payment plan designed to make repaying education loans easier is for students who intend to pursue jobs with lower salaries. This plan calculates the monthly loan repayment amount based on the income and size of the family.
INCOME_SENSITIVE A payment plan available only for federal student loans in the Federal Family Education Loan (FFEL) program. The monthly loan payment is set at a fixed percentage of gross monthly income, ranging between 4% and 25%.
PAY_AS_YOU_EARN A 20-year payment plan, the monthly payments are based on income. The payment amount can be lower than the INCOME_BASED loan.
REVISED_PAY_AS_YOU_EARN A payment plan that is similar to the PAY_AS_YOU_EARN payment plan but applies to loans that do not qualify for an income-driven repayment plan. The payment duration varies between 20 to 25 years, based on the number of graduate loans.

Enum: Coverage Type

Coverage Type Description
VISION A type of coverage under health insurance that covers some or all costs of routine vision care.
DENTAL A type of coverage under health insurance that covers some or all costs of routine dental care.
HEALTH A type of coverage under health insurance that covers some or all costs of health care.
DEATH_COVER A type of coverage that applies only to superannuation funds and life insurance and provides death benefits as part of the coverage.
TOTAL_PERMANENT_DISABILITY A type of coverage that applies only to superannuation fund and life insurance accounts and provides disability benefits as part of the coverage.
ACCIDENTAL_DEATH_COVER A type of coverage that applies only to life insurance accounts and provides accidental death benefits as part of the coverage.
INCOME_PROTECTION A type of coverage provided to the superannuation fund's owner. The income protection cover is available up to a percentage of the monthly income to provide an affordable level of financial protection in the event of sickness or injury.
DEATH_TOTAL_PERMANENT_DISABILITY A type of coverage provided as part of the superannuation fund. This coverage includes the benefits of both disability and death.

Enum: Coverage Amount Types

Amount Type Description
DEDUCTIBLE The amount paid for covered health care services before the health insurance plan starts paying.
OUT_OF_POCKET The maximum amount the insurer has to pay for covered health care services in a plan year.
ANNUAL_BENEFIT A cap on the benefits the insurance company will pay in a year while the insurer is enrolled in a particular health insurance plan.
MAX_BENEFIT The maximum amount the insurance company pays for nonessential healthcare services.
COVERAGE_AMOUNT The maximum amount payable in the event of a claim by the policyholder.
MONTHLY_BENEFIT As part of the income protection cover, the monthly amount is provided as financial support in the event of sickness or injury.
OTHER Any coverage type other than what has been listed here.

Enum: Coverage Limit Types

Limit Type Description
IN_NETWORK Indicates the doctor or facility providing the health care services has negotiated a contracted rate with the health insurance company.
OUT_NETWORK Indicates the doctor or facility providing health care services has no contract with the health insurance company.

Enum: Coverage Unit Types

Unit Type Description
PER_FAMILY Indicates the health insurance coverage is for the complete family.
PER_MEMBER Indicates the health insurance coverage is for an individual.

Enum: Health Insurance Plan Type

Plan Type Description
PPO The preferred provider organization (PPO) health insurance plan type allows the participant to utilize the services of any provider within their network.
HMO The health maintenance organization (HMO) health insurance plan type that allows the participant to receive medical services only from an assigned provider

Enum: Auto Refresh Statuses

Status Description
ENABLED Auto refresh is enabled.
DISABLED Auto refresh is disabled.

Enum: Auto Refresh Additional Statuses

Status Description
SCHEDULED Auto refresh is scheduled.
TEMP_ERROR Auto refresh is temporarily disabled due to the site or technical issues.
SITE_BLOCKING Auto refresh is disabled due to site blocking.
SITE_NOT_SUPPORTED Auto refresh is disabled because the site no longer supports updates.
REAL_TIME_MFA_REQUIRED Auto refresh is disabled because the site requires real-time MFA information to get account updates.
USER_ACTION_REQUIRED Auto refresh is disabled as the user needs to take action at the site or update the credentials or answers for security questions.
UNSUBSCRIBED Auto refresh is disabled because:
  • The customer has unsubscribed to auto-refreshes.
  • Yodlee has disabled auto-refreshes for the customer due to the site or technical issues.
  • Auto refresh is no longer subscribed at the provider account level.
  • The site has been disabled for auto-refreshes.
  • The account is inactive or closed.
MANUAL_ACCOUNT Auto refresh is disabled because the account is a manual account.

Enums: Migration Status

Migration Status Description
TO_BE_MIGRATED Eligible and yet to be migrated to the Open Banking provider.
IN_PROGRESS Migration to the Open Banking provider is in progress.
COMPLETED Successfully migrated to the Open Banking provider.