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

Data Model

The Insights Data Model explains the details of the information supplied by the Insights APIs. This helps you understand the structure and details of entities contained in the data returned by our services. Here you can view the supported list of attributes, their data types, and the valid set of values for an attribute.

Entity: customerSubscription/userSubscription

Attribute Name Type Description Endpoints
insightName String The unique name of each insight in the system. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
insightTitle String The title of the insight. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
insightType String Indicates that the insight is generated at an entity ID or a transaction ID-level.
Valid Values: Enums: Insight Type
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
triggerType String Indicates how an insight will be triggered in the system.
Valid Values: Enums: Trigger Type
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
containers
(Api-Version 2.1)
String An array of services or containers supported for generating an Insight. For example, if a particular Insight supports container=['BANK','CARD'], then the insight notification generated will only evaluate the bank and credit card accounts data of the user.
Valid Values: BANK, CARD, LOAN, INVESTMENT, INSURANCE, REALESTATE, REWARD, BILL, OTHERASSETS, and OTHERLIABILITIES.
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
container
(Api-Version 2)
description String The description of the insight. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
applicableEntity String The name of the entities for which an insight can be configured.
Valid Values: Enums: Entity
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
customerConfiguration Entity[] The details of applicable entities set by the customer for an insight. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
userConfiguration Entity[] The details of applicable entities for an insight set by the user. GET insights/configs/userSubscriptions

Entity: customerConfiguration/userConfiguration

Attribute Name Type Description Endpoints
entityId String The unique ID which references a specific entityType. Users set preferences at a specific entityId-level. If the entityType is ACCOUNT then this field represents accountId and if the entityType is VIEW then this field represents viewId.
Note: The entityId is returned as part of userConfiguration values.
GET insights/configs/userSubscriptions
entityType String Indicates for which entity the configuration will be applicable i.e., ACCOUNT or VIEW entity. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
isSubscribed Boolean Indicates if the insight is subscribed for the entity. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
threshold Entity [] The threshold values for each insight of an entity. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
duration String The time duration for which the data will be evaluated to generate an insight.
Valid Values: Enums: Duration
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
frequency String The trigger evaluation frequency of a scheduled-based insight.
Valid Values: Enums: Frequency
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions

Entity: threshold

Attribute Name Type Description Endpoints
name String The trigger threshold name based on which the insight is generated.
Note: Threshold is fixed for each insight. Only value is editable.
Valid Values: Enums: Threshold Name
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
GET /insights/feed
value String The trigger threshold value based on which the insight is generated. The value can be 0 only if there are multiple thresholds for the same insight. GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
GET /insights/feed
type String The trigger threshold type based on which the insight is generated.
Note: For a single insight, there can be multiple threshold types such as amount or percent. If multiple thresholds have values (a non-zero number), the relationship between the thresholds will be logical AND.
Valid Values: Enums: Threshold Type
GET insights/configs/customerSubscriptions
GET insights/configs/userSubscriptions
GET /insights/feed

Entity: feed

Attribute Name Type Description Endpoints
id String The unique BSON identifier of the insight notification. GET /insights/feed
insightName String The name of the insight for which feed is generated. GET /insights/feed
insightTitle String The title of the insight. GET /insights/feed
insightType String Indicates that the insight is generated at an entity ID or a transaction ID level.
Valid Values: Enums: Insight Type
GET /insights/feed
triggerType String Indicates how an insight notification will be triggered in the system.
Valid Values: Enums: Insight Type
GET /insights/feed
createdDate String The date and time in UTC format when the insight notification is generated. GET /insights/feed
subscription Entity The details of the configurations that are applied for the specific insight. GET /insights/feed
basicAccount Entity[] The details of one or more aggregated accounts. GET /insights/feed
basicView Entity[] The details of one or more user/system-created views. GET /insights/feed
bankAccount Entity[] The details of one or more aggregated bank accounts. GET /insights/feed
cardAccount Entity[] The details of one or more aggregated card accounts. GET /insights/feed
loanAccount Entity[] The details of one or more aggregated loan accounts. GET /insights/feed
investmentAccount Entity[] The details of one or more aggregated investment accounts. GET /insights/feed
realEstateAccount Entity[] The details of one or more aggregated real estate accounts. GET /insights/feed
basicMerchants Entity[] The details of the associated merchant.
Note: Applies only to the LONG_TENURE_RECURRING_PAYMENTS insight in Api-Version 2.1.
GET /insights/feed
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
basicPredictedEvents Entity[] The details of one or more predicted events as identified by the system.
Note: Applies only to the following insights in Api-Version 2.1:
  • LONG_TENURE_RECURRING_PAYMENTS
  • LOW_CONFIDENCE_PROJECTED_SERIES
  • LOW_CONFIDENCE_PROJECTED_SERIES_ALL_ACCOUNTS
GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed
basicTrend Entity[] The details of trend, broken down by a specific frequency, for a specific date range. GET /insights/feed
netWorthTrend Entity[] The details of the net worth trend information, broken down by a specific frequency, for a specific date range. GET /insights/feed
accountDerived Entity[] The derived details across one or more aggregated accounts. GET /insights/feed
viewDerived Entity[] The derived details for a specific view. GET /insights/feed
transactionDerived Entity[] The derived details across one or more aggregated transactions. GET /insights/feed
changeValue Entity[] The change details identified for an applicable attribute across two different time periods. GET /insights/feed
basicCategoryDetail Entity[] The details of a specific master category assigned to the transaction. GET /insights/feed
basicDetailCategoryDetail Entity[] The details of a specific detail category assigned to the transaction. GET /insights/feed
basicCategoryTypeDetail Entity[] The derived details across one or more category types. GET /insights/feed
basicDetailCategory Entity[] The details of one or more detail category. GET /insights/feed
basicMerchantDetail Entity[] The details of the derived merchant's spending. GET /insights/feed
basicCreditCardUtilizations Entity[] The derived details across one or more aggregated card accounts.
Note: Applies only to the CREDIT_UTILIZATION_ALL_CARDS insight in Api-Version 2.1.
GET /insights/feed
basicCreditCardUtilization Entity[] The derived details across one or more aggregated card accounts. GET /insights/feed
statementDerived Entity[] The details of one or more aggregated statements. GET /insights/feed
userDetail Entity[] The details of the user such as geo location, income, home ownership status etc. GET /insights/feed
categoryTypeDerived Entity[] The details derived at categoryType level. GET /insights/feed
predictedInfoDerived Entity[] The predicted balance details aggregated across all accounts at each date level. GET /insights/feed

