Accounts Resource
This page refers to Yodlee API v1.0. The latest API version's data model documentation is available here.
Entity: account
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 |
---|---|---|---|---|---|
401kLoan | investment | money | Aggregated | The amount borrowed from the 401k account. Note: The 401k loan field is only applicable to the 401k account type. |
GET accounts/{accountId} |
accountName | All containers | string | Both | The account name as it appears at the site. (The POST accounts service response return this field as name) | GET accounts GET accounts/{accountId} POST accounts |
accountNumber | All containers | string | Both | The account number as it appears on the site. (The POST accounts service response return this field as number) Additional Details: Bank/ Loan/ Insurance/ Investment/ Bill: 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 in the account summary page of the site. In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it. |
GET accounts GET accounts/{accountId} POST accounts |
associatedProviderAccountId | bank, investment |
long[] | Aggregated | This field consists of provider account ids other than the base provider account id which was created while the user added the account first time. This attribute comes in the response only if the de-duplication feature is on and the same account is mapped to one or more provider account ids. This means the account is owned by more than one user. E.g. Joint Accounts. | GET accounts GET accounts/{accountId} |
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} |
amountDue | creditCard loan insurance bill |
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} |
annuityBalance | insurance investment |
money | Both | Indicates the contract value of the annuity. Note: The annuity balance field is applicable only to annuities. |
GET accounts/{accountId} |
interestPaidYTD | loan | money | Aggregated | Interest paid from the start of the year to date. | GET accounts GET accounts/{accountId} |
interestPaidLastYear | loan | money | Aggregated | Interest paid in last calendar year. | GET accounts GET accounts/{accountId} |
interestRateType | loan | string | Aggregated | The type of the interest rate, for example, fixed or variable.
Valid Values: Account Interest Rate Type
|
GET accounts GET accounts/{accountId} |
collateral | loan | string | Aggregated | Property or possession offered to support a loan that can be seized on a default. | GET accounts GET accounts/{accountId} |
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} |
premium | insurance | money | Aggregated | The financial cost that the policyholder pays to the insurance company to obtain an insurance cover. The premium is paid as a lump sum or in installments during the duration of the policy. | GET accounts GET accounts/{accountId} |
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 till date. Note: The remaining balance field is applicable only to auto insurance and home insurance. |
GET accounts GET accounts/{accountId} |
policyEffectiveDate | insurance | date | Aggregated | The date on which the insurance policy coverage commences. | GET accounts GET accounts/{accountId} |
policyFromDate | insurance | date | Aggregated | The date the insurance policy began. | GET accounts GET accounts/{accountId} |
policyToDate | insurance | date | Aggregated | The date to which the policy exists. | GET accounts GET accounts/{accountId} |
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 a 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} |
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} |
policyStatus | insurance | string | Aggregated | The status of the policy.
Valid Values: Insurance Policy Status
|
GET accounts GET accounts/{accountId} |
apr | creditCard | decimal | Aggregated | The annual percentage rate (APR) is the yearly rate of interest on the credit card account. Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance. |
GET accounts/{accountId} |
bankTransferCode | bank | entity[] | Aggregated | Bank and branch identification information. | GET accounts GET accounts/{accountId} |
isAsset | All containers | boolean | Both | Indicates if the account has to be considered as 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} |
availableBalance | Bank | money | Aggregated | The balance in the account that is available for spending. For checking accounts with overdraft, available balance may include overdraft amount, if end site adds overdraft balance to available balance. | GET accounts GET accounts/{accountId} |
availableCash | creditCard | money | Aggregated | The amount that is available for an ATM withdrawal, i.e., the cash available after deducting the amount that is already withdrawn from the total cash limit. 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} |
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). Additional Details: 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} |
availableLoan | investment | money | Aggregated | The cash available to withdraw from the account, including all margin loans that may be available. | GET accounts/{accountId} |
balance | bank creditCard investment insurance loan bill |
money | Both | The total account value. Additional Details: Bank: available balance or current balance. Credit Card: running Balance. Investment: The total balance of all the investment account, as it appears on the FI site. Insurance: CashValue or amountDue Loan: principalBalance Bill: amountDue |
GET accounts GET accounts/{accountId} |
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 is only applicable to brokerage related accounts. |
GET accounts GET accounts/{accountId} |
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 on the home insurance policy.It is the standard that the insurance company generally prefer 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} |
classification | bank creditCard investment reward loan insurance |
string | Aggregated | The classification of the account such as personal, corporate, etc.
Valid Values: Account Classification
|
GET accounts/{accountId} |
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} |
currentBalance | bank | money | Aggregated | The balance in the account that is available at the beginning of the business day; it is equal to the ledger balance of the account. | GET accounts GET accounts/{accountId} |
dueDate | creditCard loan insurance bill |
date | Both | The date on which the due amount has to be paid. Additional Details: Credit Card: The monthly date by when 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 an up-to-date information to the consumer. |
GET accounts GET accounts/{accountId} |
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 an up-to-date information to the consumer. |
GET accounts/{accountId} |
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/{accountId} |
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 |
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: Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit. |
GET accounts GET accounts/{accountId} |
lastPayment | bill | money | Aggregated | The last payment made for the account. | GET accounts/{accountId} |
lastPaymentAmount | creditCard loan insurance bill |
money | Aggregated | Last/Previous payment amount on the account. Portion of the principal and interest paid on 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/{accountId} |
lastPaymentDate | creditCard loan insurance bill |
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 an up-to-date information to the consumer. |
GET accounts/{accountId} |
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} |
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} |
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 is only applicable to brokerage related accounts. |
GET accounts GET accounts/{accountId} |
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 is only applicable for the account type CD(Fixed Deposits). |
GET accounts/{accountId} |
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} |
minimumAmountDue | creditCard insurance bill loan |
money | Aggregated | The minimum amount due is the lowest amount of money that a consumer is required to pay on the credit card each month. | GET accounts GET accounts/{accountId} |
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 is only applicable to brokerage related accounts. |
GET accounts/{accountId} |
nickname | All containers | string | Both | The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name. | GET accounts GET accounts/{accountId} |
refreshinfo | All containers | entity | Aggregated | The status and details on the last update/add action attempted for the account. | GET accounts GET accounts/{accountId} |
runningBalance | creditCard | money | Aggregated | The amount that is currently owed on the credit card account. | GET accounts/{accountId} |
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 accounts status 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} |
totalCashLimit | creditCard | money | Aggregated | The maximum amount that can be withdrawn from an ATM using the 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} |
totalCreditLine | creditCard | money | Aggregated | Total credit line is the amount of money that can be charged to a credit card. If 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. | GET accounts/{accountId} |
totalVestedBalance | investment | money | Aggregated | The total vested balance that appears in an investment account. | GET accounts/{accountId} |
accountType | All containers | string | Both | The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account.
Valid Values: Account Type
|
GET accounts GET accounts/{accountId} |
escrowBalance | loan | money | Aggregated | The amount a mortgage company holds to pay a consumer's non-mortgage related expenses like insurance and property taxes. Additional Details: Note: The escrow balance field is only applicable to the mortgage account type. |
GET accounts/{accountId} |
homeInsuranceType | insurance | string | Aggregated | Type of home insurance.
Valid Values: Home Insurance Account Type
|
GET accounts/{accountId} |
lifeInsuranceType | insurance | string | Aggregated | Type of life insurance.
Valid Values: Life Insurance Account Type
|
GET accounts/{accountId} |
originalLoanAmount | loan | money | Aggregated | The amount of loan that the lender has provided. | GET accounts GET accounts/{accountId} |
providerId | All containers | string | Both | Identifier of the provider site. The primary key of provider resource. | GET accounts GET accounts/{accountId} |
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} |
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 any applicable loan fees, minus any principal payments. | GET accounts/{accountId} |
premiumPaymentTerm | insurance | term | Aggregated | The number of years for which premium payments have to be made in a policy. | GET accounts GET accounts/{accountId} |
recurringPayment | loan | money | Aggregated | The monthly or periodic payment on a loan that is recurring in nature. The recurring payment amount is usually same as the amount due, unless late fees or other charges are added eventually changing the amount due for a particular month. | GET accounts/{accountId} |
term | bank loan |
term | Aggregated | The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid. Additional Details: Bank: The Term field is only applicable for 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} |
totalCreditLimit | loan | money | Aggregated | The maximum amount of credit a financial institution extends to a consumer through a line of credit or a revolving loan like HELOC. Additional Details: Note: The credit limit field is applicable only to LOC and HELOC account types. |
GET accounts/{accountId} |
enrollmentDate | reward | date | Aggregated | Date on which the user is enrolled on the rewards program. | GET accounts/{accountId} |
primaryRewardUnit | reward | string | Aggregated | Primary reward unit for this reward program. E.g. miles, points, etc. | GET accounts GET accounts/{accountId} |
rewardBalance | reward | entity[] | Aggregated | Information of different reward balances associated with the account. | GET accounts/{accountId} |
currentLevel | reward | string | Aggregated | Current level of the reward program the user is associated with. E.g. Silver, Jade etc. | GET accounts/{accountId} |
nextLevel | reward | string | Aggregated | The eligible next level of the rewards program. | GET accounts/{accountId} |
shortBalance | investment | money | Aggregated | The sum of the current market values of short positions held in a brokerage account. Note: The short balance balance field is only applicable to brokerage related accounts. |
GET accounts/{accountId} |
holderProfile | bank creditCard loan investment insurance bill reward |
entity[] | Aggregated | Profile information about holder. | GET accounts GET accounts/{accountId} |
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 is only applicable to the 401k account type. |
GET accounts/{accountId} |
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 is only applicable to the 401k account type. |
GET accounts/{accountId} |
providerAccountId | All containers | long | Both | The primary key of the provider account resource. | GET accounts GET accounts/{accountId} |
memo | bank creditCard insurance loan bill investment otherAssets otherLiabilities |
string | Both | The additional description or notes given by the user. | GET accounts GET accounts/{accountId} |
originationDate | loan | date | Both | The date on which the loan is disbursed. | GET accounts GET accounts/{accountId} |
createdDate | bank creditCard insurance loan bill investment otherAssets otherLiabilities reward |
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} |
frequency | bill creditCard insurance loan |
string | Both | The frequency of the billing cycle of the account in case of card and bills. 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} |
overDraftLimit | bank | money | Aggregated | The overdraft Limit for the account. Note: The overdraft Limit is provided only for AUS, INDIA, UK, NZ locales. |
GET accounts GET accounts/{accountId} |
valuationType | realEstate | string | Manual | 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} |
homeValue | realEstate | money | Manual | The home value of the real estate account. | GET accounts GET accounts/{accountId} |
estimatedDate | realEstate | date | Manual | The date on which the home value was estimated. | GET accounts GET accounts/{accountId} |
address | realEstate | address | Manual | The home address of the real estate account. The address entity for home address consists of street, state, zip and city only. | GET accounts GET accounts/{accountId} |
includeInNetWorth | bank creditCard loan investment insurance realEstate otherAssets otherLiabilities |
boolean | Aggregated | Used to determine whether an account to be considered in the networth calculation. | GET accounts GET accounts/{accountId} |
investmentPlan | investment | entity[] | Aggregated | Investment Plan information. Required Feature Enablement: investment Options. |
GET investmentOptions |
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 |
cashAPR | creditCard | decimal | Aggregated | The APR applicable to cash withdrawals on the credit card account. | GET accounts GET accounts/{accountId} |
Entity: refreshinfo
Attribute Name | Container | Type | Aggregated/ Manual | Description | Endpoints |
---|---|---|---|---|---|
statusCode | All containers | Integer | Aggregated | The status code of last update attempted for the account.
Valid Values: Refresh Status Code and Message
|
GET accounts GET accounts/{accountId} |
statusMessage | All containers | string | Aggregated | The status message of last update attempted for the account.
Valid Values: Refresh Status Code and Message
|
GET accounts GET accounts/{accountId} |
nextRefreshScheduled | All containers | dateTime | Aggregated | The scheduled next update time. | GET accounts GET accounts/{accountId} |
lastRefreshed | All containers | dateTime | Aggregated | Time when the account was last updated successfully. | GET accounts GET accounts/{accountId} |
lastRefreshAttempt | All containers | dateTime | Aggregated | Time when the update was last attempted for the account irrespective of failure or success. Note: This differs from the lastRefreshed field, as lastRefreshed indicates the successful update time. |
GET accounts GET accounts/{accountId} |
Entity: bankTransferCode
Attribute Name | Container | Type | Aggregated/ Manual | Description | Endpoints |
---|---|---|---|---|---|
id | bank | string | Aggregated | 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). |
GET accounts/{accountId} |
type | bank | string | Aggregated | The bank transfer code type varies depending on the region of the account origination.
Valid Values: Bank Transfer Code Type
|
GET accounts/{accountId} |
Entity: holderProfile
Entity: investmentPlan
Attribute Name | Container | Type | Aggregated/ Manual | Description | Endpoints |
---|---|---|---|---|---|
id | investment | long | Aggregated | The unique identifier of the investment plan resource. Required Feature Enablement: investment Options |
GET investmentOptions |
planName | investment | string | Aggregated | The name given to a plan by the sponsor. Required Feature Enablement: investment Options. |
GET investmentOptions |
planNumber | investment | string | Aggregated | The plan number given to a plan by the sponsor. Required Feature Enablement: investment Options. |
GET investmentOptions |
providerId | investment | string | Aggregated | The id of the provider resource. Provider is the one who manages the 401k accounts for the sponsors. Required Feature Enablement: investment Options. |
GET investmentOptions |
providerName | investment | string | Aggregated | The name of the provider. Provider is the one who manages the 401k accounts for the sponsors. Required Feature Enablement: investment Options. |
GET investmentOptions |
asOfDate | investment | date | Aggregated | The date as of when the options were retrieved. Required Feature Enablement: investment Options. |
GET investmentOptions |
returnAsOfDate | investment | date | Aggregated | Date corresponding to the published returns. Required Feature Enablement: investment Options. |
GET investmentOptions |
lastUpdated | investment | dateTime | Aggregated | The date when the information was last updated in the system. Required Feature Enablement: investment Options. |
GET investmentOptions |
feesAsofDate | investment | date | Aggregated | Date corresponding to the published fees. Required Feature Enablement: investment Options. |
GET investmentOptions |
investmentOptions | investment | entity[] | Aggregated | Investment Option information. Required Feature Enablement: investment Options. |
GET investmentOptions |
Entity: investmentOptions
Entity: rewardBalance
Attribute Name | Container | Type | Aggregated/ Manual | Description | Endpoints |
---|---|---|---|---|---|
description | reward | string | Aggregated | The description for the reward balance as available at provider source. | GET accounts/{accountId} |
balance | reward | decimal | Aggregated | The actual reward balance. | GET accounts/{accountId} |
units | reward | string | Aggregated | Unit of reward balance - miles, points, segments, dollars, credits. | GET accounts/{accountId} |
balanceType | reward | string | Aggregated | The type of reward balance.
Valid Values: Reward Account Balance Type
|
GET accounts/{accountId} |
expiryDate | reward | date | Aggregated | The date on which the balance expires. | GET accounts/{accountId} |
balanceToLevel | reward | string | Aggregated | The balance required to reach a reward level. | GET accounts/{accountId} |
balanceToReward | reward | string | Aggregated | The balance required to qualify for a reward such as retaining membership, business reward, etc. | GET accounts/{accountId} |
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 a scraped balance. Additional Details: Scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates. CarryForward: Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc. calculated: Balances that gets calculated for the days that are prior to the account added date. |
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 carry forward for the days where 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 |
Enums: Bank Transfer Code Type
Enums: Home Insurance Account Type
Enums: Life Insurance Account Type
Enums: Insurance Policy Status
PolicyStatus | Description |
---|---|
ACTIVE | Denotes the policy is active. |
INACTIVE | Denotes the policy is inactive. |
OTHER | The status could not be determined or it is other than active/inactive. |
Enums: Real Estate Valuation Type
ValuationType | Description |
---|---|
SYSTEM | Home value provided by the system. |
MANUAL | Home value manually provided by the user. |
Enums: Reward Account Balance Type
Enums: Account Frequency
Enums: Account Interest Rate Type
InterestRateType | Description |
---|---|
UNKNOWN | Unknown |
OTHER | Other |
FIXED | Fixed interest rate. |
VARIABLE | Variable intererest rate. |
Enums: Account Aggregation Source
AggregationSource | Description |
---|---|
SYSTEM | Accounts that are pre-populated by the customers on behalf of their users in to the Yodlee system. |
USER | Accounts that are added by the user. |
Enums: Account Classification
AccountClassification | Description |
---|---|
CORPORATE | Corporate account. |
OTHER | Other account. |
PERSONAL | Personal account. |
SMALL_BUSINESS | Small business account. |
TRUST | Trust account. |
Enums: Container
Enums: Account Status
AccountStatus | 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. |
Enums: Balances Data Source Type
DataSourceType | Description |
---|---|
S | Scraped balance from the provider site. |
C | Calculated balance by the system. |
CF | Last available balance that was carry forwarded for the days when account was not updated. |
Enums: Aggregated Account Type
Enums: Manual Account Type
Applicable Containers | AccountType |
bank | CHECKING |
SAVINGS | |
CD | |
PREPAID | |
creditCard | CREDIT |
loan | PERSONAL_LOAN |
HOME_LOAN | |
bill | BILLS |
insurance | INSURANCE |
ANNUITY | |
investment | BROKERAGE_CASH |
Enums: Refresh Status Code and Message
statusCode | statusMessage | Description | Additional Information |
---|---|---|---|
0 | SUCCESS | Account has been successfully added/updated. | Not an Error |
395 | OAUTH_SITE_NOT_SUPPORTED | The site does not seem to be supported. | Technical Error |
401 | NO_CONNECTION | Request Timed Out. | Technical Error |
402 | STATUS_LOGIN_FAILED | Username and/or password were reported to be incorrect. | UAR Error |
403 | INTERNAL_ERROR | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
404 | LOST_REQUEST | We faced a technical problem while updating your account. | Technical Error |
405 | ABORT_REQUEST | User has aborted the request. | User Error |
406 | STATUS_PASSWORD_EXPIRED | The password or the authentication information were reported as expired. | UAR Error |
407 | STATUS_ACCOUNT_LOCKED | The account has been locked in the provider site. | UAR Error |
408 | DATA_EXPECTED | No accounts found in the provider site. | Technical Error |
409 | STATUS_SITE_UNAVAILABLE | Account could not be updated because the end site is experiencing technical difficulties. | Site Error |
411 | STATUS_SITE_OUT_OF_BUSINESS | The provider site no longer provides online services to its customers. | Site Error |
412 | STATUS_SITE_APPLICATION_ERROR | The provider site is experiencing technical difficulties. | Site Error |
413 | REQUIRED_FIELD_UNAVAILABLE | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
414 | STATUS_NO_ACCT_FOUND | No accounts found in the provider site. | UAR Error |
415 | STATUS_SITE_TERMINATED_SESSION | Experiencing technical difficulties in the provider site. | Site Error |
416 | STATUS_SITE_SESSION_ALREADY_ESTABLISHED | Session was already established in the provider site. | Site Error |
417 | STATUS_DATA_MODEL_NO_SUPPORT | Account type was not supported by Yodlee. | UAR Error |
418 | STATUS_HTTP_DNS_ERROR_EXCEPTION | The provider site is experiencing technical difficulties. | Site Error |
419 | LOGIN_NOT_COMPLETED | We couldn't update the account because of unexpected variations at the site. This kind of problem is usually resolved in a few days. | Technical Error |
420 | STATUS_SITE_MERGED_ERROR | The provider site has been merged with another site. | UAR Error |
421 | STATUS_UNSUPPORTED_LANGUAGE_ERROR | The language setting for the provider site is not English. Please request the user to visit the site and change the language setting to English. | UAR Error |
422 | STATUS_ACCOUNT_CANCELED | Accounts found were closed. | UAR Error |
423 | STATUS_ACCT_INFO_UNAVAILABLE | No accounts found in the provider site. | Site Error |
424 | STATUS_SITE_DOWN_FOR_MAINTENANCE | The provider site was down for maintenance. | Site Error |
425 | STATUS_CERTIFICATE_ERROR | The provider site is experiencing technical difficulties. | Site Error |
426 | STATUS_SITE_BLOCKING | The provider site is experiencing technical difficulties. | Site Error |
427 | STATUS_SPLASH_PAGE_EXCEPTION | We could not update the account as the site requiring the user to view a new promotion. Please request the user to log in to the site and click through to his/her account overview page to update the details. | UAR Error |
428 | STATUS_TERMS_AND_CONDITIONS_EXCEPTION | We could not update the account due to the site requiring the user to accept new Terms & Conditions. Please request the user to log in to the site, read and accept the T&C. | UAR Error |
429 | STATUS_UPDATE_INFORMATION_EXCEPTION | We could not update the account due to the site requiring user to verify his/her personal information. Please request the user to log in to the site and update the fields required. | UAR Error |
430 | STATUS_SITE_NOT_SUPPORTED | Site is no longer supported for data updates. | UAR Error |
431 | HTTP_FILE_NOT_FOUND_ERROR | We faced a browser error while retrieving data. | Site Error |
432 | HTTP_INTERNAL_SERVER_ERROR | We faced a browser error while retrieving data. | Site Error |
475 | UNIQUEID_FROM_DATA_SOURCE_ERROR | We faced issues while setting the unique identifer for an account. Example: Two accounts seem to have the same unique identifier. | Technical Error |
476 | ACCOUNT_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
477 | BILL_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
478 | STATUS_DUPLICATE_BILL | We faced duplicate bill issues while retrieving bills for an account. | Site Error |
491 | REWARDS_PROGRAM_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
492 | REWARDS_ACTIVITY_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
494 | INVESTMENT_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
495 | LOAN_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
496 | CARD_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
497 | BANK_TRANSACTION_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
498 | HOLDING_REQUIRED_FIELDS_NOT_SET | The required fields does not seem to be set due to technical issues. | Technical Error |
499 | HELD_ACCOUNT'S_CREDENTIALS_USED | The user has provided their online application credentials to the linking provider site. | Site Error |
504 | MULTIPLE_ERROR | Multiple errors have occurred and the data retrieval process at the provider site failed. | Combinations of Technical/Site/UAR errors |
505 | STATUS_SITE_CURRENTLY_NOT_SUPPORTED | Yodlee does not support the security system used by this site. | Site Error |
506 | NEW_LOGIN_INFO_REQUIRED_FOR_SITE | To log in to this site, user need to provide additional information. Request the user to perform update accounts. | UAR Error |
507 | BETA_SITE_WORK_IN_PROGRESS | We have just started providing data updates for this site, and it may take a few days to be successful as we get started. | Technical Error |
508 | INSTANT_REQUEST_TIMEDOUT | Add/update account request timed out due to technical reasons. | Technical Error |
509 | TOKEN_ID_INVALID | The MFA token provided is no longer valid at the site. | User Input Error |
509 | TOKEN_ID_INVALID | The MFA token provided is no longer valid at the site. | User Input Error |
512 | NO_PAYEES_ARE_FOUND_ON_SOURCE | Payees does not seem to be available in the provider site. | User Error |
513 | PAYEES_COULD_NOT_BE_RETRIEVED | We faced issues while retrieving payees. | Technical Error |
514 | SOME_PAYEE_DETAILS_COULD_NOT_BE_RETRIEVED | We faced issues while retrieving one or more payee details. | Technical Error |
515 | NO_PAYMENT_ACCOUNT_FOUND | The payment account does not seem to be available in the provider site. | User Error |
517 | GENERAL_EXCEPTION_WHILE_GATHERING_MFA_DATA | We faced a technical problem while updating your account.This kind of error is usually resolved in a few days. | Technical Error |
518 | NEW_MFA_INFO_REQUIRED_FOR_AGENTS | Account was not updated as the required additional authentication information was unavailable.(MFA error) | UAR Error |
519 | MFA_INFO_NOT_PROVIDED_TO_YODLEE_BY_USER_FOR_AGENTS | Account was not updated as the authentication information like security question and answer was unavailable or incomplete. (MFA error) | UAR Error |
520 | MFA_INFO_MISMATCH_FOR_AGENTS | Provider site indicates that the additional authentication information provided is incorrect. (MFA error) | UAR Error |
521 | ENROLL_IN_MFA_AT_SITE | New security authentication system has been introduced in the provider site.(MFA error) | UAR Error |
522 | MFA_INFO_NOT_PROVIDED_IN_REAL_TIME_BY_USER_VIA_APP | Request Timed Out as the required security information was unavailable or was not provided within the expected time. (MFA error) | UAR Error |
523 | INVALID_MFA_INFO_IN_REAL_TIME_BY_USER_VIA_APP | The authentication information user provided is incorrect. (MFA error) | UAR Error |
524 | USER_PROVIDED_REAL_TIME_MFA_DATA_EXPIRED | The authentication information provided has expired. (MFA error) | UAR Error |
525 | MFA_INFO_NOT_PROVIDED_IN_REAL_TIME_BY_GATHERER | We faced a technical problem while updating your account. This kind of error is usually resolved in a few days. | Technical Error |
526 | INVALID_MFA_INFO_OR_CREDENTIALS | We could not update the account as the username/password or additional security credentials are incorrect. (MFA error) | UAR Error |
552 | CREDENTIALS_SUSPENDED | Credentials provided by the user seems to be suspended. | User Error |
553 | REQUEST_TIMED_OUT_DUE_TO_USER | User has not provided the information in the required time period. | User Error |
554 | NO_RESPONSE_FROM_SITE | We have not received a response from site. | Site Error |
556 | OAUTH_SITE_UNAVAILABLE | Outh site does not seem to be available for updates. | Site Error |
557 | INVALID_OAUTH_REQUEST | The OAUTH request generated is invalid. | Technical Error |
558 | SITE_UNAVAILABLE_INFORMED_BY_SITE | Site does not seem to be available for updates and informed by site. | Site Error |
559 | INSUFFICIENT_PRIVILEGE | Users does not have sufficient privilege. | User Error |
560 | INVALID_OAUTH_TOKEN | The oauth token provided is invalid. | Technical Error |
561 | GENERIC_OAUTH_ERROR | We faced technical issues while aggregating the data from OAUTH based site. | Technical Error |
562 | OAUTH_CONSENT_EXPIRED | The oauth token has expired. | User Error |
563 | OAUTH_CONSENT_REVOKED | The oauth token has been revoked. | User Error |
564 | OAUTH_CONSENT_UNAVAILABLE | The oauth consent is not available. | User Error |
565 | CERT_UNAVAILABLE_ERROR | The certificate is not available. | Technical Error |
566 | CERT_DOWNLOAD_ERROR | The certificate cannot be downloaded. | Technical Error |
567 | OAUTH_MIGRATION_FAILED | The oauth migration has failed. | Technical Error |
570 | DOCUMENT_NOT_AVAILABLE | Document not available for download. | User Error |
571 | DOCUMENT_DOWNLOAD_FAILED | The document download process has failed due to site issues. | Site Error |
572 | DOCUMENT_SIZE_EXCEEDS_THE_LIMIT | The document that we are trying to download exceeded the size limit. | Technical Error |
573 | DOCUMENT_DOWNLOAD_REQUIRES_ADDTNL_AUTHENTICATION | Document download needs additional authentication. | User Error |
574 | EBILL_ENROLLMENT_REQUIRED_FOR_BILL_DOWNLOAD | User has not enrolled for the ebill. | User Error |
575 | DOCUMENT_DOWNLOADED_NOT_SUPPORTED | No support available for document download. | User Error |
576 | DOCUMENT_UPLOAD_TO_SERVER_FAILED | The downloaded document failed while uploading to our server. | Technical Error |
578 | DOCUMENT_TYPE_NOT_SUPPORTED | The type of the document does not seem to be supported. | Technical Error |
579 | DOCUMENT_PROCESSING_FAILED | We faced technical error while processing the document. | Technical Error |
601 | DBFILER_SUMMARY_SAVE_ERROR | We faced a technical problem while updating your account. | Technical Error |
604 | STATUS_REQUEST_GENERATION_ERROR_LOGIN_FAILURE | We faced technical issues while generating the request for data retrieval. | Technical Error |
709 | STATUS_FIELD_NOT_AVAILABLE | This error is thrown when there is a mismatch in the meta-fields. | Technical Error |
801 | ADD_IN_PROGRESS | Account addition is in progress. | Not an Error |
802 | UPDATE_IN_PROGRESS | Account update is in progress. | Not an Error |
803 | REFFRESH_NOT_DONE_AS_MIGRATION_IN_PROGRESS | The account cannot be refreshed as the OAuth migration is in progress. | Technical Error |
811 | PARTIAL_SUCCESS | Data was successfully aggregated for at least one, but not all, accounts. | Partial Success |