Envestnet · Schema
CreditAcceleratorAccount
FinancialWealth ManagementOpen BankingAccount Aggregation
Properties
| Name | Type | Description |
|---|---|---|
| availableCash | object | |
| includeInNetWorth | boolean | Used to determine whether an account to be considered in the networth calculation. Aggregated / Manual: Aggregated Applicable containers: bank,creditCard,loan,investment,insura |
| moneyMarketBalance | object | |
| enrollmentDate | string | Date on which the user is enrolled on the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:
|
| estimatedDate | string | The date on which the home value was estimated. Aggregated / Manual: Manual Applicable containers: realEstate Endpoints:
|
| memo | string | The additional description or notes given by the user. Aggregated / Manual: Both Applicable containers: All containers Endpoints:
|
| guarantor | string | 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 stu |
| interestPaidLastYear | object | |
| lastUpdated | string | 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 containe |
| balance | object | |
| homeInsuranceType | string | Type of home insurance, like -
Applicable containers: insurance Endpoints< |
| id | integer | The primary key of the account resource and the unique identifier for the account. Aggregated / Manual: Both Applicable containers: All containers Endpoints: |
| cash | object | |
| totalCreditLine | object | |
| providerName | string | Service provider or institution name where the account originates. This belongs to the provider resource. Aggregated / Manual: Both Applicable containers: All containers |
| valuationType | string | The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners. Aggregated / Manual: Manual Applicable containers: realEstate End |
| marginBalance | object | |
| apr | number | 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. Th |
| availableCredit | object | |
| currentBalance | object | |
| isManual | boolean | 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 |
| profile | object | |
| escrowBalance | object | |
| nextLevel | string | The eligible next level of the rewards program. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:
|
| classification | string | The classification of the account such as personal, corporate, etc. Aggregated / Manual: Aggregated Applicable containers: bank, creditCard, investment, reward, loan, insurance |
| loanPayoffAmount | object | |
| interestRateType | string | The type of the interest rate, for example, fixed or variable. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints:
|
| loanPayByDate | string | The date by which the payoff amount should be paid. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:
|
| faceAmount | object | |
| policyFromDate | string | The date the insurance policy began. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:
|
| premiumPaymentTerm | string | The number of years for which premium payments have to be made in a policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:
|
| policyTerm | string | 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 |
| repaymentPlanType | string | The type of repayment plan that the borrower prefers to repay the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:
|
| aggregatedAccountType | string | The type of account that is aggregated. |
| availableBalance | object | |
| reconciliable | boolean | |
| accountStatus | string | 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 aggrega |
| lifeInsuranceType | string | Type of life insurance. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:
|
| fullAccountNumber | string | Full account number of the account that is included only when include = fullAccountNumber is provided in the request. For student loan account the account number that will be used for ACH or fund tran |
| premium | object | |
| aggregationSource | string | The source through which the account(s) are added in the system. Valid Values: SYSTEM, USER Applicable containers: All Containers Aggregated / Manual: Both Endpoin |
| overDraftLimit | object | |
| nickname | string | 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 |
| term | string | 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 |
| interestRate | number | 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 Ra |
| deathBenefit | object | |
| address | object | |
| cashValue | object | |
| holder | array | Holder details of the account. Aggregated / Manual: Aggregated Applicable containers: bank Endpoints:
|
| 401kLoan | object | |
| homeValue | object | |
| accountNumber | string | 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 n |
| createdDate | string | 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 Yodl |
| interestPaidYTD | object | |
| providerAccountId | integer | The primary key of the provider account resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:
|
| collateral | string | Property or possession offered to support a loan that can be seized on a default. Applicable containers: loan Aggregated / Manual: Aggregated Endpoints:
|
| dataset | array | |
| runningBalance | object | |
| isReconciliable | boolean | |
| sourceId | string | 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, loa |
| dueDate | string | 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. |
| frequency | string | 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 |
| maturityAmount | object | |
| associatedProviderAccountId | array | 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 i |
| isAsset | boolean | The account to be considered as an asset or liability. Applicable containers: All Containers Aggregated / Manual: Both Endpoints:
|
| principalBalance | object | |
| totalCashLimit | object | |
| maturityDate | string | 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: |
| minimumAmountDue | object | |
| annualPercentageYield | number | 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 institu |
| accountType | string | 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: Agg |
| originationDate | string | The date on which the loan is disbursed. Aggregated / Manual: Both Applicable containers: loan Endpoints:
|
| totalVestedBalance | object | |
| rewardBalance | array | Information of different reward balances associated with the account. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:
|
| sourceAccountStatus | string | Indicates the status of the loan account. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:
|
| linkedAccountIds | array | List of Loan accountId(s) to which the real-estate account is linked Aggregated / Manual: Both Applicable containers: realEstate Endpoints:
|
| derivedApr | number | Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase. Aggregated / Manual / Derived: Derived Applicable containers: cr |
| policyEffectiveDate | string | The date on which the insurance policy coverage commences. Applicable containers: insurance Aggregated / Manual: Aggregated Endpoints:
|
| totalUnvestedBalance | object | |
| annuityBalance | object | |
| accountName | string | 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 |
| totalCreditLimit | object | |
| policyStatus | string | The status of the policy. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:
|
| shortBalance | object | |
| lender | string | The financial institution that provides the loan. Aggregated / Manual: Aggregated Applicable containers: loan Endpoints:
|
| lastEmployeeContributionAmount | object | |
| providerId | string | Identifier of the provider site. The primary key of provider resource. Aggregated / Manual: Both Applicable containers: All containers Endpoints:
|
| lastPaymentDate | string | 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 th |
| primaryRewardUnit | string | Primary reward unit for this reward program. E.g. miles, points, etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints:
|
| lastPaymentAmount | object | |
| remainingBalance | object | |
| userClassification | string | Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities Endpoints:
|
| bankTransferCode | array | Bank and branch identification information. Aggregated / Manual: Aggregated Applicable containers: bank, investment, loan Endpoints:
|
| expirationDate | string | 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 |
| coverage | array | The coverage-related details of the account. Aggregated / Manual: Aggregated Applicable containers: insurance,investment Endpoints:
|
| cashApr | number | Annual percentage rate applied to cash withdrawals on the card. Account Type: Aggregated Applicable containers: creditCard Endpoints:
|
| autoRefresh | object | |
| oauthMigrationStatus | string | Indicates the migration status of the account from screen-scraping provider to the Open Banking provider. Endpoints:
|
| displayedName | string | 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 |
| fullAccountNumberList | object | |
| amountDue | object | |
| currentLevel | string | Current level of the reward program the user is associated with. E.g. Silver, Jade etc. Aggregated / Manual: Aggregated Applicable containers: reward Endpoints: |
| originalLoanAmount | object | |
| policyToDate | string | The date to which the policy exists. Aggregated / Manual: Aggregated Applicable containers: insurance Endpoints:
|
| loanPayoffDetails | object | |
| paymentProfile | object | |
| CONTAINER | string | The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc. Aggregated / Manual: Aggregated Applicable containers: All containers Endpoints:
|
| lastEmployeeContributionDate | string | 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 th |
| lastPayment | object | |
| recurringPayment | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreditAcceleratorAccount",
"title": "CreditAcceleratorAccount",
"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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"moneyMarketBalance": {
"$ref": "#/components/schemas/Money"
},
"enrollmentDate": {
"type": "string",
"description": "Date on which the user is enrolled on the rewards program.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"estimatedDate": {
"type": "string",
"description": "The date on which the home value was estimated.<br><br><b>Aggregated / Manual</b>: Manual<br><b>Applicable containers</b>: realEstate<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"memo": {
"type": "string",
"description": "The additional description or notes given by the user.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"balance": {
"$ref": "#/components/schemas/Money"
},
"homeInsuranceType": {
"type": "string",
"description": "Type of home insurance, like -<ul><li>HOME_OWNER</li><li>RENTAL</li><li>RENTER</li><li>etc..</li></ul><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"HOME_OWNER",
"RENTAL",
"RENTER",
"UNKNOWN",
"OTHER"
]
},
"id": {
"type": "integer",
"description": "The primary key of the account resource and the unique identifier for the account.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts </li><li>GET accounts/{accountId}</li><li>GET investmentOptions</li><li>GET accounts/historicalBalances</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"valuationType": {
"type": "string",
"description": "The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.<br><br><b>Aggregated / Manual</b>: Manual<br><b>Applicable containers</b>: realEstate<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"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.<br><b>Additional Details:</b> 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.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"profile": {
"$ref": "#/components/schemas/CreditAcceleratorAccountProfile"
},
"escrowBalance": {
"$ref": "#/components/schemas/Money"
},
"nextLevel": {
"type": "string",
"description": "The eligible next level of the rewards program.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"classification": {
"type": "string",
"description": "The classification of the account such as personal, corporate, etc.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, creditCard, investment, reward, loan, insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"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.<br><b>Applicable containers</b>: loan<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"FIXED",
"VARIABLE",
"UNKNOWN",
"OTHER"
]
},
"loanPayByDate": {
"type": "string",
"description": "The date by which the payoff amount should be paid.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"faceAmount": {
"$ref": "#/components/schemas/Money"
},
"policyFromDate": {
"type": "string",
"description": "The date the insurance policy began.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"premiumPaymentTerm": {
"type": "string",
"description": "The number of years for which premium payments have to be made in a policy.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"policyTerm": {
"type": "string",
"description": "The duration for which the policy is valid or in effect. For example, one year, five years, etc.<br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"repaymentPlanType": {
"type": "string",
"description": "The type of repayment plan that the borrower prefers to repay the loan. <br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values:</b><br>",
"readOnly": true,
"enum": [
"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"
},
"reconciliable": {
"type": "boolean"
},
"accountStatus": {
"type": "string",
"description": "The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus<br><b>Additional Details:</b><br><b>ACTIVE:</b> All the added manual and aggregated accounts status will be made \"ACTIVE\" by default. <br><b>TO_BE_CLOSED:</b> If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED<br><b>INACTIVE:</b> Users can update the status as INACTIVE to stop updating and to stop considering the account in other services<br><b>CLOSED:</b> Users can update the status as CLOSED, if the account is closed with the provider. <br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"ACTIVE",
"INACTIVE",
"TO_BE_CLOSED",
"CLOSED",
"DELETED"
]
},
"lifeInsuranceType": {
"type": "string",
"description": "Type of life insurance.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"OTHER",
"TERM_LIFE_INSURANCE",
"UNIVERSAL_LIFE_INSURANCE",
"WHOLE_LIFE_INSURANCE",
"VARIABLE_LIFE_INSURANCE",
"ULIP",
"ENDOWMENT"
]
},
"fullAccountNumber": {
"type": "string",
"description": "Full account number of the account that is included only when include = fullAccountNumber is provided in the request. For student loan account the account number that will be used for ACH or fund transfer<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: bank, creditCard, investment, insurance, loan, reward, otherAssets, otherLiabilities <br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><b> Note : </b> fullAccountNumber is deprecated and is replaced with fullAccountNumberList in include parameter and response.</ul>",
"readOnly": true
},
"premium": {
"$ref": "#/components/schemas/Money"
},
"aggregationSource": {
"type": "string",
"description": "The source through which the account(s) are added in the system.<br><b>Valid Values</b>: SYSTEM, USER<br><b>Applicable containers</b>: All Containers<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"SYSTEM",
"USER"
]
},
"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.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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. <br><b>Additional Details:</b><br> 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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"interestRate": {
"type": "number",
"description": "<br><b>Bank:</b> The interest rate offered by a FI to its depositors on a bank account.<br><b>Loan:</b> Interest rate applied on the loan.<br><b>Additional Details:</b><br><b>Note:</b> The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"format": "double",
"readOnly": true
},
"deathBenefit": {
"$ref": "#/components/schemas/Money"
},
"address": {
"$ref": "#/components/schemas/CreditAcceleratorAccountAddress"
},
"cashValue": {
"$ref": "#/components/schemas/Money"
},
"holder": {
"type": "array",
"description": "Holder details of the account.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li></ul>",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/CreditAcceleratorAccountHolder"
}
},
"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)<br><b>Additional Details</b>:<b> Bank/ Loan/ Insurance/ Investment</b>:<br> The account number for the bank account as it appears at the site.<br><b>Credit Card</b>: The account number of the card account as it appears at the site,<br>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.<br><b>Applicable containers</b>: All Containers<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>POST accounts</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"createdDate": {
"type": "string",
"description": "The date on which the account is created in the Yodlee system.<br><b>Additional Details:</b> It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"interestPaidYTD": {
"$ref": "#/components/schemas/Money"
},
"providerAccountId": {
"type": "integer",
"description": "The primary key of the provider account resource.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"format": "int64",
"readOnly": true
},
"collateral": {
"type": "string",
"description": "Property or possession offered to support a loan that can be seized on a default.<br><b>Applicable containers</b>: loan<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"dataset": {
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/AccountDataset"
}
},
"runningBalance": {
"$ref": "#/components/schemas/Money"
},
"isReconciliable": {
"type": "boolean",
"readOnly": true
},
"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.<br><br><b>Applicable containers</b>: bank, creditCard, investment, insurance, loan, reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"dueDate": {
"type": "string",
"description": "The date on which the due amount has to be paid. <br><b>Additional Details:</b><br><b>Credit Card:</b> The monthly date by when the minimum payment is due to be paid on the credit card account. <br><b>Loan:</b> The date on or before which the due amount should be paid.<br><b>Note:</b> 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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: creditCard, loan, insurance<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: creditCard, insurance, loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values</b><br>",
"readOnly": true,
"enum": [
"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.<br><b>Additional Details</b>: 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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: All Containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true,
"items": {
"type": "integer",
"format": "int64"
}
},
"isAsset": {
"type": "boolean",
"description": "The account to be considered as an asset or liability.<br><b>Applicable containers</b>: All Containers<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><b>Additional Details:</b> 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.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: bank, loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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.<br><b>Applicable containers</b>: bank<br><b>Aggregated / Manual</b>: Aggregated<br><b>Endpoints</b>:<br><ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"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. <br><b>Valid Values:</b><br><b>Aggregated Account Type</b><br><b>bank</b><ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PPF</li><li>RECURRING_DEPOSIT</li><li>FSA</li><li>MONEY_MARKET</li><li>IRA</li><li>PREPAID</li></ul><b>creditCard</b><ul><li>OTHER</li><li>CREDIT</li><li>STORE</li><li>CHARGE</li><li>OTHER</li></ul><b>investment (SN 1.0)</b><ul><li>BROKERAGE_MARGIN</li><li>HSA</li><li>IRA</li><li>BROKERAGE_CASH</li><li>401K</li><li>403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE</li><li>CUSTODIAL</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE</li><li>JTTIC</li><li>JTWROS</li><li>COMMUNITY_PROPERTY</li><li>JOINT_BY_ENTIRETY</li><li>CONSERVATORSHIP</li><li>ROTH</li><li>ROTH_CONVERSION</li><li>ROLLOVER</li><li>EDUCATIONAL</li><li>529_PLAN</li><li>457_DEFERRED_COMPENSATION</li><li>401A</li><li>PSP</li><li>MPP</li><li>STOCK_BASKET</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER</li><li>CHARITABLE_LEAD</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP</li><li>UTMA</li><li>UGMA</li><li>ESOPP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>SOLE_PROPRIETORSHIP</li><li>CHURCH</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CMA</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET</li><li>SUPER_ANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN</li><li>DEFERRED_PROFIT_SHARING_PLAN</li><li>NON_REGISTERED_SAVINGS_PLAN</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN</li><li>GROUP_RETIREMENT_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN</li><li>LOCKED_IN_RETIREMENT_ACCOUNT</li><li>REGISTERED_PENSION_PLAN</li><li>TAX_FREE_SAVINGS_ACCOUNT</li><li>LIFE_INCOME_FUND</li><li>REGISTERED_RETIREMENT_INCOME_FUND</li><li>SPOUSAL_RETIREMENT_INCOME_FUND</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND</li><li>GUARANTEED_INVESTMENT_CERTIFICATES</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN</li><li>DIGITAL_WALLET</li><li>OTHER</li></ul><b>investment (SN 2.0)</b><ul><li>BROKERAGE_CASH</li><li>BROKERAGE_MARGIN</li><li>INDIVIDUAL_RETIREMENT_ACCOUNT_IRA</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_401K</li><li>EMPLOYEE_RETIREMENT_SAVINGS_PLAN_403B</li><li>TRUST</li><li>ANNUITY</li><li>SIMPLE_IRA</li><li>CUSTODIAL_ACCOUNT</li><li>BROKERAGE_CASH_OPTION</li><li>BROKERAGE_MARGIN_OPTION</li><li>INDIVIDUAL</li><li>CORPORATE_INVESTMENT_ACCOUNT</li><li>JOINT_TENANTS_TENANCY_IN_COMMON_JTIC</li><li>JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP_JTWROS</li><li>JOINT_TENANTS_COMMUNITY_PROPERTY</li><li>JOINT_TENANTS_TENANTS_BY_ENTIRETY</li><li>CONSERVATOR</li><li>ROTH_IRA</li><li>ROTH_CONVERSION</li><li>ROLLOVER_IRA</li><li>EDUCATIONAL</li><li>EDUCATIONAL_SAVINGS_PLAN_529</li><li>DEFERRED_COMPENSATION_PLAN_457</li><li>MONEY_PURCHASE_RETIREMENT_PLAN_401A</li><li>PROFIT_SHARING_PLAN</li><li>MONEY_PURCHASE_PLAN</li><li>STOCK_BASKET_ACCOUNT</li><li>LIVING_TRUST</li><li>REVOCABLE_TRUST</li><li>IRREVOCABLE_TRUST</li><li>CHARITABLE_REMAINDER_TRUST</li><li>CHARITABLE_LEAD_TRUST</li><li>CHARITABLE_GIFT_ACCOUNT</li><li>SEP_IRA</li><li>UNIFORM_TRANSFER_TO_MINORS_ACT_UTMA</li><li>UNIFORM_GIFT_TO_MINORS_ACT_UGMA</li><li>EMPLOYEE_STOCK_OWNERSHIP_PLAN_ESOP</li><li>ADMINISTRATOR</li><li>EXECUTOR</li><li>PARTNERSHIP</li><li>PROPRIETORSHIP</li><li>CHURCH_ACCOUNT</li><li>INVESTMENT_CLUB</li><li>RESTRICTED_STOCK_AWARD</li><li>CASH_MANAGEMENT_ACCOUNT</li><li>EMPLOYEE_STOCK_PURCHASE_PLAN_ESPP</li><li>PERFORMANCE_PLAN</li><li>BROKERAGE_LINK_ACCOUNT</li><li>MONEY_MARKET_ACCOUNT</li><li>SUPERANNUATION</li><li>REGISTERED_RETIREMENT_SAVINGS_PLAN_RRSP</li><li>SPOUSAL_RETIREMENT_SAVINGS_PLAN_SRSP</li><li>DEFERRED_PROFIT_SHARING_PLAN_DPSP</li><li>NON_REGISTERED_SAVINGS_PLAN_NRSP</li><li>REGISTERED_EDUCATION_SAVINGS_PLAN_RESP</li><li>GROUP_RETIREMENT_SAVINGS_PLAN_GRSP</li><li>LOCKED_IN_RETIREMENT_SAVINGS_PLAN_LRSP</li><li>RESTRICTED_LOCKED_IN_SAVINGS_PLAN_RLSP</li><li>LOCKED_IN_RETIREMENT_ACCOUNT_LIRA</li><li>REGISTERED_PENSION_PLAN_RPP</li><li>TAX_FREE_SAVINGS_ACCOUNT_TFSA</li><li>LIFE_INCOME_FUND_LIF</li><li>REGISTERED_RETIREMENT_INCOME_FUND_RIF</li><li>SPOUSAL_RETIREMENT_INCOME_FUND_SRIF</li><li>LOCKED_IN_REGISTERED_INVESTMENT_FUND_LRIF</li><li>PRESCRIBED_REGISTERED_RETIREMENT_INCOME_FUND_PRIF</li><li>GUARANTEED_INVESTMENT_CERTIFICATES_GIC</li><li>REGISTERED_DISABILITY_SAVINGS_PLAN_RDSP</li><li>DEFINED_CONTRIBUTION_PLAN</li><li>DEFINED_BENEFIT_PLAN</li><li>EMPLOYEE_STOCK_OPTION_PLAN</li><li>NONQUALIFIED_DEFERRED_COMPENSATION_PLAN_409A</li><li>KEOGH_PLAN</li><li>EMPLOYEE_RETIREMENT_ACCOUNT_ROTH_401K</li><li>DEFERRED_CONTINGENT_CAPITAL_PLAN_DCCP</li><li>EMPLOYEE_BENEFIT_PLAN</li><li>EMPLOYEE_SAVINGS_PLAN</li><li>HEALTH_SAVINGS_ACCOUNT_HSA</li><li>COVERDELL_EDUCATION_SAVINGS_ACCOUNT_ESA</li><li>TESTAMENTARY_TRUST</li><li>ESTATE</li><li>GRANTOR_RETAINED_ANNUITY_TRUST_GRAT</li><li>ADVISORY_ACCOUNT</li><li>NON_PROFIT_ORGANIZATION_501C</li><li>HEALTH_REIMBURSEMENT_ARRANGEMENT_HRA</li><li>INDIVIDUAL_SAVINGS_ACCOUNT_ISA</li><li>CASH_ISA</li><li>STOCKS_AND_SHARES_ISA</li><li>INNOVATIVE_FINANCE_ISA</li><li>JUNIOR_ISA</li><li>EMPLOYEES_PROVIDENT_FUND_ORGANIZATION_EPFO</li><li>PUBLIC_PROVIDENT_FUND_PPF</li><li>EMPLOYEES_PENSION_SCHEME_EPS</li><li>NATIONAL_PENSION_SYSTEM_NPS</li><li>INDEXED_ANNUITY</li><li>ANNUITIZED_ANNUITY</li><li>VARIABLE_ANNUITY</li><li>ROTH_403B</li><li>SPOUSAL_IRA</li><li>SPOUSAL_ROTH_IRA</li><li>SARSEP_IRA</li><li>SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP</li><li>OFFSHORE_TRUST</li><li>IRREVOCABLE_LIFE_INSURANCE_TRUST</li><li>INTERNATIONAL_TRUST</li><li>LIFE_INTEREST_TRUST</li><li>EMPLOYEE_BENEFIT_TRUST</li><li>PRECIOUS_METAL_ACCOUNT</li><li>INVESTMENT_LOAN_ACCOUNT</li><li>GRANTOR_RETAINED_INCOME_TRUST</li><li>PENSION_PLAN</li><li>DIGITAL_WALLET</li><li>OTHER</li></ul><b>loan</b><ul><li>MORTGAGE</li><li>INSTALLMENT_LOAN</li><li>PERSONAL_LOAN</li><li>HOME_EQUITY_LINE_OF_CREDIT</li><li>LINE_OF_CREDIT</li><li>AUTO_LOAN</li><li>STUDENT_LOAN</li><li>HOME_LOAN</li></ul><b>insurance</b><ul><li>AUTO_INSURANCE</li><li>HEALTH_INSURANCE</li><li>HOME_INSURANCE</li><li>LIFE_INSURANCE</li><li>ANNUITY</li><li>TRAVEL_INSURANCE</li><li>INSURANCE</li></ul><b>realEstate</b><ul> <li>REAL_ESTATE</li></ul><b>reward</b><ul><li>REWARD_POINTS</li></ul><b>Manual Account Type</b><br><b>bank</b><ul><li>CHECKING</li><li>SAVINGS</li><li>CD</li><li>PREPAID</li></ul><b>credit</b><ul> <li>CREDIT</li></ul><b>loan</b><ul> <li>PERSONAL_LOAN</li><li>HOME_LOAN</li></ul><b>insurance</b><ul><li>INSURANCE</li><li>ANNUITY</li></ul><b>investment</b><ul><li>BROKERAGE_CASH</li></ul><br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: All containers<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"originationDate": {
"type": "string",
"description": "The date on which the loan is disbursed.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true
},
"totalVestedBalance": {
"$ref": "#/components/schemas/Money"
},
"rewardBalance": {
"type": "array",
"description": "Information of different reward balances associated with the account.<br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: reward<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/RewardBalance"
}
},
"sourceAccountStatus": {
"type": "string",
"description": "Indicates the status of the loan account. <br><br><b>Aggregated / Manual</b>: Aggregated<br><b>Applicable containers</b>: loan<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul><b>Applicable Values:</b><br>",
"readOnly": true,
"enum": [
"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<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: realEstate<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET dataExtracts/userData</li></ul>",
"readOnly": true,
"items": {
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/envestnet/refs/heads/main/json-schema/envestnet-creditacceleratoraccount-schema.json