Financial Monitoring
This endpoint assesses a user’s ability to afford a specified loan based on their actual financial data. It analyzes monthly income, expenses, savings, and debt obligations to determine whether the proposed loan is financially manageable
task_id returned from the bank statement upload API call
The total loan amount being applied for.
The annual interest rate applied to the loan, expressed as a percentage (e.g., 10.5).
The duration of the loan in years.
Minimum Debt Service Coverage Ratio. Indicates how well income covers debt obligations. A value of 1.0 means income exactly covers debt. Default: 1.0.
Maximum Loan-to-Income Ratio. The loan amount should not exceed 50% of the applicant's annual income. Default: 0.5.
Maximum Monthly Loan Payment-to-Income Ratio. Monthly loan payments should not exceed 30% of monthly income. Default: 0.3.
Minimum Savings Buffer Ratio. Represents the number of months an individual's savings can cover total expenses. A minimum of 3 months is recommended. Default: 3.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
POST /api/bankstatement/affordability HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169
{
"task_id": "text",
"loan_amount": 1,
"interest_rate": 1,
"loan_term_years": 1,
"min_dscr": 1,
"max_lti": 1,
"max_affordability_ratio": 1,
"min_savings_buffer_ratio": 1,
"consent": true
}{
"version": "text",
"score": "text",
"tier": "text",
"tier_description": "text",
"explanations": [],
"metrics": {
"disposable_monthly_income": 1,
"monthly_loan_payment": 1,
"dscr": 1,
"lti": 1,
"affordability_ratio": 1,
"savings_buffer_ratio": 1
}
}Retrieve behavioral-risk scores based on the previously uploaded bank statement. USE AFTER (/api/bankstatement/upload).
task_id returned from the bank statement upload API call
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
POST /api/bankstatement/behavioral-risk HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"task_id": "text",
"consent": true
}{
"score": [
{
"Consumer_Score": 1,
"L30D_cv_in_trans": "text",
"L30D_cv_in_trans_points": 1,
"L30D_tot_in_trans": "text",
"L30D_tot_in_trans_points": 1,
"L60D_avg_in_trans": 1,
"L60D_avg_in_trans_points": 1,
"Latest_Date": "2025-09-28T19:03:24.075Z",
"ScoreBands": "text",
"Sub_id": 1,
"Total_Transaction_last_360_days": 1,
"prob_to_default": 1,
"ratio_30_to_60D_tot_in_trans": "text",
"ratio_30_to_60D_tot_in_trans_points": 1,
"ratio_30_to_60D_tot_out_trans": "text",
"ratio_30_to_60D_tot_out_trans_points": 1,
"ratio_60_to_90D_tot_out_trans": "text",
"ratio_60_to_90D_tot_out_trans_points": 1,
"reasons": [
"text"
]
}
],
"status": "text"
}This API endpoint evaluates the liquidity risk of an entity based on its bank statements. It analyzes financial metrics such as net cash flow, average daily balance, cash flow volatility, and liquidity ratio to generate a liquidity score. The response includes a risk tier classification, an explanation of the score, and detailed financial metrics that influenced the assessment.
task_id returned from the bank statement upload API call
Minimum cash left after expenses. Default is 0, meaning money in must be more than money out.
How much your cash flow is allowed to change. Default is 0.3 (or 30%). Lower = more stable.
Inflows vs. outflows. Must be at least 1.0, meaning you make enough to cover your expenses.
You should have enough money to cover at least 30 days. Default is 30.
Your bank balance at the end of each month must be positive. Default is 0
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
POST /api/bankstatement/liquidity HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148
{
"task_id": "text",
"min_net_cash_flow": 1,
"max_volatility": 1,
"min_liquidity_ratio": 1,
"min_days_of_cash": 1,
"min_end_of_month_balance": 1,
"consent": true
}{
"score": "text",
"tier": "text",
"tier_description": "text",
"explanations": [],
"metrics": {
"version": "text",
"net_cash_flow": 1,
"cash_flow_volatility": 1,
"liquidity_ratio": 1,
"days_of_cash": 1,
"min_end_of_month_balance": 1,
"disposable_monthly_income": 1
}
}This API endpoint evaluates the financial risk of an entity based on bank statement data. It analyzes various financial metrics such as balance volatility, income stability, liquidity ratio, and overdraft frequency to generate a risk score. The response includes a risk tier classification, explanations for the score, and detailed financial metrics that influenced the assessment.
task_id returned from the bank statement upload API call
Minimum average account balance. Default: 5000. Ensures users maintain enough cash reserves over time.
Required income stability level. Default: 0.8 (or 80%). Income should not vary by more than 20% to qualify.
Maximum percentage of transactions that can go into overdraft. Default: 0.05 (5%). Lower values = better money management.
Minimum ratio of income to expenses. Default: 1.5. This means income must be at least 1.5× more than expenses to pass.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
POST /api/bankstatement/risk HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"task_id": "text",
"min_avg_balance": 1,
"min_income_stability": 1,
"max_overdraft_freq": 1,
"min_expense_coverage": 1,
"consent": true
}{
"version": "text",
"score": "text",
"tier": "text",
"tier_description": "text",
"explanations": [],
"metrics": {
"avg_account_balance": 1,
"min_balance": 1,
"balance_volatility": 1,
"monthly_income": 1,
"income_volatility": 1,
"monthly_expenses": 1,
"expense_coverage_ratio": 1,
"overdraft_frequency": 1
}
}Retrieve bank statement transactions based on the previously uploaded bank statement. USE AFTER (/api/bankstatement/upload)
task_id returned from the bank statement upload API call
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us
POST /api/bankstatement/transactions HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"task_id": "text",
"consent": true
}{
"csv_url": "text"
}Upload a bank statement to initiate risk analysis and scoring, the first step in assessing financial health.
Payload for uploading an bank statement for analysis and verification.
The bank statement document, encoded as a Base64 string. The file must be a valid PDF.
Company registration number. Required only if the bank statement belongs to a registered business entity.
South African ID number. Required only if the bank statement belongs to an individual rather than a company.
The name of the financial institution. Supported Banks: 'ABSA', 'Nedbank', 'FNB', Standard bank', and 'Capitec bank'.
By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us.
POST /api/bankstatement/upload HTTP/1.1
Host: api.akibaone.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96
{
"base_64_pdf": "text",
"company_reg": "text",
"id_number": "text",
"bank_name": "text",
"consent": true
}{
"task_id": "text",
"consent": true
}