Entity: subscription

Attribute Name Type Description Endpoints
entityId String Indicates the entity ID i.e., account ID for the account entity and view ID for the view entity.
Note: The entityId field will only be available for the OTHER insight type.
GET /insights/feed
entityType String Indicates for which entity the configuration will be applicable i.e., ACCOUNT or VIEW entity. GET /insights/feed
threshold Entity[] The threshold values for each insight of an entity. GET /insights/feed
duration String The time duration for which the data is considered to generate an insight notification.
Valid Values: Enums: Duration
GET /insights/feed 
frequency String The trigger evaluation frequency of a scheduled-based insight.
Valid Values: Enums: Frequency
GET /insights/feed

Entity: basicAccount

Attribute Name Type Description Endpoints
id Integer The unique identifier of the account. GET /insights/feed
providerName String The service provider or financial institution name to whom the account belongs to. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed 
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountStatus String Indicates if the account status is ACTIVE, CLOSED, or TO_BE_CLOSED. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service.
Valid Values: bank and creditCard.
GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
basicTransaction Entity[] The details of one or more aggregated transactions. GET /insights/feed
basicTrend Entity[] The details of the trend, broken down by a specific frequency, for a specific date range. GET /insights/feed
changeValue Entity The change details identified for an applicable attribute across two different time periods. GET /insights/feed
cashFlowTrend Entity The details of the cash flow trends, broken down by a specific frequency, for a specific date range. GET /insights/feed
basicCategoryDetail Entity The details of a specific master category. GET /insights/feed
message Entity The information about customized text messages associated with insight. GET /insights/feed
accountDerived Entity The derived information across one or more aggregated accounts. GET /insights/feed
errorInfo Entity The details of the error encountered while refreshing a specific aggregated account. GET /insights/feed
Attribute Name Type Description Endpoints
entityName String The name of the entity i.e., account, view, or transaction. GET /insights/feed
method String The method that is used to call the URL. GET /insights/feed
url String The URL to access the endpoint. GET /insights/feed

Entity: basicTransaction

Attribute Name Type Description Endpoints
id Integer A unique identifier for the transaction. The combination of the ID and account container is unique in the system. GET /insights/feed
amount Money The total transaction amount and currency as it appears at the FI site. GET /insights/feed
date String The postDate or the transactionDate. The postDate takes higher priority than the transactionDate, except for the investment container as the only transactionDate is available. The availability of postDate or transactionDate depends on the provider site. GET /insights/feed
categoryId String The ID of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
category String The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
link Entity The reference path details to retrieve more information of the specific entity. GET /insights/feed
categoryType String The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
baseType String Indicates if the transaction appears as a debit or a credit transaction in the account.
Valid Values: Enums: Transaction Base Type
GET /insights/feed
description Entity Details of the transaction description. GET /insights/feed
sourceType String The source through which the transaction is added to the Yodlee system.
Valid Values: Enums: Source Type
GET /insights/feed
merchantType String Provides further information about a transaction, i.e., if the transaction is carried out on a biller, a subscriber, or other.
Valid Values: Enums: Merchant Type
GET /insights/feed
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed

Entity: description

Attribute Name Type Description Endpoints
original String Original transaction description as it appears at the FI site. GET /insights/feed
simple String The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the user, and this simplified transaction description is provided in the simple description field.
Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.
GET /insights/feed
consumer String The description of the transaction as defined by the user. The user can define or provide more details of the transaction in this field. GET /insights/feed
name String The name of the merchant associated with the transaction.
Note: The merchant name field is available only in the United States, Canada, United Kingdom, and India
GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed

Entity: basicMerchants

Applies only to the LONG_TENURE_RECURRING_PAYMENTS insight in Api-Version 2.1.

Attribute Name Type Description Endpoints
name String The name of the merchant associated with the transaction.
Note: The merchant name field is available only in the United States, Canada, United Kingdom, and India.
GET /insights/feed
address Address The address information associated with a merchant or an account.
Note: The address field includes city, state, ZIP, etc., if available.
GET /insights/feed
basicPredictedEvents Entity[] The details of one or more predicted events as identified by the system.
Note: Applies only to the following insights in Api-Version 2.1:
  • LONG_TENURE_RECURRING_PAYMENTS
  • LOW_CONFIDENCE_PROJECTED_SERIES
  • LOW_CONFIDENCE_PROJECTED_SERIES_ALL_ACCOUNTS
GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed

Entity: basicMerchant

Attribute Name Type Description Endpoints
name String The name of the merchant associated with the transaction.
Note: The merchant name field is available only in the United States, Canada, United Kingdom, and India.
GET /insights/feed
address Address The address information associated with a merchant or an account.
Note: The address field includes city, state, ZIP, etc., if available.
GET /insights/feed
basicPredictedEvents Entity[] The details of one or more predicted events as identified by the system.
Note: Applies only to the following insights in Api-Version 2.1:
  • LONG_TENURE_RECURRING_PAYMENTS
  • LOW_CONFIDENCE_PROJECTED_SERIES
  • LOW_CONFIDENCE_PROJECTED_SERIES_ALL_ACCOUNTS
GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed

Entity: basicPredictedEvents

