Debt to Income Ratio

Overview

The Debt to Income Ratio insight is a schedule-triggered insight that informs the users about their debt to income ratio, which is an important component of credit score. Debt to Income Ratio considers your income (3 month average) and average expenses for 3 months (any recurring debt including mortgages, alimony, child care support, etc.)

Following are the additional details for the insight:

Insight Name	DEBT_TO_INCOME_RATIO
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Containers	BANK, CARD, LOAN

Use Cases

Customer:
- User engagement
User:
- Financial awareness - Keep track of spending.
- Improve credit score

Suggested Action

If debt to income ratio is high, suggest users to take action to reduce their debts to improve credit score.

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.

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": "DEBT_TO_INCOME_RATIO",
            "insightTitle": "Debt To Income Ratio",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK",
                "CARD",
                "LOAN"
            ],
            "description": "Generates an insight that provides the ratio of debt to income.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
     {
            "insightName": "DEBT_TO_INCOME_RATIO",
            "insightTitle": "Debt To Income Ratio",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK",
                "CARD",
                "LOAN"
            ],
            "description": "Generates an insight that provides the ratio of debt to income.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ]
        }
   ]
}

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 Debt To Income Ratio 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": "DEBT_TO_INCOME_RATIO",
            "insightTitle": "Debt To Income Ratio",
            "customerConfiguration": [
                {
                    "isSubscribed": true,
                    "entityType": "ACCOUNT"
                }
            ]
        }
    ]
}

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 DEBT_TO_INCOME_RATIO, modifying frequency is not allowed
400	Y802: Specifying duration attribute for DEBT_TO_INCOME_RATIO insight is not allowed
400	Y802: For DEBT_TO_INCOME_RATIO insight passing threshold is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying applicableEntity is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying triggerType is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying container is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, 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 DEBT_TO_INCOME_RATIO 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=DEBT_TO_INCOME_RATIO

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": "DEBT_TO_INCOME_RATIO",
            "insightTitle": "Debt To Income Ratio",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK",
                "CARD",
                "LOAN"
            ],
            "description": "Generates an insight that provides the ratio of debt to income.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
   {
            "insightName": "DEBT_TO_INCOME_RATIO",
            "insightTitle": "Debt To Income Ratio",
            "insightType": "AGGREGATE",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK",
                "CARD",
                "LOAN"
            ],
            "description": "Generates an insight that provides the ratio of debt to income.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY"
                }
            ]
        }
   ]
}

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 Debt to Income Ratio insight.	true, false

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"DEBT_TO_INCOME_RATIO",
         "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 DEBT_TO_INCOME_RATIO insight
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying frequency is not allowed
400	Y802: Specifying duration attribute for DEBT_TO_INCOME_RATIO insight is not allowed
400	Y802: For DEBT_TO_INCOME_RATIO insight passing threshold is not allowed
400	Y802: Modifying insightTitle using this API is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying applicableEntity is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying triggerType is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, modifying container is not allowed
400	Y802: For insight DEBT_TO_INCOME_RATIO, 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 DEBT_TO_INCOME_RATIO insight are - [ACCOUNT]
400	Y802: For insight DEBT_TO_INCOME_RATIO, 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 Debt to Income Ratio insight. The insight will be generated only if the averageMonthlyIncome and averagedebt are greater than 0.

The entityId filter does not apply to this insight.

Calculation Logic for Derived Attributes:
debtToIncomeRatio = monthlyRecurringDebt/averageMonthlyIncome)*100(Rounded off to two decimal places)

A	Total `minimumAmountDue` across all card accounts
B	Calculate the average loan paid across all loan accounts = `debitTotal`/3 where `debitTotal` is of Master-level category ID = 17 (Loans) 3 is the last three months calculated from date range `fromDate`: 1st of N-3 Month (N is the current month) `toDate`: End of N-1 Month
C	Calculate the average rent paid across the bank and card accounts = `debitTotal`/3 where `debitTotal` is of Master-level category ID = 21 (Rent) 3 is the last three months calculated from date range `fromDate`: 1st of N-3 Month (N is the current month) `toDate`: End of N-1 Month
D	Calculate the average monthly mortgage paid across all loan accounts = `debitTotal`/3 where `debitTotal` is of Master-level category ID = 18 (mortgages) 3 is the last three months calculated from date range `fromDate`: 1st of N-3 Month (N is the current month) `toDate`: End of N-1 Month
E	Calculate average expenses for child care and alimony support: Average for `detailCategoryId` 1219 = `debitTotal`/3 where `debitTotal` is of `detailCategoryId` 1219(Spousal Support) 3 is the last three months calculated from date range `fromDate`: 1st of N-3 Month (N is the current month) `toDate`: End of N-1 Month Average for `detailCategoryId` 1703 = `debitTotal`/3 where `debitTotal` is of `detailCategoryId` 1703(Child Support Payments) 3 is the last three months calculated from date range `fromDate`: 1st of N-3 Month (N is the current month) `toDate`: End of N-1 Month

averageMonthlyIncome = creditTotal / 3(where 3 is the last 3 months calculated from date range)
- creditTotal across all the bank accounts for the following master categories: 92 Consulting, 27 Deposits, 96 Interest, 30 Investment Income, 32 Other Income, 29 Paychecks/Salary, 31 Retirement Income, 94 Sales, 98 Services
- Date Range: Difference in months between fromDate and toDate
  fromDate: 1st of N-3 Month (N is the current month)
  toDate: End of N-1 Month
monthlyRecurringDebt = A + B + C + D + E

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

Sample Response:

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

{
   "feed":[
      {
         "id":"60d43dbed59fdb46b0c9120c",
         "insightName":"DEBT_TO_INCOME_RATIO",
         "insightTitle":"Debt To Income Ratio",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-24T08:09:31Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY"
            }
         ],
         "basicAccount":[
            {
               "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":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"
               }
            }
         ],
         "transactionDerived":{
            "debtToIncomeRatio":80.03,
            "averageMonthlyIncome":{
               "amount":15271.41,
               "currency":"USD"
            },
            "monthlyRecurringPaymentTotal":{
               "amount":12222,
               "currency":"USD"
            }
         },
         "statementDerived":{
            "cardMinimumDueTotal":{
               "amount":0,
               "currency":"USD"
            }
         },
         "basicCategoryTypeDetail":[
            {
               "categoryType":"INCOME",
               "netTotal":{
                  "amount":45814.23,
                  "currency":"USD"
               }
            }
         ],
         "basicCategoryDetail":[
            {
               "categoryId":21,
               "category":"Rent",
               "netTotal":{
                  "amount":2617.5,
                  "currency":"USD"
               }
            }
         ]
      }
   ]
}