Applications and decisions

For a standard application, supply the applicant's email, bvn, state, and city along with bank statement data. Use type=business and include industry for a business application. Supply applicationReference to keep your own reference alongside Vector's ID. Where required by your configured model, supply the agreed business details, guarantor details, or underwritingInputs. Submit bank codes and account numbers as strings to preserve leading zeroes.

A successful standard submission returns HTTP 201 with application_id. The standard flow can return received after submission and processing when polled. Treat approved, ineligible, failed, and cancelled as final for this flow. Where your institution uses a configured product flow, follow its documented response contract.

An approved decision includes a rating with grade, label, and score. Where supplied, use loan_limit together with loan_limit_currency, max_tenure_months, and interest_rate_annualized. Check for nullable terms before rendering. Use the eligibility or failure information returned for that application to determine the next action.

To cancel an unfinished application, send POST /api/v1/applications/{application}/cancel. You can include a reason of up to 500 characters. Fetch the application if processing has already completed. Use application logs to investigate an application and the list endpoint to retrieve a borrower’s applications.

Record repayment activity in Vector#

Send POST /api/v1/repayments for an approved application when recording payment history for underwriting. Supported values of event are payment_made, payment_late, payment_missed, loan_settled, and loan_defaulted. Send application_id and event. The API also accepts amount as a nonnegative integer, a three-character currency, due_date, and payment_date. An event with the same application, type, amount, and dates can be rejected as a duplicate. Use Collections to collect repayments or apply payments to a collection balance.