Applies only to the following insights in Api-Version 2.1: LONG_TENURE_RECURRING_PAYMENTS, LOW_CONFIDENCE_PROJECTED_SERIES, LOW_CONFIDENCE_PROJECTED_SERIES_ALL_ACCOUNTS

Attribute Name Type Description Endpoints
id Number The unique identifier of the predicted event. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
categoryId String The ID of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
category String The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
basicTransaction Entity[] The details of one or more aggregated transactions. GET /insights/feed
lastTrasactionAmount Money The amount of the last aggregated transaction that was used to predict the event. GET /insights/feed
lastTransactionDate String The date of the last aggregated transaction. GET /insights/feed
frequency String The trigger evaluation frequency of a predicted event. GET /insights/feed
confidence String The confidence score that was used to predict the event. GET /insights/feed
confidenceLevel String A combination of the confidence score and other intelligence from the Yodlee algorithm.
Valid Values: Enums: Confidence Level
GET /insights/feed
userApprovalStatus String The predicted event is approved or pending.
Valid Values: Enums: User Approval Status
GET /insights/feed
basicAccount Entity[] The details of one or more aggregated accounts. GET /insights/feed

Entity: basicPredictedEvent

Attribute Name Type Description Endpoints
id Number The unique identifier of the predicted event. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
categoryId String The ID of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
category String The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
basicTransaction Entity[] The details of one or more aggregated transactions. GET /insights/feed
lastTrasactionAmount Money The amount of the last aggregated transaction that was used to predict the event. GET /insights/feed
lastTransactionDate String The date of the last aggregated transaction. GET /insights/feed
frequency String The trigger evaluation frequency of a predicted event. GET /insights/feed
confidence String The confidence score that was used to predict the event. GET /insights/feed
confidenceLevel String A combination of the confidence score and other intelligence from the Yodlee algorithm.
Valid Values: Enums: Confidence Level
GET /insights/feed
userApprovalStatus String The predicted event is approved or pending.
Valid Values: Enums: User Approval Status
GET /insights/feed
basicAccount Entity[] The details of one or more aggregated accounts. GET /insights/feed

Entity: basicTrend

Attribute Name Type Description Endpoints
dateRange Entity The date range identified by fromDate and toDate. GET /insights/feed
debitTotal Money The sum of all debit transactions. GET /insights/feed
creditTotal Money The sum of all credit transactions. GET /insights/feed
netCreditTotal Money The net total amount calculated as (creditTotal - debitTotal). GET /insights/feed
netTotal Money The net spending amount calculated as debitTotal - creditTotal. GET /insights/feed
averageNetTotal Money The average spending amount calculated as netTotal / number of months. GET /insights/feed
transactionCount Integer The total transaction count for the specified date range. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed
categoryTrend Entity[] The details of the category trends, broken down by a specific frequency, for a specific date range. GET /insights/feed
merchantTrend Entity[] The details of the merchant trends, broken down by a specific frequency, for a specific date range. GET /insights/feed
netWorthTrend Entity[] The details of the net worth trend information, broken down by a specific frequency, for a specific date range. GET /insights/feed
detailCategoryTrend Entity[] The detail-category trend information, broken down by a specific frequency, for a specific date range. GET /insights/feed

Entity: detail

Attribute Name Type Description Endpoints
dateRange String The date range considered to compute the values identified by fromDate and toDate. GET /insights/feed
debitTotal Money The sum of all debit transactions for the given date range. GET /insights/feed
creditTotal Money The sum of all credit transactions for the given date range. GET /insights/feed
netCreditTotal Money The net total amount calculated as creditTotal - debitTotal. GET /insights/feed
netTotal Money The net spending amount calculated as debitTotal - creditTotal. GET /insights/feed
transactionCount String The total transaction count for the specified date range. GET /insights/feed
networthDetail Entity[] The details of all the aggregated accounts calculated as (total of all assets) - (total of all liabilities). GET /insights/feed
assetDetail Entity[] The details of all the aggregated accounts categorized as assets. GET /insights/feed
liabilityDetail Entity[] The details of all the aggregated accounts categorized as liability. GET /insights/feed

Entity: networthDetail

Attribute Name Type Description Endpoints
networthTotal Money The total net worth value. GET /insights/feed

Entity: assetDetail

Attribute Name Type Description Endpoints
assetTotal Money The total asset value. GET /insights/feed

Entity: liabilityDetail

Attribute Name Type Description Endpoints
liabilityTotal Money The total liability value. GET /insights/feed

Entity: categoryTrend

Attribute Name Type Description Endpoints
categoryId String The ID of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
category String The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
debitTotal Money The sum of all debit transactions associated with the category for the specific duration. GET /insights/feed
creditTotal Money The sum of all credit transactions associated with the category for the specific duration. GET /insights/feed
netTotal Money The net spending amount (calculated as debitTotal - creditTotal) associated with the category for the specific duration. GET /insights/feed
avergaeNetTotal Money The average spending amount (calculated as netTotal / number of months) associated with the category for the specific duration. GET /insights/feed
basicPeerDetail Entity[] The basic details of the peer. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed
categoryDerived Entity[] The derived information across one or more categories. GET /insights/feed

Entity: basicPeerDetail

Attribute Name Type Description Endpoints
dateRange Entity The date range considered to compute the benchmark values GET /insights/feed
benchmarkAsOf String Indicates the date when the benchmark detail is computed. The benchmark is re-computed on the 16th of each month GET /insights/feed
benchmark Entity[] Provides the peer benchmarking data at the geolocation. GET /insights/feed

Entity: dateRange

Attribute Name Type Description Endpoints
fromDate String The date from which data is considered to compute the values. Expected format: yyyy- MM-dd'T'HH:mm:ss.
Note: The date is in the UTC timezone instead of the local timezone.
GET /insights/feed
toDate String The date to which data is considered to compute the values. Expected format - yyyy- MM-dd'T'HH:mm:ss.
Note: The date is in the UTC timezone instead of the local timezone.
GET /insights/feed

