Categorisation and Insights

Overview
Integration
Products
API Documentation

# Insights: Loans

Operation keyword: insights-loans

Loans product verifies active liabilities and recent loan repayments, based on the loan type. Additionally, it captures loan repayment trends based on the payment history.

Loans product generates data points that can be used to perform credit history verification. For more advanced use-cases, Nordigen provides other loans-related data points as a part of its Credit Scoring product for Enterprise users.

## Request Flow

To use this product via API, see the Endpoints section "report" and go through the following steps:

2. Apply operation insights-loans;
3. Get results.

When sending apply operation insights-loans it can be customised with params argument:

• period: the count of calendar months that should be subsetted for calculations. Default period is all available calendar months of uploaded statement.
• currency: the main currency for output values. Default currency is the main currency of the statement’s country.

## Response Example

{
"data":{
"attributes":{
"insights":{
"insights-loans":{
"average_monthly_outgoing_loan_payment":150.00,
"calendar_months":9,
"calendar_months_with_incoming_loans":0,
"calendar_months_with_outgoing_loans":9,
"days_since_last_incoming_loan":null,
"loans_by_category":[
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"562",
"income":null
},
"category_title":"Fines",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"81",
"income":"117"
},
"category_title":"Other loans",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"94",
"income":"91"
},
"category_title":"Payday loans",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":9,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"95",
"income":"93"
},
"category_title":"Consumer loans",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"96",
"income":"174"
},
"category_title":"Leasing",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"796",
"income":"795"
},
"category_title":"Car Leasing",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":150,
"category_id":{
"expense":"97",
"income":"242"
},
"category_title":"Mortgage",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":0.01,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":1,
"ratio_of_outgoing_loan_category_to_loans":1
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"82",
"income":"302"
},
"category_title":"Credit cards",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"347",
"income":"346"
},
"category_title":"Credit line",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"98",
"income":"92"
},
"category_title":"Student loans",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
},
{
"average_monthly_outgoing_loan_payment":null,
"category_id":{
"expense":"657",
"income":"656"
},
"category_title":"Overdraft",
"days_since_last_incoming_loan":null,
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":null,
"number_of_incoming_loan_sources":0,
"number_of_outgoing_loan_sources":0,
"ratio_of_outgoing_loan_category_to_loans":null
}
],
"monthly_incoming_loan_trend":null,
"monthly_outgoing_loan_trend":0.01,
"ratio_of_incoming_loans_to_all_income":null,
"ratio_of_outgoing_loans_to_all_expenses":0.05
}
},
"status":"completed"
},
"type":"report processing status"
}
}


## Key Descriptions

KeyTypeDescription
average_monthly_outgoing_loan_paymentFloatAverage amount of monthly loan repayments.
calendar_monthsIntegerCount of calendar months in the statement.
calendar_months_with_incoming_loansIntegerCount of calendar months in the statement with incoming loan transactions.
calendar_months_with_outgoing_loansIntegerCount of calendar months in the statement with outgoing loan transactions.
days_since_last_incoming_loanIntegerCount of days since the last incoming loan taking into account last incomplete calendar month.
loans_by_categoryArrayArray of descriptive statistics for each loans category.
category_idObjectObject that holds information of the respective income and/or expense category ids
expenseStringID of the respective expense category
incomeStringID of the respective income category
category_titleStringNordigen category title of the respective loan category
monthly_incoming_loan_trendFloatMonthly trend of the specific loans income subcategory. Defined as slope of linear approximation of monthly incoming loan data. Trend is weighted on the last 3 calendar month data
monthly_outgoing_loan_trendFloatmonthly trend of the specific loans expense subcategory. Defined as slope of linear approximation of monthly outgoing loan data. Trend is weighted on the last 3 month data
number_of_incoming_loan_sourcesIntegercount of incoming loan sources
ratio_of_outgoing_loan_category_to_loansFloatRatio of the specific loans sub-category amount in regards to the sum of the whole loans category
ratio_of_incoming_loans_to_all_incomeFloatRatio of the incoming loan amount in regards to the amount of all income
ratio_of_outgoing_loans_to_all_expensesFloatratio of the outgoing loan amount in regards to the amount of all expense
statusStringProcessing record state
typeStringRedundant field, it will be removed in the next iteration