Loans Insights

Operation keyword: loans

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

Request Flow

To use this product via API, see the Endpoints section "report" and go through the following steps:
  1. Upload the statetment(s);
  2. Apply operations (see the operation keyword);
  3. Get results.

Response Example


Key Descriptions

KeyDescriptionDescriptionOptional
all_monthsIntegerThe count of all months on a statement
average_monthly_loan_repaymentFloatThe average amount of monthly loan repaymentsYes
days_since_last_incoming_loanFloatThe count of days since the last received loanYes
incoming_loan_trendFloatRepresents weighted trend for incoming loans. Output is positive if incoming loans are increasing during given time period or with negative number if decreasing. Trend is weighted on the last 3 month data.Yes
loan_repayment_trendFloatRepresents weighted trend for repayed loans. Output is positive if loan repayments are increasing during given time period or with negative number if decreasing. Trend is weighted on the last 3 month data.Yes
loans_by_categoryArray of loans by category objectsA list of descriptive statistics for each loans category.Yes
category_nameStringName of the category
loan_category_idArray of IDsA list of the respective income and/or expense categories
expense_idIntegerID of the respective expense categoryYes
income_idIntegerID of the respective income categoryYes
months_with_loan_transactions_ratioFloatLoan month count to total month count ratioYes
proportion_of_loansFloatProportion of the specific loans sub-category amount in regards to the sum of the whole loans categoryYes
sourcesArray of source objectsA list of descriptive statistics for each source under respective category. If category does not contain sources, this array will not be displayed (including all fields within this array)
average_monthly_incoming_loanFloatThe average amount of monthly loans receivedYes
days_since_last_loans_paymentIntegerThe count of days since the last loan repaymentYes
expense_ratioFloatLoans expenses to loans income ratioYes
number_of_incoming_loansIntegerThe count of incoming loans for the time period
sourceStringName of the loan source (e.g., company name) or 'Unknown'
months_with_loans_expenseIntegerThe count of months when a loan is repayed
months_with_loans_incomeIntegerThe count of months when a loan is received
whole_monthsIntegerThe count of whole months in the account
statusStringProcessing record state
typeStringRedundant field, it will be removed in the next iteration