Submit a shorter application to get an indicative quotes from the lenders on the Fincheck Engine platform. The applicant becomes a lead in the lender's ecosystem and can be redirected to the lender's
Get Offers - (Get Quote)
Get Offers - (Get Quote)
POST{{baseUrl}}/api/v1/offer
Submit a shorter application to get an indicative quotes from the lenders on the Fincheck Engine platform. The applicant becomes a lead in the lender's ecosystem and can be redirected to the lender's environment to complete their application and provide the outstanding details and documents.
Request Body
Name
Type
Description
application_method*
String
"apply-now" or "get-quote". Indicates the type of loan application the applicant wishes to make.
fast_application*
boolean
employed*
boolean
This bool indicates whether or not the applicant is formally employed.
payday*
integer
This is the day of the month on which the applicant routinely gets paid.
An intent_id is assigned to a specific product in Fincheck Engine. The intent_id for personal loans is "2". The value will always be "2" in the Apply Now request (as it is for personal loans only).
popi
boolean
expenses*
integer
The expenses incurred by the customer in a month. This can be taken from the Summary Plus.
gross_income*
integer
The income before tax earned by the applicant.
email*
String
The applicant's email address that they have access to and monitor regularly.
cell_phone_number*
String
The applicant's primary cellphone number that can be used to contact them.
id_number*
String
The applicant's South African ID number as per their ID document.
last_name*
String
The last name/surname/family name of the applicant as per their ID document.
middle_name
String
The middle name of the applicant as per their ID document.
first_name*
String
The first name of the applicant as per their ID document.
payment_frequency*
String
How often the applicant will make payments in settlement of the loan (i.e. the intervals in which payments will be made, e.g. weekly, fortnightly, monthly, etc.)
repayment_period*
integer
Number of months the applicant would like repay the loan over.
loan_amount_required*
integer
The amount the applicant would like to lend.
net_income*
integer
The income after tax received by the applicant into their bank account.
Interpreting the 200: OK response
"live_score"
If there is no "live_score" it means that it is no live offer for the given offer id.
-2 means that this is not a live offer for this offer id.
If there is a live score object (e.g. below), this means that it is a live offer
"id" (integer)
Refers to the offer_id that is one of many offers in the response body.
"id" (string) --> "hashid"
Refers to the response as a whole or the instance of the "application".
