Change in Liabilities

Overview

The Change in Liabilities insight is a schedule-triggered insight that tracks the change in the liabilities value across all the aggregated accounts of a user. If accounts are marked as not to be considered for net worth, the insight will not consider those accounts.

Following are the additional details for the insight:

Insight Name	CHANGE_IN_LIABILITIES
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Containers	CARD, LOAN, INSURANCE, OTHER LIABILITIES

Use Cases

Customer:
- User engagement
User:
- Financial awareness – Keep track of changes in liabilities.

Suggested Action

If the liability value has decreased, congratulate the user. And, if the liability value has increased, suggest the users to review their financials to keep liabilities under check.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.

The following are the applicable frequencies for this insight:

Frequency	Description
DAILY	The insight will be triggered daily. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current day from 12:00 AM same day to the time of insight evaluation.
WEEKLY	The insight will be triggered once every Monday. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar week (Monday to Sunday). For example: Normal scenario: If the calendar week starts from 1st January to 7th January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar week starts from 1st January to 7th January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MONTHLY	The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example: Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight can be triggered using the following on-demand insight trigger API:

Method and URL:

POST /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets you decide when the insight has be generated to inform the user about a change in the liability value. If the difference between the two liability value exceeds the configured CHANGE PERCENT, the insight is generated for the user.

Threshold Name: CHANGE
- Data Type: PERCENT
- Range Allowed: 1.00 <= MINIMUM <= 500.00
- Default: 3.00

Note: Depending on the customer segment and account, the threshold might need to be different for different users. If the default value is insufficient, the users can set a threshold they are comfortable tracking.

GET Customer Subscription

The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer. The default frequency for the insight is MONTHLY.

Method and URL:

GET /insights/configs/customerSubscriptions

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}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/customerSubscriptions

Sample Response:

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

Api-Version 3.0 and 2.1 Response