Entity: benchmark

Attribute Name Type Description Endpoints
geo Entity The geolocation details of the user. GET /insights/feed
benchmarkLevel String The benchmark level details i.e., NATIONAL, STATE, and PEER. GET /insights/feed
netTotal Money The median amount spent by the user in a specified category or merchant. GET /insights/feed
numberOfPeers Integer The total number of peers in the segment to reach the benchmark amount. GET /insights/feed

Entity: geo

Attribute Name Type Description Endpoints
level String Provides the details of geography-level i.e., one of the city, state, or national. GET /insights/feed
value String The value corresponding to the geography level. For example, if the level is NATIONAL then the value is the US. GET /insights/feed

Entity: merchantTrend

Attribute Name Type Description Endpoints
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
debitTotal Money The sum of all debit transactions associated with the merchant. GET /insights/feed
creditTotal Money The sum of all credit transactions associated with the merchant. GET /insights/feed
netTotal Money The net spending amount (calculated as debitTotal - creditTotal) associated with the merchant for the specific duration. GET /insights/feed
avergaeNetTotal Money The average spending amount (calculated as netTotal / number of months) associated with the merchant for the specific duration. GET /insights/feed
basicPeerDetail Entity[] The basic details of the peer. GET /insights/feed
transactionCount String The total count of transactions for the specified date range. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed

Entity: detailCategoryTrend

Attribute Name Type Description Endpoints
detailCategoryId String The unique identifier of the detail category assigned to the transaction. GET /insights/feed
detailCategoryName String The name of the detail category assigned to the transaction. GET /insights/feed
debitTotal Money The sum of all debit transactions associated with the detail category for the specific duration. GET /insights/feed
creditTotal Money The sum of all credit transactions associated with the detail category for the specific duration. GET /insights/feed
netTotal Money The net credit spending amount (calculated as debitTotal - creditTotal) associated with the detail category for the specific duration. GET /insights/feed
avergaeNetTotal Money The average spending amount (calculated as netTotal / number of months) associated with the detail category for the specific duration. GET /insights/feed
basicPeerDetail Entity[] The basic details of the peer. GET /insights/feed
transactionCount String The total count of transactions for the specified date range. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed

Entity: changeValue

Attribute Name Type Description Endpoints
changeType String The value for which change is computed. GET /insights/feed
previousDate String The previous date duration that is being considered for change calculation. GET /insights/feed
previousAmount Money The amount as of the previous date that is being considered for change calculation. GET /insights/feed
currentDate String The current date duration that is being considered for change calculation. GET /insights/feed
currentAmount Money The amount as of the current duration that is being considered for change calculation. GET /insights/feed
changeAmount Money The change amount is calculated as changeAmount/previousAmount. GET /insights/feed
changePercent Number The change percent is calculated as changeAmount/previousAmount * 100. GET /insights/feed

Entity: cashFlowTrend

Attribute Name Type Description Endpoints
cashInFlow Money The total cash inflow amount is the sum of the cash inflow in each of the selected months for the specified duration. GET /insights/feed
cashOutFlow Money The total cash outflow amount is the sum of the cash outflow in each of the selected months in the specified duration. GET /insights/feed
transferIn Money The total transfer-in amount is the sum of the transfer-in amount in each of the selected months in the specified duration. GET /insights/feed
transferOut Money The total transfer-out amount is the sum of the transfer-out amount in each of the selected months in the specified duration. GET /insights/feed
netTransfer Money The net transfer amount is the sum of all netTransfer amounts for the specified duration from the detail entity. GET /insights/feed
averageNetCashFlow Money The average net cash flow (calculated as totalCashFlow amounts for the specified duration from the detail entity/Number of months) in the specified duration. GET /insights/feed
totalCashFlow Money The total cash flow amount is sum of the all totalCashFlow amounts for the specified duration from the detail entity. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed

Entity: detail

Attribute Name Type Description Endpoints
cashInFlow Money The total cash inflow amount is calculated as (All the credit transactions of income categories - All the debit transactions of income categories) + Uncategorized credit transactions. GET /insights/feed
cashOutFlow Money The total cash outflow amount is calculated as (All the debit transactions of expense categories - All the credit transactions of expense categories) + Uncategorized debit transactions. GET /insights/feed
transferIn Money The total transfer-in amount is calculated as the sum of all the credit transactions of transfer categories. GET /insights/feed
transferOut Money The total transfer-out amount is calculated as the sum of all the debit transactions of transfer categories. GET /insights/feed
netTransfer Money The net transfer amount is the difference between transferIn and transferOut amount in the selected duration. GET /insights/feed
totalCashFlow Money The total cash flow amount calculated as cashInFlow - cashOutFlow + netTransfer. GET /insights/feed

Entity: basicCategoryDetail

Attribute Name Type Description Endpoints
categoryId String The ID of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
category String The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights/feed
netTotal Money The net spending (calculated as debitTotal - creditTotal) associated with the category for the specific duration. GET /insights/feed
averageNetTotal Money The average spending (calculated as netTotal/Number of Months) associated with the category for the specific duration. GET /insights/feed
basicPeerDetail Entity The basic details of the peer. GET /insights/feed
peerSpendingComparison Entity The comparison details of how the user has spent in a category compared to the other peers. GET /insights/feed

Entity: basicDetailCategoryDetail

Attribute Name Type Description Endpoints
detailCategoryId String The ID of the detail category assigned to the transaction. GET /insights/feed
detailCategoryName String The name of the detail category assigned to the transaction. GET /insights/feed
netTotal Money The net spending (calculated as debitTotal - creditTotal) associated with the detail category for the specific duration. GET /insights/feed

Entity: peerSpendingComparison

