Getting started

Prime API streamlines the loan issuing process by providing a set of endpoints designed to make a full integration as quick and simple as possible. The API handles everything from initial eligibility checks to final loan disbursement through four core endpoints:

Begin with POST /eligibility to receive instant feedback on platform users before starting a new loan application. This pre-qualification step ensures only viable opportunities move forward.

Progress to POST /applications to create a draft loan application. This endpoint captures comprehensive applicant data, business data and else and returns a pre-populated Application object with information that will be used by a Partner platform, like consent documents or tokens to be able to connect to Borrowers bank accounts.

The PUT /applications endpoint enables progressive enrichment of existing Applications. Applications may be enhanced with additional applicant and business data as they become available. These same endpoints may be later used to select a Borrower loan offer or sign final agreements. This flexibility allows an iterative application flow that can be paused and resumed by Borrower at anytime, and can be completed in any order without restraining user-experience.

Finally, complete the loan process with POST /loans to finalize an approved Application and loan offer and to initiate disbursement. This endpoint transforms qualified applications into funded loans with corresponding payment schedules.

During the full process, some intermediary endpoints will also be used, specific to important actions that a Partner platform needs to perform in order to complete the full process. For example: in order to generate a loan offer for a Borrower, the Application needs to go through the Underwriting Decision process, which may be done by using POST /applications/:id/underwite.

The journey from eligibility assessment to funded loan follows this high level flow :