post https://api.okra.ng/v2/liabilities/process
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 predictionmortgage
: extracted insights from extracted mortgage transactionsinstitution_name
: name of mortgage institutionaverage_payment_interval
: average days between paymentsfirst_payment_date
: date of first mortgage paymentlast_payment_date
: date of last mortgage paymentnext_payment_due_date
: the expected due date for next mortgage paymentlast_payment_amount
: amount for last mortgage paymentnext_payment_amount
: the expected amount for next mortgage paymentno_payments
: total number of mortgage paymentstotal_amount
: total amount of mortgage paymentstransactions
: list of mortgage transactionsytd_paid
: year to date amount paidrent
: insights from extracted rent transactionsbeneficiary_name
: name of transaction beneficiaryaverage_payment_interval
: average days between paymentsfirst_payment_date
: date of first rent paymentlast_payment_date
: date of last rent paymentlast_payment_month
: month of last rent paymentno_payments
: total number of rent paymentstotal_amount
: total amount of rent paymentstransactions
: list of rent transactionsyears
: list of rent yearsretail_loans
: list of insights generated from retail loan transactions grouped.