Attribute Name Type Description Endpoints
peerSpendDifference Money The difference between the spending amount of users and peers for a specific category or merchant. GET /insights/feed
peerSpendDifferencePercent Number The difference percentage between the spending amount of user and peers for a specific category or merchant. GET /insights/feed
isOverSpending Boolean Indicates whether the user has spent more than the peers. GET /insights/feed
isUnderSpending Boolean Indicates whether the user has spent less than the peers. GET /insights/feed

Entity: categoryDerived

Attribute Name Type Description Endpoints
dateRange String The date range identified by fromDate and toDate that is used to compute the values. GET /insights/feed
averageNetTotal Money The average spending amount calculated as netTotal / number of months. GET /insights/feed

Entity: message

Attribute Name Type Description Endpoints
messageText String The pre-defined text-block associated with the insight. GET /insights/feed

Entity: accountDerived

Attribute Name Type Description Endpoints
totalAvailableBalance Money The total available balance across eligible accounts. GET /insights/feed
discretionaryBalance Money The total balance available to spend after considering projected income and expenses. GET /insights/feed
averageSpending Money The average monthly spending for the given duration. GET /insights/feed
averageAvailableBalance Money The average available balance across one or more accounts. GET /insights/feed
spendingRunway Number Based on the average spending, the duration in days for which the total available balance will last. GET /insights/feed

Entity: errorInfo

Attribute Name Type Description Endpoints
errorStatus String The status of the error. GET /insights/feed
errorDescription String The description of the error. GET /insights/feed
lastUpdated String The date when the error is last updated. GET /insights/feed
lastUpdateAttemp String Indicates when the last attempt was performed to update the error status. GET /insights/feed

Entity: basicView

Attribute Name Type Description Endpoints
id String The unique identifier of the view entity. GET /insights/feed
name String The name of the view. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
basicAccount Entity[] The details of one or more aggregated accounts. GET /insights/feed
cardAccount Entity[] The details of one or more aggregated card accounts. GET /insights/feed
basicTrend Entity[] The details of trend, broken down by a specific frequency, for a specific date range. GET /insights/feed

Entity: bankAccount

Attribute Name Type Description Endpoints
id Integer The unique identifier for the account. GET /insights/feed
providerName String The service provider or financial institution name to whom the account belongs. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service.
Valid Values: bank and creditCard.
GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
lastUpdated String Indicates when the dataset is last updated successfully for the given provider account. GET /insights/feed
availableBalance Money The balance in the account that is available for spending. For checking accounts with an overdraft, the available balance may include overdraft amount, if the end site adds overdraft balance to the available balance. GET /insights/feed
currentBalance Money The balance in the account that is available at the beginning of the business day; is equal to the ledger balance of the account. GET /insights/feed
balance Money The available balance or current balance in the account. GET /insights/feed
basicPredictedEvent Entity[] The details of one or more predicted events as identified by the system. GET /insights/feed
basicTransaction Entity[] The details of one or more aggregated transactions. GET /insights/feed
predictedInfo Entity The predicted information based on one or more eligible accounts. GET /insights/feed

Entity: predictedInfo

Attribute Name Type Description Endpoints
dateRange String The date range identified by fromDate and toDate that is used to compute the values. GET /insights/feed
date String The date for which predicted balance information is provided. GET /insights/feed
predictedBalance Money The predicted balance for a given date range or a specific date. GET /insights/feed
predictedIncome Money The predicted income for a given date range or a specific date. GET /insights/feed
predictedExpense Money The predicted expense for a given date range or a specific date. GET /insights/feed
predictedDiscretionaryBalance Money The predicted discretionary balance for a given date range or a specific date. GET /insights/feed

Entity: predictedInfoDerived

Attribute Name Type Description Endpoints
predictedBalance Money The predicted balance across a single account as of given date. GET /insights/feed
date String The date for which predicted balance information is provided in yyyy-mm-dd format. GET /insights/feed
accountIds String The list of account IDs that contributed in the predicted balance.
Note: Applies only to the following insights in Api-Version 2.1:
  • UPCOMING_BILLS_ALL_ACCOUNTS
  • UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS
  • UPCOMING_BILLS_AND_SUBSCRIPTIONS_ALL_ACCOUNTS
GET /insights/feed
accountId String The list of account IDs that contributed in the predicted balance. GET /insights/feed

Entity: cardAccount

Attribute Name Type Description Endpoints
id Integer The primary key of the account resource and the unique identifier for the account. GET /insights/feed
providerName String The service provider or financial institution name to whom the account belongs. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service i.e., creditCard. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
address String The address details available on the card. GET /insights/feed
lastUpdated String Indicates when the dataset is last updated successfully for the given provider account. GET /insights/feed
runningBalance Money The amount that is currently owed in the credit card account. GET /insights/feed
totalCreditLine Money The amount of money that can be charged to a credit card. If the credit limit of $5,000 is issued on a credit card, the total charges on the card cannot exceed this amount. GET /insights/feed
balance Money The amount that is currently owed on the credit card account. This is the same as the runningBalance amount. GET /insights/feed
amountDue Money The total amount due for the purchase of goods or services that must be paid by the due date. GET /insights/feed
basicTransaction Entity[] The details of one or more aggregated transactions. GET /insights/feed
basicCreditCardUtilization Entity Derived information across one or more aggregated card accounts. GET /insights/feed
basicStatement Entity[] The details of one or more aggregated statements. GET /insights/feed
predictedInfo Entity[] The predicted information based on one or more eligible accounts. GET /insights/feed
changeAPR Entity The change in APR for an aggregated card account. GET /insights/feed

Entity: basicCreditCardUtilizations

Applies only to the CREDIT_UTILIZATION_ALL_CARDS insight in Api-Version 2.1.

