📋Apply Now

Use this endpoint to return end-to-end and get-quote offers for a customer who has completed a full personal loans application including the Affordability v1 module.

Synopsis

In order to get end-to-end offers for an applicant, you will need to submit their application details (including affordability data) to the POST Get Offers - (Apply Now) endpoint. In the response, you will see multiple offers. Those offers with a live score object represent end-to-end offers; whereas those with a live_score of -2 or without a live_score at all represent Get-Quote offers (indicative quotes).

If there are end-to-end offers, [and the applicant selects that they want this offer], you will need to use the POST Accept offer endpoint in order to...

Get Offers - (Apply Now)

POST {{baseUrl}}/api/v1/offer

Submit an application to lenders for end-to-end as well as get-quote offers. See the available offers in the response. This endpoint will return live offers as well as indicative quotes as a fallback.

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
type	String
bank*	String	This is the slug of the bank that the applicant uses (this needs to match the slug used for "bank" in the Affordability v1 module > Create new Bank Account).
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.
bank_name*	String	This is the slug of the bank that the applicant uses (this needs to match the slug used for "bank" in the Affordability v1 module > Create new Bank Account).
intent_id*	integer	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).
initial_popi	boolean
popi	boolean
expenses*	decimal	The expenses incurred by the customer in a month. This can be taken from the Summary Plus.
income_source*	String	The type of income that the applicant receives (e.g. "salary", "wage", "commission", "sassa-grant".
net_income*	decimal	The income after tax received by the applicant into their bank account. This will be compared against the main_income identified in the applicant's bank statements/transactions gleaned from the online process. This amount can be directly passed using the main_income amount identified by Gathr in the Summary Plus.
gross_income*	decimal	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.
bankAccount*	String	This is an object containing information for Fincheck Engine to reference the bank account that was created for the applicant in the Affordability v1 module > Create new Bank Account Gathr module.
affiliate_id*		This is a number that references the????
employment_province*	String	This is the province where the applicant's place of work can be found??
employment_cell_phone*	String	This is an alternate (work) contact number that the applicant can be reached at.
employment_year*	String	This is the year in which the applicant started work at their current employer.
employment_time	integer??	This indicated how long the applicant has been employed at their current employer (in years??).
employer_sector*	String	This is the economic sector in which the applicant's employer operates.
employer*	String	This is the name of the business/organisation that the applicant is employed by,
upload_method*	String	This is the method the applicant used to provide their bank statements/transactions (i.e. "statement" or "online") in the Affordability v1 module > Create new Bank Account module.

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

type

String

bank*

String

This is the slug of the bank that the applicant uses (this needs to match the slug used for "bank" in the Affordability v1 module > Create new Bank Account).

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.

bank_name*

String

This is the slug of the bank that the applicant uses (this needs to match the slug used for "bank" in the Affordability v1 module > Create new Bank Account).

intent_id*

integer

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).

initial_popi

boolean

popi

boolean

expenses*

decimal

The expenses incurred by the customer in a month. This can be taken from the Summary Plus.

income_source*

String

The type of income that the applicant receives (e.g. "salary", "wage", "commission", "sassa-grant".

net_income*

decimal

The income after tax received by the applicant into their bank account. This will be compared against the main_income identified in the applicant's bank statements/transactions gleaned from the online process. This amount can be directly passed using the main_income amount identified by Gathr in the Summary Plus.

gross_income*

decimal

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.

bankAccount*

String

This is an object containing information for Fincheck Engine to reference the bank account that was created for the applicant in the Affordability v1 module > Create new Bank Account Gathr module.

affiliate_id*

This is a number that references the????

employment_province*

String

This is the province where the applicant's place of work can be found??

employment_cell_phone*

String

This is an alternate (work) contact number that the applicant can be reached at.

employment_year*

String

This is the year in which the applicant started work at their current employer.

employment_time

integer??

This indicated how long the applicant has been employed at their current employer (in years??).

employer_sector*

String

This is the economic sector in which the applicant's employer operates.

employer*

String

This is the name of the business/organisation that the applicant is employed by,

upload_method*

String

This is the method the applicant used to provide their bank statements/transactions (i.e. "statement" or "online") in the Affordability v1 module > Create new Bank Account module.

More info on the fields in the request body:

"intent_id"

This is a unique integer that tells Fincheck Engine which product the application is being made for.

"affiliate_id"

Explanation

Options???:

"bankAccount"

"id": This is UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response. It ensures that the transactional data and statements retrieved in the online login session are saved to the correct Bank Account.

"tenant": This is the tenant on which the customer exists in Gathr.

"api_token": This is apiToken that references and allows Fincheck Engine to use the the specific customer on a given tenant.

Example "bankAccount" object:

```postman_json
"bankAccount": {
        "id": "{{bankAccountId}}",
        "tenant": "lightstone-auto",
        "api_token": "{{apiToken}}"
    }
```

Accept offer

POST {{baseUrl}}/api/v1/accept

Accept a specific offer by "partner_id" and "hashid".

Request Body

Name	Type	Description
partner_id*	integer	This is the id that is assigned to a specific partner (i.e. lender) in Fincheck Engine.
type*	String	"apply-now" or "get-quote". Indicates the type of loan application the applicant wishes to make.
hashid*	String	This is the 6-character "id" at the bottom of the Get Offers - Apply Now response.??? ~~confirm length and add link~~
live_score*		This is the live_score value from the POST Get Offers - (Apply Now) response.

Name

Type

Description

partner_id*

integer

This is the id that is assigned to a specific partner (i.e. lender) in Fincheck Engine.

type*

String

"apply-now" or "get-quote". Indicates the type of loan application the applicant wishes to make.

hashid*

String

This is the 6-character "id" at the bottom of the Get Offers - Apply Now response.??? ~~confirm length and add link~~

live_score*

This is the live_score value from the POST Get Offers - (Apply Now) response.

```json
{
    "id": "qdKRJj",
    "status": "success",
    "code": 200
}
```

Last updated 1 year ago