{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/DataExtractsAccount", "title": "DataExtractsAccount", "type": "object", "properties": { "availableCash": { "$ref": "#/components/schemas/Money" }, "includeInNetWorth": { "type": "boolean", "description": "Used to determine whether an account to be considered in the networth calculation.

Aggregated / Manual: Aggregated
Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities
Endpoints:", "readOnly": true }, "moneyMarketBalance": { "$ref": "#/components/schemas/Money" }, "enrollmentDate": { "type": "string", "description": "Date on which the user is enrolled on the rewards program.

Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:", "readOnly": true }, "estimatedDate": { "type": "string", "description": "The date on which the home value was estimated.

Aggregated / Manual: Manual
Applicable containers: realEstate
Endpoints:", "readOnly": true }, "memo": { "type": "string", "description": "The additional description or notes given by the user.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "guarantor": { "type": "string", "description": "A nonprofit or state organization that works with lender, servicer, school, 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.

Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:", "readOnly": true }, "interestPaidLastYear": { "$ref": "#/components/schemas/Money" }, "lastUpdated": { "type": "string", "description": "The date time the account information was last retrieved from the provider site and updated in the Yodlee system.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "balance": { "$ref": "#/components/schemas/Money" }, "homeInsuranceType": { "type": "string", "description": "Type of home insurance, like -Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "HOME_OWNER", "RENTAL", "RENTER", "UNKNOWN", "OTHER" ] }, "id": { "type": "integer", "description": "The primary key of the account resource and the unique identifier for the account.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "format": "int64", "readOnly": true }, "cash": { "$ref": "#/components/schemas/Money" }, "totalCreditLine": { "$ref": "#/components/schemas/Money" }, "providerName": { "type": "string", "description": "Service provider or institution name where the account originates. This belongs to the provider resource.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "valuationType": { "type": "string", "description": "The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.

Aggregated / Manual: Manual
Applicable containers: realEstate
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "SYSTEM", "MANUAL" ] }, "marginBalance": { "$ref": "#/components/schemas/Money" }, "apr": { "type": "number", "description": "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.
Aggregated / Manual: Aggregated
Applicable containers: creditCard
Endpoints:
", "format": "double", "readOnly": true }, "availableCredit": { "$ref": "#/components/schemas/Money" }, "currentBalance": { "$ref": "#/components/schemas/Money" }, "isManual": { "type": "boolean", "description": "Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user.
Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "escrowBalance": { "$ref": "#/components/schemas/Money" }, "nextLevel": { "type": "string", "description": "The eligible next level of the rewards program.

Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:", "readOnly": true }, "classification": { "type": "string", "description": "The classification of the account such as personal, corporate, etc.

Aggregated / Manual: Aggregated
Applicable containers: bank, creditCard, investment, reward, loan, insurance
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "OTHER", "PERSONAL", "CORPORATE", "SMALL_BUSINESS", "TRUST", "ADD_ON_CARD", "VIRTUAL_CARD" ] }, "loanPayoffAmount": { "$ref": "#/components/schemas/Money" }, "interestRateType": { "type": "string", "description": "The type of the interest rate, for example, fixed or variable.
Applicable containers: loan
Aggregated / Manual: Aggregated
Endpoints:
Applicable Values
", "readOnly": true, "enum": [ "FIXED", "VARIABLE", "UNKNOWN", "OTHER" ] }, "loanPayByDate": { "type": "string", "description": "The date by which the payoff amount should be paid.

Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:", "readOnly": true }, "faceAmount": { "$ref": "#/components/schemas/Money" }, "policyFromDate": { "type": "string", "description": "The date the insurance policy began.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
", "readOnly": true }, "premiumPaymentTerm": { "type": "string", "description": "The number of years for which premium payments have to be made in a policy.

Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:", "readOnly": true }, "policyTerm": { "type": "string", "description": "The duration for which the policy is valid or in effect. For example, one year, five years, etc.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
", "readOnly": true }, "repaymentPlanType": { "type": "string", "description": "The type of repayment plan that the borrower prefers to repay the loan.

Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:Applicable Values:
", "readOnly": true, "enum": [ "STANDARD", "GRADUATED", "EXTENDED", "INCOME_BASED", "INCOME_CONTINGENT", "INCOME_SENSITIVE", "PAY_AS_YOU_EARN", "REVISED_PAY_AS_YOU_EARN" ] }, "aggregatedAccountType": { "type": "string", "description": "The type of account that is aggregated.", "readOnly": true }, "availableBalance": { "$ref": "#/components/schemas/Money" }, "accountStatus": { "type": "string", "description": "The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus
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.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "ACTIVE", "INACTIVE", "TO_BE_CLOSED", "CLOSED", "DELETED" ] }, "lifeInsuranceType": { "type": "string", "description": "Type of life insurance.

Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "OTHER", "TERM_LIFE_INSURANCE", "UNIVERSAL_LIFE_INSURANCE", "WHOLE_LIFE_INSURANCE", "VARIABLE_LIFE_INSURANCE", "ULIP", "ENDOWMENT" ] }, "premium": { "$ref": "#/components/schemas/Money" }, "aggregationSource": { "type": "string", "description": "The source through which the account(s) are added in the system.
Valid Values: SYSTEM, USER
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
Applicable Values
", "readOnly": true, "enum": [ "SYSTEM", "USER" ] }, "isDeleted": { "type": "boolean", "description": "Indicates if the account is marked as deleted.Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
", "readOnly": true }, "overDraftLimit": { "$ref": "#/components/schemas/Money" }, "nickname": { "type": "string", "description": "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.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "term": { "type": "string", "description": "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.

Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:", "readOnly": true }, "interestRate": { "type": "number", "description": "
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.

Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:", "format": "double", "readOnly": true }, "deathBenefit": { "$ref": "#/components/schemas/Money" }, "address": { "$ref": "#/components/schemas/AccountAddress" }, "cashValue": { "$ref": "#/components/schemas/Money" }, "401kLoan": { "$ref": "#/components/schemas/Money" }, "homeValue": { "$ref": "#/components/schemas/Money" }, "accountNumber": { "type": "string", "description": "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:
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.
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
", "readOnly": true }, "createdDate": { "type": "string", "description": "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.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "interestPaidYTD": { "$ref": "#/components/schemas/Money" }, "providerAccountId": { "type": "integer", "description": "The primary key of the provider account resource.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "format": "int64", "readOnly": true }, "isSelectedForAggregation": { "type": "boolean", "description": "Indicates if the account is selected by user for aggregation.
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
", "readOnly": true }, "collateral": { "type": "string", "description": "Property or possession offered to support a loan that can be seized on a default.
Applicable containers: loan
Aggregated / Manual: Aggregated
Endpoints:
", "readOnly": true }, "dataset": { "type": "array", "description": "Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

Aggregated / Manual: Aggregated
Applicable containers: All containers
Endpoints:", "readOnly": true, "items": { "$ref": "#/components/schemas/AccountDataset" } }, "runningBalance": { "$ref": "#/components/schemas/Money" }, "sourceId": { "type": "string", "description": "A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts.

Applicable containers: bank, creditCard, investment, insurance, loan, reward
Endpoints:", "readOnly": true }, "dueDate": { "type": "string", "description": "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.

Aggregated / Manual: Aggregated
Applicable containers: creditCard, loan, insurance
Endpoints:", "readOnly": true }, "frequency": { "type": "string", "description": "The frequency of the billing cycle of the account in case of card. 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.

Aggregated / Manual: Both
Applicable containers: creditCard, insurance, loan
Endpoints:Applicable Values
", "readOnly": true, "enum": [ "DAILY", "ONE_TIME", "WEEKLY", "EVERY_2_WEEKS", "SEMI_MONTHLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUALLY", "ANNUALLY", "EVERY_2_MONTHS", "EBILL", "FIRST_DAY_MONTHLY", "LAST_DAY_MONTHLY", "EVERY_4_WEEKS", "UNKNOWN", "OTHER" ] }, "maturityAmount": { "$ref": "#/components/schemas/Money" }, "associatedProviderAccountId": { "type": "array", "description": "The providerAccountIds that share the account with the primary providerAccountId that was created when the user had 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 IDs indicating the account is owned by more than one user, for example, joint accounts.

Aggregated / Manual: Aggregated
Applicable containers: All Containers
Endpoints:", "readOnly": true, "items": { "type": "integer", "format": "int64" } }, "isAsset": { "type": "boolean", "description": "The account to be considered as an asset or liability.
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
", "readOnly": true }, "principalBalance": { "$ref": "#/components/schemas/Money" }, "totalCashLimit": { "$ref": "#/components/schemas/Money" }, "maturityDate": { "type": "string", "description": "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.

Aggregated / Manual: Aggregated
Applicable containers: bank, loan
Endpoints:", "readOnly": true }, "minimumAmountDue": { "$ref": "#/components/schemas/Money" }, "annualPercentageYield": { "type": "number", "description": "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.
Applicable containers: bank
Aggregated / Manual: Aggregated
Endpoints:
", "format": "double", "readOnly": true }, "accountType": { "type": "string", "description": "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:
Aggregated Account Type
bankcreditCardinvestment (SN 1.0)investment (SN 2.0)loaninsurancerealEstaterewardManual Account Type
bankcreditloaninsuranceinvestment

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "originationDate": { "type": "string", "description": "The date on which the loan is disbursed.

Aggregated / Manual: Both
Applicable containers: loan
Endpoints:", "readOnly": true }, "totalVestedBalance": { "$ref": "#/components/schemas/Money" }, "rewardBalance": { "type": "array", "description": "Information of different reward balances associated with the account.

Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:", "readOnly": true, "items": { "$ref": "#/components/schemas/RewardBalance" } }, "sourceAccountStatus": { "type": "string", "description": "Indicates the status of the loan account.

Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:Applicable Values:
", "readOnly": true, "enum": [ "IN_REPAYMENT", "DEFAULTED", "IN_SCHOOL", "IN_GRACE_PERIOD", "DELINQUENCY", "DEFERMENT", "FORBEARANCE" ] }, "linkedAccountIds": { "type": "array", "description": "List of Loan accountId(s) to which the real-estate account is linked

Aggregated / Manual: Both
Applicable containers: realEstate
Endpoints:", "readOnly": true, "items": { "type": "integer", "format": "int64" } }, "derivedApr": { "type": "number", "description": "Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase.
Aggregated / Manual / Derived: Derived
Applicable containers: creditCard
Endpoints:
", "format": "double", "readOnly": true }, "policyEffectiveDate": { "type": "string", "description": "The date on which the insurance policy coverage commences.
Applicable containers: insurance
Aggregated / Manual: Aggregated
Endpoints:
", "readOnly": true }, "totalUnvestedBalance": { "$ref": "#/components/schemas/Money" }, "annuityBalance": { "$ref": "#/components/schemas/Money" }, "accountName": { "type": "string", "description": "The account name as it appears at the site.
(The POST accounts service response return this field as name)
Applicable containers: All Containers
Aggregated / Manual: Both
Endpoints:
", "readOnly": true }, "totalCreditLimit": { "$ref": "#/components/schemas/Money" }, "policyStatus": { "type": "string", "description": "The status of the policy.
Aggregated / Manual: Aggregated
Applicable containers: insurance
Endpoints:
Applicable Values
", "readOnly": true, "enum": [ "ACTIVE", "IN_ACTIVE", "OTHER" ] }, "shortBalance": { "$ref": "#/components/schemas/Money" }, "lender": { "type": "string", "description": "The financial institution that provides the loan.

Aggregated / Manual: Aggregated
Applicable containers: loan
Endpoints:", "readOnly": true }, "lastEmployeeContributionAmount": { "$ref": "#/components/schemas/Money" }, "providerId": { "type": "string", "description": "Identifier of the provider site. The primary key of provider resource.

Aggregated / Manual: Both
Applicable containers: All containers
Endpoints:", "readOnly": true }, "lastPaymentDate": { "type": "string", "description": "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.

Aggregated / Manual: Aggregated
Applicable containers: creditCard, loan, insurance
Endpoints:", "readOnly": true }, "primaryRewardUnit": { "type": "string", "description": "Primary reward unit for this reward program. E.g. miles, points, etc.

Aggregated / Manual: Aggregated
Applicable containers: reward
Endpoints:", "readOnly": true }, "lastPaymentAmount": { "$ref": "#/components/schemas/Money" }, "remainingBalance": { "$ref": "#/components/schemas/Money" }, "userClassification": { "type": "string", "description": "Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
Endpoints:
  • GET dataExtracts/userData
    • Applicable Values
    ", "readOnly": true, "enum": [ "BUSINESS", "PERSONAL" ] }, "bankTransferCode": { "type": "array", "description": "Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
    ", "readOnly": true, "items": { "$ref": "#/components/schemas/BankTransferCode" } }, "expirationDate": { "type": "string", "description": "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.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:", "readOnly": true }, "coverage": { "type": "array", "description": "The coverage-related details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:", "readOnly": true, "items": { "$ref": "#/components/schemas/Coverage" } }, "cashApr": { "type": "number", "description": "Annual percentage rate applied to cash withdrawals on the card.

    Account Type: Aggregated
    Applicable containers: creditCard
    Endpoints:", "format": "double" }, "oauthMigrationStatus": { "type": "string", "description": "Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.

    Endpoints:", "readOnly": true, "enum": [ "IN_PROGRESS", "TO_BE_MIGRATED", "COMPLETED", "MIGRATED" ] }, "displayedName": { "type": "string", "description": "The name or identification of the account owner, as it appears at the FI site.
    Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, insurance, loan, reward
    Endpoints:", "readOnly": true }, "sourceProviderAccountId": { "type": "integer", "description": "The providerAccountId that is deleted and merged into the destinationProviderAccountId as part of the many-to-one OAuth migration process.
    Endpoints:", "format": "int64", "readOnly": true }, "amountDue": { "$ref": "#/components/schemas/Money" }, "currentLevel": { "type": "string", "description": "Current level of the reward program the user is associated with. E.g. Silver, Jade etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:", "readOnly": true }, "originalLoanAmount": { "$ref": "#/components/schemas/Money" }, "policyToDate": { "type": "string", "description": "The date to which the policy exists.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ", "readOnly": true }, "loanPayoffDetails": { "$ref": "#/components/schemas/LoanPayoffDetails" }, "CONTAINER": { "type": "string", "description": "The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:Applicable Values
    ", "readOnly": true, "enum": [ "bank", "creditCard", "investment", "insurance", "loan", "reward", "bill", "realEstate", "otherAssets", "otherLiabilities" ] }, "lastEmployeeContributionDate": { "type": "string", "description": "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.

    Aggregated / Manual: Aggregated
    Applicable containers: investment
    Endpoints:", "readOnly": true }, "lastPayment": { "$ref": "#/components/schemas/Money" }, "recurringPayment": { "$ref": "#/components/schemas/Money" } } }