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
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
List of task IDs returned from the bank statement upload API call. Each task ID represents a specific upload request processed by the system.
Annual interest rate applied to the loan, expressed as a percentage (e.g., 10.5 for 10.5%). This value is required for affordability calculations.
Total principal amount of the loan being assessed for affordability, expressed in the relevant currency (e.g., ZAR).
Duration of the loan term in years (e.g., 5 for a 5-year loan). Used to calculate repayment capacity.
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
Retrieve behavioral-risk scores based on the previously uploaded bank statement. USE AFTER (/api/bankstatement/upload).
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
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
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.
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
task_id returned from the bank statement upload API call
Maximum allowable variation in cash flow. Default is 0.3 (30%). Lower values indicate a stricter requirement for stability, while higher values allow more fluctuation..
The minimum net cash flow required to pass the evaluation. This sets a threshold for financial health.
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
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.
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
List of task IDs returned from the bank statement upload API call. Each task ID represents a specific upload request processed by the system.
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
Retrieve bank statement transactions based on the previously uploaded bank statement. USE AFTER (/api/bankstatement/upload)
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
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
Upload a bank statement to initiate risk analysis and scoring, the first step in assessing financial health.
- : Note: Data availability may vary depending on the financial institution, and access to certain data may be subject to intermittent connectivity issues from our transactions provider.
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.
Specifies the type of client entity. Use 1 if an ID number (individual) is provided, or 2 if a company registration number is provided.
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.
Last updated