Attribute Name Type Description Endpoints
totalRunningBalance Money Total running balance across one or more card accounts. GET /insights/feed
totalCreditLine Money Total credit line across one or more card accounts. GET /insights/feed
totalCreditUtilizationPercent Number The total credit utilization percent i.e., calculated as totalRunningBalance/totalCreditLine* 100. GET /insights/feed
creditUtilizationPercent Number The single card credit utilization percent calculated as totalRunningBalance/totalCreditLine* 100. GET /insights/feed

Entity: basicCreditCardUtilization

Attribute Name Type Description Endpoints
totalRunningBalance Money Total running balance across one or more card accounts. GET /insights/feed
totalCreditLine Money Total credit line across one or more card accounts. GET /insights/feed
totalCreditUtilizationPercent Number The total credit utilization percent i.e., calculated as totalRunningBalance/totalCreditLine* 100. GET /insights/feed
creditUtilizationPercent Number The single card credit utilization percent calculated as totalRunningBalance/totalCreditLine* 100. GET /insights/feed

Entity: basicStatement

Attribute Name Type Description Endpoints
id Number The unique identifier for the statement. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
statementDate String The date on which the account statement is generated. GET /insights/feed
dueDate String The date by when the minimum payment is due to be paid.
Note: The due date that appears in the statement may differ from the due date at the account level.
GET /insights/feed
billingPeriodStart String The date from which the statement details appear. GET /insights/feed
billingPeriodEnd String The date to which the statement details appear. GET /insights/feed
lastPaymentAmount Money The last payment amount made for the previous billing cycle in the current statement period. GET /insights/feed
amountDue Money The total due amount at the end of the billing period. GET /insights/feed
minPaymentDue Money The minimum amount that the user has to pay every month on the credit card account. GET /insights/feed
lastPaymentDate String The date on which the last payment was made during the billing cycle. GET /insights/feed
isLatest Boolean Indicates if the statement generated is the latest generated statement. GET /insights/feed
lastUpdated String The date when the account was last updated by Yodlee. GET /insights/feed

Entity: changeAPR

Attribute Name Type Description Endpoints
previousAPR String The previously recorded APR for a specific card account. GET /insights/feed
currentAPR String The current APR for the same card account. GET /insights/feed
change String The absolute change in APR is calculated as currentAPR - previousAPR. GET /insights/feed

Entity: loanAccount

Attribute Name Type Description Endpoints
id Integer The primary key of the account resource and the unique identifier for the account. GET /insights/feed
providerName String The service provider or financial institution name whom the account belongs to. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service i.e., loan. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
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. GET /insights/feed

Entity: investmentAccount

Attribute Name Type Description Endpoints
id Integer The primary key of the account resource and the unique identifier for the account. GET /insights/feed
providerName String The service provider or financial institution name to whom the account belongs. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service i.e., investment. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
balance Money The total balance of all the investment account, as it appears on the FI site. GET /insights/feed
basicHolding Entity[] The details of one or more securities. GET /insights/feed

Entity: basicHolding

Attribute Name Type Description Endpoints
id Number The unique identifier for the security added in the system. This is the primary key of the holding resource. GET /insights/feed
accountId Number The associated unique ID of the account. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
holdingType String Indicates the type of security like stocks, mutual fund, etc. The list of supported holding types is provided in GET holdings/holdingTypeList. GET /insights/feed
maturityDate String The stated maturity date of a bond or CD. GET /insights/feed
qty String The quantity held for the holding. The qty field applies to all holding types except restricted stock units/awards, performance units, currency, and commodity.
Note: For bonds, the qty field indicates the normalized quantity, not the quantity aggregated from the site. For the insurance container, the field applies only to insurance annuity and variable life insurance types.
GET /insights/feed
price Money The current price of the security.
Note: For bonds, the price field indicates the normalized price, not the price aggregated from the site. For the insurance container, the field applies only to the insurance annuity and variable life insurance types.
GET /insights/feed
asOf String The date as of which the information was presented in the system. GET /insights/feed
value Money The total market value of the security. GET /insights/feed

Entity: realEstateAccount

Attribute Name Type Description Endpoints
id Integer The unique identifier for the real estate account. GET /insights/feed
providerName String The service provider or financial institution name to whom the account belongs. GET /insights/feed
accountName String The account name as it appears at the FI site. The POST accounts service response return this field as name. GET /insights/feed
accountNumber String The account number as it appears on the FI site. The POST accounts service response return this field as number. GET /insights/feed
accountType String The type of account that is aggregated such as savings, checking, charge, etc., and manual accounts.
Valid Values: Enums: Account Type
GET /insights/feed
isAsset Boolean Indicates whether the balance is an asset or liability. GET /insights/feed
container String The type of service i.e., realEstate. GET /insights/feed
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/feed
changeValue String The change identified for an applicable attribute across two different time periods. GET /insights/feed
address Address The address of the real estate is populated in the address field.
Note: The address field includes city, state, and ZIP.
GET /insights/feed

Entity: netWorthTrend

Attribute Name Type Description Endpoints
networthTotal Money The total net worth value. GET /insights/feed
assetTotal Money The total asset worth value. GET /insights/feed
liabilityTotal Money The value of the total liabilities. GET /insights/feed
detail Entity[] The details of the breakdown of income/spending based on a predefined frequency - typically, monthly. GET /insights/feed

Entity: detail

Attribute Name Type Description Endpoints
dateRange String The date range identified by fromDate and toDate. GET /insights/feed
networthDetail Entity[] The details of all the aggregated accounts calculated as (total of all assets) - (total of all liabilities). GET /insights/feed
assetDetail Entity[] The details of all the aggregated accounts categorized as assets. GET /insights/feed
liabilityDetail Entity[] The details of all the aggregated accounts categorized as a liability. GET /insights/feed

Entity: networthDetail

Attribute Name Type Description Endpoints
networthTotal Money The total net worth value. GET /insights/feed

Entity: viewDerived

