Process Liabilities

Overview

This endpoint processes liabilities for a customer

The API route works by taking a user’s transactions then process the transaction description. Next, the processed text is passed through a model to extract transactions related to retail loans (claims and payments), rents and mortgages.
The extracted transactions are analysed to produce the following information:

  • confidence: how confident the model is for the prediction
  • mortgage: extracted insights from extracted mortgage transactions
  • institution_name: name of mortgage institution
  • average_payment_interval: average days between payments
  • first_payment_date: date of first mortgage payment
  • last_payment_date: date of last mortgage payment
  • next_payment_due_date: the expected due date for next mortgage payment
  • last_payment_amount: amount for last mortgage payment
  • next_payment_amount: the expected amount for next mortgage payment
  • no_payments: total number of mortgage payments
  • total_amount: total amount of mortgage payments
  • transactions: list of mortgage transactions
  • ytd_paid: year to date amount paid
  • rent: insights from extracted rent transactions
  • beneficiary_name: name of transaction beneficiary
  • average_payment_interval: average days between payments
  • first_payment_date: date of first rent payment
  • last_payment_date: date of last rent payment
  • last_payment_month: month of last rent payment
  • no_payments: total number of rent payments
  • total_amount: total amount of rent payments
  • transactions: list of rent transactions
  • years: list of rent years
  • retail_loans: list of insights generated from retail loan transactions grouped.
Language
URL
Response
Click Try It! to start a request and see the response here!