Emergency Savings

Overview

The Emergency Savings insight is a schedule-trigger insight that informs the users about how much money they have that can be used as emergency savings and how long the funds will last.

Following are the additional details for the insight:

Insight Name	EMERGENCY_SAVINGS
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Containers	BANK, CARD, INVESTMENT

Use Cases

Customer:
- User engagement
- Up-Sell / Cross-Sell opportunities - Offer low-risk / money-market products for users to park their emergency funds.
User:
- Financial wellness - Better awareness of the current financial situation.

Suggested Action

If the user does not have at least 3 months of funds left, recommend the user to focus on building an emergency fund.

Duplicate Insight Checks

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

Following is the applicable frequency for this insight:

Frequency	Description
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:

POST /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold does not apply to this insight.

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 and the default duration for the insight is LAST_SIX_MONTHS.

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": "EMERGENCY_SAVINGS",
            "insightTitle": "Emergency Savings",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK",
                "CARD",
                "INVESTMENT"
            ],
            "description": "Generates an insight that provides an estimate of available emergency savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
    {
            "insightName": "EMERGENCY_SAVINGS",
            "insightTitle": "Emergency Savings",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK",
                "CARD",
                "INVESTMENT"
            ],
            "description": "Generates an insight that provides an estimate of available emergency savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ]
        }
   ]
}

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 Emergency Savings insight.	true, false
insightTitle	The title returned in the GET feed API as well as the insights configuration tool can be changed.	Alphanumeric characters up to 100 characters (including spaces)

Sample Request:

{
    "customerSubscription": [
        {
            "insightName": "EMERGENCY_SAVINGS",
            "insightTitle": "Emergency Savings",
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                }
            ]
        }
    ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid Input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for insightTitle; special characters ><\""'%{}\|^~[] are not supported.
400	Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400	Y802: For insight EMERGENCY_SAVINGS, modifying frequency is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying duration is not allowed
400	Y802: For EMERGENCY_SAVINGS insight passing threshold is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying applicableEntity is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying triggerType is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying container is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, 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	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 EMERGENCY_SAVINGS insight are - [ACCOUNT]
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=EMERGENCY_SAVINGS

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": "EMERGENCY_SAVINGS",
            "insightTitle": "Emergency Savings",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK",
                "CARD",
                "INVESTMENT"
            ],
            "description": "Generates an insight that provides an estimate of available emergency savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
    {
            "insightName": "EMERGENCY_SAVINGS",
            "insightTitle": "Emergency Savings",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK",
                "CARD",
                "INVESTMENT"
            ],
            "description": "Generates an insight that provides an estimate of available emergency savings.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "LAST_SIX_MONTHS"
                }
            ]
        }
   ]
}

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 Emergency Savings insight.	true, false

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"EMERGENCY_SAVINGS",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true
            }
         ]
      }
   ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in EMERGENCY_SAVINGS insight
400	Y802: For insight EMERGENCY_SAVINGS, modifying frequency is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying duration is not allowed
400	Y802: For EMERGENCY_SAVINGS insight passing threshold is not allowed
400	Y802: Modifying insightTitle using this API is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying applicableEntity is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying triggerType is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, modifying container is not allowed
400	Y802: For insight EMERGENCY_SAVINGS, 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	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	Y800: Invalid value for entityType. Supported entityType for EMERGENCY_SAVINGS insight are - [ACCOUNT]
400	Y802: For insight EMERGENCY_SAVINGS, configurations at an entityId level are not allowed
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, you can specifically request for the Emergency Savings insight. The insight will be generated only if the averageMonthlySpending is greater than 0.

The entityId filter does not apply to this insight.

Calculation Logic for Derived Attributes:

totalAvailableBalance = The total available balance across eligible card, bank, and investment accounts.
averageSpending=debitTotal / 6 (Round off to 2 decimal places)
spendingRunway=totalAvailableBalance / averageMonthlySpending (Round off to 2 decimal places)

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

Sample Response:

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

{
   "feed":[
      {
         "id":"60d43db8d59fdb46b0c911f8",
         "insightName":"EMERGENCY_SAVINGS",
         "insightTitle":"Emergency Savings",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T08:09:26Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"LAST_SIX_MONTHS"
            }
         ],
         "basicAccount":[
            {
               "id":13709569,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- Account Balance",
               "accountType":"SAVINGS",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709569"
               }
            },
            {
               "id":13709568,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709568"
               }
            },
            {
               "id":13709571,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
               "accountType":"CHECKING",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709571"
               }
            },
            {
               "id":13709570,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Account_Balance",
               "accountType":"SAVINGS",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709570"
               }
            },
            {
               "id":13709572,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- All Category",
               "accountType":"OTHER",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709572"
               }
            },
            {
               "id":13709567,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data_Sch/Ref",
               "accountType":"CHECKING",
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709567"
               }
            }
         ],
         "accountDerived":{
            "totalAvailableBalance":{
               "amount":256054.99,
               "currency":"USD"
            },
            "averageSpending":{
               "amount":48552.62,
               "currency":"USD"
            },
            "spendingRunway":5.27
         }
      }
   ]
}