Salary Changed
Overview
The Salary Changed insight is an event-trigger insight that is generated when the system identifies that the latest salary amount of the predicted event has changed from the previous salary amount by a user-specified threshold.
The Predicted Cash Flow feature has to be enabled as a pre-requisite for this insight.
Following are the additional details for the insight:
| Insight Name | SALARY_CHANGED |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | OTHER |
| Trigger Type | EVENT |
| Supported Container | BANK |
Use Cases
- Customer:
- Cross-Sell / Up-Sell opportunity - Prompt users to move money to any of the FI's investment offerings.
- User:
- Better financial planning
Suggested Action
If the salary has increased, suggest the user to move the excess into an account that earns higher returns.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once every 31 days (including the date of insight evaluation) for each of the applicable transaction ID for each recurring event ID (salary instance) per entity ID.
Insight Dynamic Trigger (On-Demand Evaluation)
The insight cannot be triggered on-demand using any of the on-demand trigger mechanisms currently available.
Peer Benchmarking Data
This insight does not provide peer benchmarking data.
Thresholds
Threshold lets the customer or the user decide when the user has to be alerted about a change in the salary amount. If the difference between the latest salary amount and the previous salary amount exceeds the configured CHANGE AMOUNT and CHANGE PERCENT, an insight is generated for the user. If the customers or users want to generate the insight based on only one threshold, they can set the other to 0. If both are provided, both conditions need to be met.
- Threshold Name: CHANGE
- Data Type: AMOUNT
- Range Allowed: 0.00 <= MINIMUM <= 10000.00
- Default: 100
- Threshold Name: CHANGE
- Data Type: PERCENT
- Range Allowed: 0.00 <= MINIMUM <= 500.00
- Default: 10
Note: Only USD currency is currently supported. Depending on the customer segment and account, 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.
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":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"containers":[
"BANK"
],
"description":"Generates an insight when a recurring salary changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"container":[
"BANK"
],
"description":"Generates an insight when a recurring salary changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"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 Salary Changed insights | 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) |
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"customerSubscription":[
{
"insightName":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
Response 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 | Y800: Invalid value for CHANGE in SALARY_CHANGED insight Min = 0.00 and Max = 10000.00 |
| 400 | Y800: Invalid value for CHANGE in SALARY_CHANGED insight Min = 0.00 and Max = 500.00 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight SALARY_CHANGED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, modifying triggerType is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, modifying container is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, 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 frequency attribute for SALARY_CHANGED insight is not allowed |
| 400 | Y802: Specifying duration attribute for SALARY_CHANGED 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 SALARY_CHANGED insight are - [ACCOUNT] |
| 400 | Y802: For SALARY_CHANGED insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For SALARY_CHANGED 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.
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=SALARY_CHANGED
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":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"containers":[
"BANK"
],
"description":"Generates an insight when a recurring salary changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"container":[
"BANK"
],
"description":"Generates an insight when a recurring salary changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"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 |
|---|---|---|
| entityId | The ID of the account for which the insight gets evaluated. | Valid IDs for accounts belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the Salary Changed insights | true, false |
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"userSubscription":[
{
"insightName":"SALARY_CHANGED",
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in SALARY_CHANGED insight |
| 400 | Y800: Invalid value for threshold data in SALARY_CHANGED insight |
| 400 | Y800: Invalid value for CHANGE in SALARY_CHANGED insight Min = 0.00 and Max = 10000.00 |
| 400 | Y800: Invalid value for CHANGE in SALARY_CHANGED insight Min = 0.00 and Max = 500.00 |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 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 SALARY_CHANGED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, modifying triggerType is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, modifying container is not allowed |
| 400 | Y802: For insight SALARY_CHANGED, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for SALARY_CHANGED insight is not allowed |
| 400 | Y802: Specifying duration attribute for SALARY_CHANGED 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 | Y800: Invalid value for userConfiguration; entityId should be provided. |
| 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 | Y802: Duplicate entityId entries is not allowed |
| 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 SALARY_CHANGED 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, you can specifically request for the Salary Changed insight only.
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=SALARY_CHANGED
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43ad9e2974e643f86241b",
"insightName":"SALARY_CHANGED",
"insightTitle":"Salary Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2021-06-24T07:57:13Z",
"subscription":[
{
"entityId":"10254749",
"entityType":"ACCOUNT",
"threshold":[
{
"name":"CHANGE",
"value":"100",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"basicAccount":[
{
"id":10254749,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=10254749"
},
"basicTransaction":[
{
"id":12713722,
"amount":{
"amount":88.13,
"currency":"USD"
},
"date":"2021-06-24",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713722"
},
"categoryId":29,
"category":"Paychecks/Salary",
"baseType":"CREDIT",
"description":{
"original":"Google Salary",
"simple":"Salary/Income from Google"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"Google"
}
},
{
"id":12713280,
"amount":{
"amount":888.13,
"currency":"USD"
},
"date":"2021-05-26",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713280"
},
"categoryId":29,
"category":"Paychecks/Salary",
"baseType":"CREDIT",
"description":{
"original":"Google Salary",
"simple":"Salary/Income from Google"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"Google"
}
}
],
"changeValue":[
{
"changeType":"SALARY_AMOUNT",
"previousDate":"2021-05-26",
"previousAmount":{
"amount":888.13,
"currency":"USD"
},
"currentDate":"2021-06-24",
"currentAmount":{
"amount":88.13,
"currency":"USD"
},
"changeAmount":{
"amount":-800.0,
"currency":"USD"
},
"changePercent":-90.08
}
]
}
]
}
]
}