Aggregate Mortgage Account

Overview

The Aggregate Mortgage Account insight is a schedule-triggered insight that recommends aggregating the mortgage account. The insight is generated only if the system identifies a mortgage payment in any of the user's aggregated bank or card accounts.

Following are the additional details for the insight:

Insight Name	AGGREGATE_MORTGAGE_ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Containers	BANK, CARD
Frequency	MONTHLY
Duration	LAST_MONTH
Run Date	9^th day of the calendar month

Use Cases

Customer:
- More User Data - Build a better financial picture of the user.
User:
- A holistic view of all users’ accounts in a single place.
- More in-depth and meaningful insights with the user's full financial data in place.

Suggested Action

Provide the user an option to aggregate accounts using FastLink. For more information, see FastLink 4.0.

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Sample UI

Insight Feed

Insight Widget

GET Insight Feeds

The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, you can specifically request for the Aggregate Mortgage Account insight only.

The entityId filter does not apply to this insight.

Method and URL:

GET /insights/feed

Header Parameters:

Key	Value
`Authorization`	Client credentials-based authorization	`Bearer {{Access Token}}`
	API key-based authentication	`Bearer {{JWT Token_Customer}}`
	Deprecated cobrand and user credential-based authentication	`cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=AGGREGATE_MORTGAGE_ACCOUNT

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"60d43d99d59fdb46b0c910d2",
         "insightName":"AGGREGATE_MORTGAGE_ACCOUNT",
         "insightTitle":"Aggregate Mortgage Account",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2025-05-09T08:08:49Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH"
            }
         ],
         "basicAccount":[
            {
               "id":13709571,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709571"
               },
               "basicTransaction":[
                  {
                     "id":47306932,
                     "amount":{
                        "amount":1300.0,
                        "currency":"USD"
                     },
                     "date":"2025-04-13",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=47306932"
                     },
                     "categoryId":18,
                     "category":"Mortgages",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"Home Loan Payment",
                        "simple":"Home Loan Payment"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"BILLERS",
                     "basicMerchant":{
                        "name":"Quicken Loans"
                     }
                  }
               ],
               "message":{
                  "messageText":"You have mortgage payments but you haven't added the mortgage account. Aggregate to let us help track your mortgage."
               }
            },
            {
               "id":13709572,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- All Category",
               "accountType":"OTHER",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709572"
               },
               "basicTransaction":[
                  {
                     "id":47307045,
                     "amount":{
                        "amount":1344.75,
                        "currency":"USD"
                     },
                     "date":"2025-04-17",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=47307045"
                     },
                     "categoryId":18,
                     "category":"Mortgages",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"Property Mortgage",
                        "simple":"Property Mortgage"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"BILLERS"
                  }
               ],
               "message":{
                  "messageText":"You have mortgage payments but you haven't added the mortgage account. Aggregate to let us help track your mortgage."
               }
            }
         ]
      }
   ]
}