Change in Property Value
Overview
The Change in Property Value insight is a scheduled insight that tracks the change in property value for aggregated real estate account by a defined threshold value. This insight is only applicable for real estate accounts where the property value is automatically updated by the system.
If an account is 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_PROPERTYVALUE |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | OTHER |
| Trigger Type | SCHEDULE |
| Supported Container | REALESTATE |
Use Cases
- Customer:
- User engagement
- User:
- Financial awareness – Keep track of changes in property value.
Suggested Action
If the property value has decreased, suggest the user to keep calm and stick to their financial plan. And, if the property value has increased, congratulate the user and suggest the user to stay on course and stick to their financial plan.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for an entity ID.
The following are the applicable frequencies for this insight:
| Frequency | Description | |
|---|---|---|
| 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:
|
|
| 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:
|
|
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 lets the customer or the user decide when the user has to be alerted about a change in the property value. If the difference between the two value exceeds the configured CHANGE PERCENT and CHANGE AMOUNT, the 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 <= 10000000.00
- Default: 500.00
- Threshold Name: CHANGE
- Data Type: PERCENT
- Range Allowed: 0.00 <= MINIMUM <= 500.00
- Default: 3.00
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. 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_PROPERTYVALUE",
"insightTitle": "Change in Property Value",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"containers": [
"REALESTATE"
],
"description": "Generates an insight when the value of property changes by more than a configured threshold.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"type": "PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription": [
{
"insightName": "CHANGE_IN_PROPERTYVALUE",
"insightTitle": "Change in Property Value",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"container": [
"REALESTATE"
],
"description": "Generates an insight when the value of property changes by more than a configured threshold.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"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 Property Value 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) |
| frequency | The frequency at which an insight will be evaluated. |
|
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"customerSubscription":[
{
"insightName":"CHANGE_IN_PROPERTYVALUE",
"insightTitle":"New Title",
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"type": "PERCENT"
}
]
}
]
}
]
}
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 | Y800: Invalid value for frequency Supported values are WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for CHANGE_IN_PROPERTYVALUE insight is not allowed |
| 400 | Y800: Invalid value for CHANGE in CHANGE_IN_PROPERTYVALUE insight Min =0.00 and Max = 10000000.00 |
| 400 | Y800: Invalid value for CHANGE in CHANGE_IN_PROPERTYVALUE insight Min =0.00 and Max = 500.00 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying triggerType is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying container is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, 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 CHANGE_IN_PROPERTYVALUE insight are - [ACCOUNT] |
| 400 | Y802: For CHANGE_IN_PROPERTYVALUE insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For CHANGE_IN_PROPERTYVALUE 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=CHANGE_IN_PROPERTYVALUE
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_PROPERTYVALUE",
"insightTitle": "Change in Property Value",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"containers": [
"REALESTATE"
],
"description": "Generates an insight when the value of property changes by more than a configured threshold.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"type": "PERCENT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"type": "PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription": [
{
"insightName": "CHANGE_IN_PROPERTYVALUE",
"insightTitle": "Change in Property Value",
"insightType": "OTHER",
"triggerType": "SCHEDULE",
"container": [
"REALESTATE"
],
"description": "Generates an insight when the value of property changes by more than a configured threshold.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"type": "PERCENT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"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 |
|---|---|---|
| entityId | The ID of the account for which account gets evaluated. | Valid IDs for accounts belonging to the user |
| isSubscribed | Subscribes or unsubscribes from the Change in Property Value insight. | true, false |
| frequency | The frequency at which an insight will be evaluated. |
|
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"userSubscription": [
{
"insightName": "CHANGE_IN_PROPERTYVALUE",
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "CHANGE",
"value": "500",
"type": "AMOUNT"
},
{
"name": "CHANGE",
"value": "3",
"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 CHANGE_IN_PROPERTYVALUE insight |
| 400 | Y800: Invalid value for frequency; Supported values are WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for CHANGE_IN_PROPERTYVALUE insight is not allowed |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 400 | Y800: Invalid value for CHANGE in CHANGE_IN_PROPERTYVALUE insight Min =0.00 and Max = 10000000.00 |
| 400 | Y800: Invalid value for CHANGE in CHANGE_IN_PROPERTYVALUE insight Min =0.00 and Max = 500.00 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying triggerType is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying container is not allowed |
| 400 | Y802: For insight CHANGE_IN_PROPERTYVALUE, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration 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 CHANGE_IN_PROPERTYVALUE insight are - [ACCOUNT] |
| 400 | Y800: Invalid value for threshold data in CHANGE_IN_PROPERTYVALUE insight |
| 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 Change in Property Value insight.
The insight will return both the latest property value and the previous property value along with the account details that contributed to each property value.
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_PROPERTYVALUE
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"603ca3823e92d0452cf68884",
"insightName":"CHANGE_IN_PROPERTYVALUE",
"insightTitle":"Change in Property Value",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-T08:19:13Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MONTHLY",
"threshold":[
{
"name":"CHANGE",
"value":"-7.00",
"type":"PERCENT"
},
{
"name":"CHANGE",
"value":"-500",
"type":"AMOUNT"
}
]
}
],
"realEstateAccount":[
{
"id":10230631,
"providerName":"SmartZip",
"accountName":"BNP Account",
"accountType":"REAL_ESTATE",
"isAsset":true,
"container":"REALESTATE",
"address":{
"street":"1380 UTAH ST",
"state":"CA",
"city":"SAN FRANCISCO",
"zip":"94110"
},
"link":{
"entityName":"account",
"url":"/accounts?accountId=10230631"
},
"changeValue":[
{
"changeType":"PROPERTY_VALUE",
"previousDate":"2021-04-01",
"previousAmount":{
"amount":100.0,
"currency":"USD"
},
"currentDate":"2021-05-01",
"currentAmount":{
"amount":100.0,
"currency":"USD"
},
"changeAmount":{
"amount":0,
"currency":"USD"
},
"changePercent":0.0
}
]
}
]
}
]
}