Loan Maturity Notice

Overview

The Loan Maturity Notice insight is a schedule-trigger insight that alerts the users when a loan is going to mature within a configured number of days.

Following are the additional details for the insight:

Insight Name	LOAN_MATURITY_NOTICE
Applicable Entity	ACCOUNT
Insight Type	OTHER
Trigger Type	SCHEDULE
Supported Container	LOAN

Use Cases

Customer:
- Cross-Sell / Up-Sell opportunity - Prompt users to move money to any of the FI's investment offerings.
User:
- Take prudent financial decisions - Don't let the money sit idle. Move money to opportunities that enable the money to grow faster.

Suggested Action

Recommend to the user to move the money to an appropriate investment account.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for an entity ID.

Following is the applicable frequency 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.

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 loan maturing for each account. Depending upon the duration (FUTURE) configured, if any of the loans are maturing from today (day of insight evaluation) to FUTURE number of days, the insight is generated for the user.

Threshold Name: FUTURE
Data Type: DAYS
Range Allowed: 0 <= FUTURE <= 31
Default: 14

Note: Setting the FUTURE to 0, alerts the users about loans maturing on the same day. 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 DAILY.

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`	`2.1`
`Api-Version`	`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 2.1 Response

{
   "customerSubscription":[
    {
            "insightName": "LOAN_MATURITY_NOTICE",
            "insightTitle": "Loan Maturity Notice",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "LOAN"
            ],
            "description": "Generates an insight when a loan is within a configured number of days from maturity.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
    {
            "insightName": "LOAN_MATURITY_NOTICE",
            "insightTitle": "Loan Maturity Notice",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "LOAN"
            ],
            "description": "Generates an insight when a loan is within a configured number of days from maturity.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
   ]
}

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Loan Maturity Notice 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)
threshold	The threshold value (future) for generating the Loan Maturity Notice insight can be changed.	Any number between 0 and 31

Sample Request:

{
    "customerSubscription": [
        {
            "insightName": "LOAN_MATURITY_NOTICE",
            "insightTitle": "Loan Maturity Notice",
            "customerConfiguration": [
              {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                   "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
    ]
}

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 LOAN_MATURITY_NOTICE, modifying frequency is not allowed
400	Y802: Specifying duration attribute for LOAN_MATURITY_NOTICE insight is not allowed
400	Y800: Invalid value for FUTURE in LOAN_MATURITY_NOTICE insight Min =0 and Max = 31
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying applicableEntity is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying triggerType is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying container is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, 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 LOAN_MATURITY_NOTICE insight are - [ACCOUNT]
400	Y802: For LOAN_MATURITY_NOTICE insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For LOAN_MATURITY_NOTICE 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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/userSubscriptions?insightName=LOAN_MATURITY_NOTICE

Sample Response:

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

Api-Version 2.1 Response

{
  "userSubscription": [
    {
            "insightName": "LOAN_MATURITY_NOTICE",
            "insightTitle": "Loan Maturity Notice",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "LOAN"
            ],
            "description": "Generates an insight when a loan is within a configured number of days from maturity.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "userSubscription": [
    {
            "insightName": "LOAN_MATURITY_NOTICE",
            "insightTitle": "Loan Maturity Notice",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "LOAN"
            ],
            "description": "Generates an insight when a loan is within a configured number of days from maturity.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "DAILY",
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
  ]
}

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
entityId	The ID of the account for which the loan gets evaluated.	Valid IDs for accounts belonging to the user
isSubscribed	Subscribes or unsubscribes from the Loan Maturity Notice insight.	true, false
threshold	The threshold value (future) for generating the Loan Maturity Notice insight can be changed.	Any number between 0 and 31

Sample Request:

{
    "userSubscription": [
        {
            "insightName": "LOAN_MATURITY_NOTICE",
            "userConfiguration": [
             {
                    "entityType": "ACCOUNT",
                    "entityId": "10255809",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "FUTURE",
                            "value": "14",
                            "type": "DAYS"
                        }
                    ]
                }
            ]
        }
    ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in LOAN_MATURITY_NOTICE insight
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying frequency is not allowed
400	Y802: Specifying duration attribute for LOAN_MATURITY_NOTICE 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 FUTURE in LOAN_MATURITY_NOTICE insight Min =0 and Max = 31
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 LOAN_MATURITY_NOTICE, modifying applicableEntity is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying triggerType is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, modifying container is not allowed
400	Y802: For insight LOAN_MATURITY_NOTICE, 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 LOAN_MATURITY_NOTICE insight are - [ACCOUNT]
400	Y800: Invalid value for threshold data in LOAN_MATURITY_NOTICE 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 Loan Maturity Notice insight.

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`	`2.1`
`Api-Version`	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=LOAN_MATURITY_NOTICE

Sample Response:

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

{
   "feed":[
      {
         "id":"60dac1afa7683b195407d1f9",
         "insightName":"LOAN_MATURITY_NOTICE",
         "insightTitle":"Loan Maturity Notice",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-29T06:46:07Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"14",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "loanAccount":[
            {
               "id":10254888,
               "providerName":"Dag Site",
               "accountName":"Maturity is Apr 30",
               "accountType":"PERSONAL_LOAN",
               "isAsset":false,
               "container":"loan",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10254888"
               },
               "maturityDate":"2021-06-30"
            }
         ]
      }
   ]
}