Attribute Name Type Description Endpoints
creditTotal Money The total of all credit transactions that qualify to be part of the view. GET /insights/feed
debitTotal Money The total of all debit transactions that qualify to be part of the view. GET /insights/feed
remainingBudget Money The difference between the budget set for the view and the debitTotal. GET /insights/feed

Entity: transactionDerived

Attribute Name Type Description Endpoints
creditTotal Money The sum of all credit transactions. GET /insights/feed
debitTotal Money The sum of all debit transactions. GET /insights/feed
totalUnpaidBills String The total number of unpaid bills identified. If the threshold TOP is applied, this number may not match with the number of bills returned in the insight. GET /insights/feed
spentPercent String The ratio of expense to income based on the last 3-month average. The spend percent is calculated as debitTotal/creditTotal*100. GET /insights/feed
totalSpending Money The total spending amount of the derived transactions. GET /insights/feed
averageSpending Money The average spending amount of the derived transactions. GET /insights/feed
debtToIncomeRatio Number Debt to income ratio calculated as (monthly recurring debt /averageMonthlyIncomecode>) * 100 GET /insights/feed
averageMonthlyIncome Money Average monthly income for the duration. GET /insights/feed
monthlyRecurringPaymentTotal Money Identified monthly recurring payments for the user derived from minimum due amount across all cards, loan payments, rent payments, mortgage payments, alimony, child care support, and recurring bills. GET /insights/feed
dateRange Entity The date range is considered to compute the values GET /insights/feed

Entity: basicCategoryTypeDetail

Attribute Name Type Description Endpoints
categoryType String The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. The category types are -INCOME, EXPENSE, TRANSFER, DEFERRED_COMPENSATION, or UNCATEGORIZE. GET /insights/feed
creditTotal Money The sum of all credit transactions associated with the category for the specific duration. GET /insights/feed
debitTotal Money The sum of all debit transactions associated with the category for the specific duration. GET /insights/feed
netTotal Money The net spending (calculated as debitTotal - creditTotal) associated with the category for the specific duration. GET /insights/feed
dateRange Entity The date range identified by fromDate and toDate. GET /insights/feed
basicCategoryDetail Entity[] The details of a specific master category. GET /insights/feed

Entity: basicDetailCategory

Attribute Name Type Description Endpoints
detailCategoryId String The unique identifier of the detail category assigned to the transaction. GET /insights/feed
detailCategoryName String The name of the detail category assigned to the transaction. GET /insights/feed
basicAccount Entity[] The details of one or more aggregated accounts. GET /insights/feed

Entity: basicMerchantDetail

Attribute Name Type Description Endpoints
basicMerchant Entity[] The details of the associated merchant. GET /insights/feed
merchantType String The associated merchant type - BILLERS, SUBSCRIPTION, or OTHERS. GET /insights/feed
netTotal Money The net spending (calculated as debitTotal - creditTotal) associated with the merchant for the specific duration. GET /insights/feed
averageNetTotal Money The average net spending (calculated as netTotal / Number of Months) associated with the merchant for the specific duration. GET /insights/feed
basicPeerDetail Entity The details about the peer data information. GET /insights/feed
peerSpendingComparison Entity The comparison details of how the user has spent in a category compared to the other peers. GET /insights/feed

Entity: statementDerived

Attribute Name Type Description Endpoints
cardMinimumDueTotal Money The total minimum amount due across one or more cards. GET /insights/feed

Entity: userDetail

Attribute Name Type Description Endpoints
lifeStage String The life stage details of the user. GET /insights/feed
geo Entity The geo location details of the user. User can provide City, State, Nation, and ZIP code details. GET /insights/feed
income Money The total income details of the user. GET /insights/feed
homeOwnership String The home ownership status of the user. GET /insights/feed

Entity: categoryTypeDerived

Attribute Name Type Description Endpoints
categoryType String The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories. GET /insights /feed
totalSpending Money The total amount spent by the user in the defined dateRange and categoryType GET /insights /feed
dateRange Entity The date range is considered to compute the values. GET /insights /feed

Entity: segment

Attribute Name Type Description Endpoints
id String The system-generated unique segment identifier. GET /user/segments
lifeStage String The life stages of the user i.e., STUDENT, EMPLOYED, UNEMPLOYED, or RETIRED. GET /user/segments
incomeRange String A user income range given by the user. Applicable values are: $0K - $35K, $35K - $50K, $50K - $75K, $75K - $100K, $100K - $150K, and $150K+. GET /user/segments
age Integer A unique Identifier for user's age stored in insights database entered by the user. This attribute is optional and is present for a segment that is created for the given user. GET /user/segments
geoLocation Entity The geo location details of the user. GET /user/segments
income Money The total income of the user. GET /user/segments
networth Money The total net worth of the user. GET /user/segments
homeOwnership Boolean Indicates the homeownership of the user. GET /user/segments

Entity: geoLocation

Attribute Name Type Description Endpoints
state String The state details of the user. GET /user/segments
city String The city details of the user. GET /user/segments
country String The country details of the user. GET /user/segments
zipcode String The ZIP code details of the user. GET /user/segments

Entity: entityDetail

Attribute Name Type Description Endpoints
entityType String Indicates for which entity the configuration applies to i.e., ACCOUNT or VIEW entity.  GET /insights/entityDetail
entityId String The unique ID which references a specific entityType for which the insight is generated. If the entity ID is ACCOUNT then this field represents account ID and if the entity ID is VIEW then this field represents view ID.
Note: The entityId is returned as part of userConfiguration values. Indicates for which entity the configuration applies to i.e., ACCOUNT or VIEW entity.
GET /insights/entityDetail
container String An array of services or containers supported for an Insight.
Valid Values: BANK, CARD, LOAN, INVESTMENT, and INSURANCE.
GET /insights/entityDetail
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/entityDetail
eligibleInsight Entity[] The insight details for which feed is generated. GET /insights/entityDetail

Entity: eligibleInsight

