Low Confidence Projected Series
Overview
The Low Confidence Projected Series insight is an event-triggered insight that alerts the user whenever the system identifies a recurring series, but the confidence level is low.
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 | LOW_CONFIDENCE_PROJECTED_SERIES |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | OTHER |
| Trigger Type | EVENT |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- Cleaner user data - Build a better financial picture of the user.
- User:
- Better user experience
Suggested Action
Use the following Predicted Cash Flow API to delete the predicted event based on user input:
Method and URL:
DELETE /predictedEvents/{predictedEventId}
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 a predicted event ID 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 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.
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": "LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle": "Low Confidence Projected Series",
"insightType": "OTHER",
"triggerType": "EVENT",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a low confidence series is projected",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle": "Low Confidence Projected Series",
"insightType": "OTHER",
"triggerType": "EVENT",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight when a low confidence series is projected",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
]
}
]
}
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 Low Confidence Projected Series 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) |
Sample Request:
{
"customerSubscription": [
{
"insightName": "LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle": "Low Confidence Projected Series",
"customerConfiguration": [
{
"isSubscribed": true,
"entityType": "ACCOUNT"
}
]
}
]
}
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 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying applicableEntity is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying triggerType is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying container is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, 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 LOW_CONFIDENCE_PROJECTED_SERIES insight is not allowed |
| 400 | Y802: Specifying duration attribute for LOW_CONFIDENCE_PROJECTED_SERIES insight is not allowed |
| 400 | Y802: For LOW_CONFIDENCE_PROJECTED_SERIES insight passing threshold 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 LOW_CONFIDENCE_PROJECTED_SERIES 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.
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=LOW_CONFIDENCE_PROJECTED_SERIES
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": "LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle": "Low Confidence Projected Series",
"insightType": "OTHER",
"triggerType": "EVENT",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a low confidence series is projected",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle": "Low Confidence Projected Series",
"insightType": "OTHER",
"triggerType": "EVENT",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight when a low confidence series is projected",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
}
]
}
]
}
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 is generated. | Valid IDs for accounts belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the Low Confidence Projected Series insight. | true, false |
Sample Request:
{
"userSubscription":[
{
"insightName":"LOW_CONFIDENCE_PROJECTED_SERIES",
"userConfiguration":[
{
"entityType":"ACCOUNT",
"entityId": "10255809",
"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 LOW_CONFIDENCE_PROJECTED_SERIES insight |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 400 | Y802: Duplicate entityId entries is not allowed |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying applicableEntity is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying triggerType is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying container is not allowed |
| 400 | Y802: For insight LOW_CONFIDENCE_PROJECTED_SERIES, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for LOW_CONFIDENCE_PROJECTED_SERIES insight is not allowed |
| 400 | Y802: Specifying duration attribute for LOW_CONFIDENCE_PROJECTED_SERIES 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 | Y802: For LOW_CONFIDENCE_PROJECTED_SERIES insight passing threshold is not allowed |
| 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 | 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 LOW_CONFIDENCE_PROJECTED_SERIES 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 Low Confidence Projected Series 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=LOW_CONFIDENCE_PROJECTED_SERIES
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
{
"feed":[
{
"id":"60d43da0d59fdb46b0c9119b",
"insightName":"LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle":"Low Confidence Projected Series",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2021-06-24T08:09:03Z",
"subscription":[
{
"entityId":"13709568",
"entityType":"ACCOUNT"
}
],
"basicPredictedEvents":[
{
"id":11542976,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542976"
},
"frequency":"MONTHLY",
"confidence":"51",
"confidenceLevel":"LOW",
"userApprovalStatus":"PENDING",
"basicAccount":[
{
"id":13709568,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709568"
},
"basicTransaction":[
{
"id":47306914,
"amount":{
"amount":390.0,
"currency":"USD"
},
"date":"2021-05-30",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47306914"
},
"categoryId":16,
"category":"Online Services",
"baseType":"DEBIT",
"description":{
"original":"LZC* LEGALZOOM.COM xxx-xxx-xxxx 000",
"simple":"LZC* LEGALZOOM.COM XX 000"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"LegalZoom"
}
},
{
"id":47306915,
"amount":{
"amount":390.0,
"currency":"USD"
},
"date":"2021-04-30",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47306915"
},
"categoryId":16,
"category":"Online Services",
"baseType":"DEBIT",
"description":{
"original":"LZC* LEGALZOOM.COM xxx-xxx-xxxx 000",
"simple":"LZC* LEGALZOOM.COM XX 000"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"LegalZoom"
}
}
]
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"feed":[
{
"id":"60d43da0d59fdb46b0c9119b",
"insightName":"LOW_CONFIDENCE_PROJECTED_SERIES",
"insightTitle":"Low Confidence Projected Series",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2021-06-24T08:09:03Z",
"subscription":[
{
"entityId":"13709568",
"entityType":"ACCOUNT"
}
],
"basicPredictedEvent":[
{
"id":11542976,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542976"
},
"frequency":"MONTHLY",
"confidence":"51",
"confidenceLevel":"LOW",
"userApprovalStatus":"PENDING",
"basicAccount":[
{
"id":13709568,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709568"
},
"basicTransaction":[
{
"id":47306914,
"amount":{
"amount":390.0,
"currency":"USD"
},
"date":"2021-05-30",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47306914"
},
"categoryId":16,
"category":"Online Services",
"baseType":"DEBIT",
"description":{
"original":"LZC* LEGALZOOM.COM xxx-xxx-xxxx 000",
"simple":"LZC* LEGALZOOM.COM XX 000"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"LegalZoom"
}
},
{
"id":47306915,
"amount":{
"amount":390.0,
"currency":"USD"
},
"date":"2021-04-30",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47306915"
},
"categoryId":16,
"category":"Online Services",
"baseType":"DEBIT",
"description":{
"original":"LZC* LEGALZOOM.COM xxx-xxx-xxxx 000",
"simple":"LZC* LEGALZOOM.COM XX 000"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS",
"basicMerchant":{
"name":"LegalZoom"
}
}
]
}
]
}
]
}
]
}