{
  "customerSubscription": [
   {
            "insightName": "CHANGE_IN_LIABILITIES",
            "insightTitle": "Change in Liabilities",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "CARD",
                "LOAN",
                "INSURANCE",
                "OTHER LIABILITIES"
            ],
            "description": "Generates an insight when total liabilities change by more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "customerSubscription": [
   {
            "insightName": "CHANGE_IN_LIABILITIES",
            "insightTitle": "Change in Liabilities",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "CARD",
                "LOAN",
                "INSURANCE",
                "OTHER LIABILITIES"
            ],
            "description": "Generates an insight when total liabilities change by more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

PATCH Customer Subscription

Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.

Warning! Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.

Method and URL:

PATCH /insights/configs/customerSubscriptions

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}`
`Content-Type`	`application/json`
`Api-Version`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Change in Liabilities insight.	true, false
insightTitle	The title returned in the GET feed API as well as the insights config tool can be changed.	Alphanumeric characters up to 100 characters (including spaces)
frequency	The frequency with which an insight will be evaluated.	DAILY (every day - early morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
threshold	The threshold (CHANGE PERCENT) can be modified to adjust the difference in percentage between the liabilities of two time periods.	Any number between 1.00 and 500.00

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"CHANGE_IN_LIABILITIES",
         "insightTitle":"New Title",
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
            }
         ]
      }
   ]
}

Response Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400	Y800: Invalid value for insightTitle; special characters ><\""'%{}\|^~[] are not supported.
400	Y800: Invalid value for frequency; Supported values are [DAILY,WEEKLY,MONTHLY]
400	Y800: Invalid value for CHANGE in CHANGE_IN_LIABILITIES insight Min =1.00 and Max = 500.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying applicableEntity is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying triggerType is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying container is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying description is not allowed
400	Y800: Invalid value for isSubscribed; Supported values are true, false
400	Y825: Update not allowed without a valid request body
400	Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required.
400	Y802: Specifying duration attribute for CHANGE_IN_LIABILITIES insight is not allowed
400	Y812: Required field/value - insightName missing in the request
400	Y802: Modifying InsightType attribute is not allowed
400	Y813: entityType should be provided
400	Y803: At least one additional attribute is required in addition to entityType.
400	Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes.
400	Y800: Invalid value for entityType. Supported entityType for CHANGE_IN_LIABILITIES insight are [ACCOUNT]
400	Y802: For CHANGE_IN_LIABILITIES insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For CHANGE_IN_LIABILITIES insight, {Invalid String} inside the threshold is not allowed
400	Y800: Invalid value for input json
401	Y020: Invalid token in authorization header
401	Y020: Token has expired

GET User Subscription

The GET user subscription API provides all the information about the user defaults set for the insight.

The entityId filter does not apply to this insight.

Method and URL:

GET /insights/configs/userSubscriptions

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/configs/userSubscriptions?insightName=CHANGE_IN_LIABILITIES

Sample Response:

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

Api-Version 3.0 and 2.1 Response

{
  "userSubscription": [
   {
            "insightName": "CHANGE_IN_LIABILITIES",
            "insightTitle": "Change in Liabilities",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "CARD",
                "LOAN",
                "INSURANCE",
                "OTHER LIABILITIES"
            ],
            "description": "Generates an insight when total liabilities change by more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "userSubscription": [
   {
            "insightName": "CHANGE_IN_LIABILITIES",
            "insightTitle": "Change in Liabilities",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "CARD",
                "LOAN",
                "INSURANCE",
                "OTHER LIABILITIES"
            ],
            "description": "Generates an insight when total liabilities change by more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

PATCH User Subscription

Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.

Method and URL:

PATCH /insights/configs/userSubscriptions

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}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes from the Change in Liabilities insight.	true, false
frequency	The frequency with which an insight will be evaluated.	DAILY (every day - early morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning)
threshold	The threshold (CHANGE PERCENT) can be modified to adjust the difference in percentage between the liabilities of two time periods.	Any number between 1.00 and 500.00

Sample Request:

{
  "userSubscription": [
    {
      "insightName": "CHANGE_IN_LIABILITIES",
       "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "threshold": [
                        {
                            "name": "CHANGE",
                            "value": "3",
                            "type": "PERCENT"
                        }
                    ]
                }
         ]
    }
  ]
}

Response Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in CHANGE_IN_LIABILITIES insight
400	Y800: Invalid value for frequency; Supported values are [DAILY,WEEKLY,MONTHLY]
400	Y800: Invalid value for threshold data in CHANGE_IN_LIABILITIES insight
400	Y800: Invalid value for CHANGE in CHANGE_IN_LIABILITIES insight Min =1.00 and Max = 500.00
400	Y802: Modifying insightTitle using this API is not allowed
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying applicableEntity is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying triggerType is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying container is not allowed
400	Y802: For insight CHANGE_IN_LIABILITIES, modifying description is not allowed
400	Y802: Specifying duration attribute for CHANGE_IN_LIABILITIES insight is not allowed
400	Y800: Invalid value for isSubscribed; Supported values are true, false
400	Y825: Update not allowed without a valid request body
400	Y812: Required field/value - insightName missing in the request
400	Y802: Modifying InsightType attribute is not allowed
400	Y813: entityType should be provided
400	Y803: At least one additional attribute is required in addition to entityType.
400	Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes
400	Y802: For insight CHANGE_IN_LIABILITIES, configurations at an entityId level are not allowed
400	Y800: Invalid value for entityType. Supported entityType for CHANGE_IN_LIABILITIES insight are [ACCOUNT]
400	Y800: Invalid value for input json
401	Y020: Invalid token in authorization header
401	Y020: Token has expired

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, the Change in Liabilities insight can be specifically requested.
The insight will return both the latest liability value and the previous liability value along with the account details that contributed to each liability value.

The entityId filter does not apply to this insight.

Calculation logic for derived attributes:
changePercent = (currentAmount - previousAmount) / absolute(previousAmount) * 100

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=CHANGE_IN_LIABILITIES

Sample Response:

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

{
   "feed":[
      {
         "id":"60d44ca0d59fdb46b0c923c2",
         "insightName":"CHANGE_IN_LIABILITIES",
         "insightTitle":"Change in Liabilities",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T09:13:04Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "threshold":[
                  {
                     "name":"CHANGE",
                     "value":"3",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "basicAccount":[
            {
               "id":13709605,
               "providerName":"Dag Site",
               "accountName":"VISA Credit Card",
               "accountType":"CREDIT",
               "isAsset":false,
               "container":"creditCard",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709605"
               }
            }
         ],
         "changeValue":[
            {
               "changeType":"LIABILITY_TOTAL",
               "previousDate":"2021-04-01",
               "previousAmount":{
                  "amount":500.0,
                  "currency":"USD"
               },
               "currentDate":"2021-05-01",
               "currentAmount":{
                  "amount":1500.0,
                  "currency":"USD"
               },
               "changeAmount":{
                  "amount":1000.0,
                  "currency":"USD"
               },
               "changePercent":200.0
            }
         ]
      }
   ]
}