Attribute Name Type Description Endpoints
insightName String The unique name of the insight for which feed is generated. GET /insights/entityDetail/{entityId}
applicableConfiguration Entity[] The details about the configurations applied for the specific insight. GET /insights/entityDetail/{entityId}

Entity: applicableConfiguration/eligibleEntity

Attribute Name Type Description Endpoints
insightName String The unique name of the insight for which feed is generated. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
insightTitle String The title of the insight. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
insightType String Indicates that the insight is generated at an entity ID or a transaction ID level.
Valid Values: Enums: Insight Type
GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
triggerType String Indicates how an insight notification will be triggered in the system.
Valid Values: Enums: Trigger Type
GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
container String An array of services or containers supported for an Insight.
Valid Values: BANK, CARD, LOAN, INVESTMENT, and INSURANCE.
GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
description String The simple description of the insight. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
applicableEntity String The name of the entities for which an insight can be configured.
Valid Values: Enums: Entity
GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
userConfiguration Entity[] The details of applicable entities set by the user for an insight. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
customerConfiguration Entity[] The details of applicable entities for an insight set by the customer. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}
link Entity The reference path details to retrieve more information about the specific entity. GET /insights/entityDetail
GET /insights/insightDetail/{insightName}

Entity: insightDetail

Attribute Name Type Description Endpoints
insightName String The unique name of the insight for which feed is generated. GET /insights/insightDetail/{insightName}
insightType String Indicates that the insight is generated at an entity ID or a transaction ID level.
Valid Values: Enums: Insight Type
GET /insights/insightDetail/{insightName}
triggerType String Indicates how an insight notification will be triggered in the system.
Valid Values: Enums: Trigger Type
GET /insights/insightDetail/{insightName}
eligibleEntity Entity[] The details about the configurations applied for the specific insight. GET /insights/insightDetail/{insightName}

Enums: Trigger Type

Trigger Type Description
SCHEDULE Insight will be triggered based on a scheduled job that has a frequency such as daily, weekly, etc., at a certain time of the day as specified by the system.
REFRESH Insight will be triggered whenever the user's account is refreshed i.e., the latest account information is aggregated from the FI site.
EVENT Insight will be triggered whenever a preconfigured internal event occurs.

Enums: Account Type

Account Type Description
CURRENT Indicates that the account is the current account.
SAVING Indicates that the account is a saving account.
CHECKING Indicates that the account is a checking account.

Enums: Transaction Base Type

Base Type Description
CREDIT Denotes that the transactions are being credited to the account.
DEBIT Denotes that the transactions are getting debited to the account.

Enums: Source Type

Source Type Description
AGGREGATED Indicates that the transaction is aggregated from the provider site.
MANUAL Indicates that the transaction is created manually by the user.
SYSTEM_PREDICTED Indicates that the transaction is predicted by the system.

Enums: Merchant Type

Merchant Type Description
BILLERS Merchants that are identified as billers in the Yodlee merchant database.
SUBSCRIPTION Merchants that are identified as subscribers in the Yodlee merchant database.
OTHERS No merchant is identified, or the merchant is not a biller or a subscriber.

Enums: Entity

Entity Description
ACCOUNT The insight is configured for the account entity.
VIEW The insight is configured for the view entity.

Enums: Insight Type

Insight Type Description
OTHER Indicates that the insight is generated at an entity-level - per account or per view.
AGGREGATED Indicates that each insight will combine data from all the valid accounts of the user to generate the insight.

Enums: Duration

Duration Description
THIS_MONTH The insight will process the current month’s data.
LAST_MONTH The insight will process the last month’s data.
THREE_MONTHS The insight will process the current month plus the last 2 months' data.
SIX_MONTHS The insight will process the current month plus the last 5 months' data.
ONE_YEAR The insight will process the current month plus the last 11 months' data.
LAST_THREE_MONTHS The insight will process the last 3 months' data.
LAST_SIX_MONTHS The insight will process the last 6 months' data.
LAST_TWELVE_MONTHS The insight will process the last 12 months' data.

Enums: Frequency

Frequency Description
DAILY The insight will be triggered daily.
WEEKLY The insight will be triggered once every Monday.
MONTHLY The insight will be triggered once on the first day of a calendar month.
MID MONTHLY The insight will be triggered once on the 16th of a calendar month.

Enums: Threshold Name

Threshold Name Description
CHANGE The insight is generated if the value change (amount or percent) is greater than the configured threshold.
UPPER_LIMIT The insight is generated if the value exceeds the configured threshold.
DAYS_BEFORE The insight is generated if a condition is satisfied configured threshold days before another event.
MINIMUM The insight is generated if the value exceeds the configured minimum threshold.
FUTURE The insight is generated for the duration that falls between the day of evaluation (T) and T plus the FUTURE threshold value.
DELAY The insight is generated if an event does not occur for the configured number of days.
TOP The insight is generated for the configured number of items sorted by the descending order of amount or frequency.

Enums: Threshold Type

Threshold Type Description
PERCENT The threshold value is in percentage.
NUMBER The threshold value is in number.
DAYS The threshold value is days.
AMOUNT The threshold value is the amount.

Enums: Confidence Level

Confidence Level Description
HIGH The confidence level is high and the predicted transactions are generated for the event.
LOW The confidence level is low and the event needs user approval to generate predicted transactions.

Enums: User Approval Status

User Approval Status Description
APPROVED The event is in approved status. Future instances are created for all approved events.
Note: An event with confidence= HIGH will always be in APPROVED status.
PENDING The event is in pending status. A pending event does not have any future instances.
Note: An event with confidence= LOW will always be in PENDING status.

Composite Data Type

Name Fields Basic Data Types
Money amount Number
currency String
convertedAmount Number
convertedCurrency String
Address address1 String
address2 String
address3 String
street String
fullAddress String
state String
city String
zip String
type String
sourceType String
country String