Appearance
!--methodPOST--!/getPreQualifiedEligibility ā
Conduct a prequalification check to confirm client eligibility and get the rate.
This page is only for a
Single unsecured Personal Loanapplication.
Broker APIPersonal LoanSingleSecured
š Authentication ā
- Bearer Token - Your API token
š Content-Type ā
| Request | application/json |
| Response | application/json |
š¦ Request Body ā
first_name Required
stringmax: 60middle_name Optional
stringmax: 60last_name Required
stringmax: 60dob Required
YYYY-MM-DDApplicant's date of birth, and must be at least 18 years old.
E.g. 1991-04-04
current_unit_number Required
string | nullmax: 20Pass null if the address does not have a unit number
current_street_number Required
stringmax: 20current_street_name Required
stringmax: 100current_street_type Required
stringe.g. RD, ST, etc.
current_suburb Required
stringmax: 50current_postcode Required
stringmin: 1|max: 4current_state Required
'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA'email Required
stringmax: 100residency_status Required
'citizen' | 'permanent resident' | 'visa holder'employment_status Required
'casual' | 'other' | 'part_time' | 'permanent' | 'self_employed'residential_status Required
'boarding_other' | 'boarding_with_parents' | 'mortgaged' | 'other' | 'owner' | 'renting'marital_status Required
'de_facto' | 'divorced' | 'married' | 'separated' | 'single' | 'widowed'dependents Required
numbermin: 0|max: 9The number of people who rely on the applicant for financial support or care
monthly_rental_repayments SometimesRequired when
numberresidential_status is renting, boarding_with_parents, boarding_other or otherrental_payments_frequency SometimesRequired when
'fortnightly' | 'monthly' | 'weekly'monthly_rental_repayments presentsmortgage_repayment_periodic_amount Required
numbermin: 0|max: 999,999,999mortgage_repayment_frequency Required
'fortnightly' | 'monthly' | 'weekly'product_type Required
'consumer_personal_loan'The product type of the loan application.
term_in_months Required
18 | 24 | 36 | 48 | 60 | 72 | 84Loan term in months.
Can only be 18, 24 or 36 when total loan amount is less than 8,000
loan_purpose Required
Array<object>min: 1|max: 1An array of loan purposes for the application.
The total loan amount must be between 5,000 and 50,000
loan_purpose Required
'NOW Loan Refinance' | 'Car Modification' | 'Boat Purchase' | 'Car Purchase' | 'Car Repairs' | 'Caravan Purchase' | 'Debt Consolidation' | 'Dental Expenses' | 'Educational Expenses' | 'Funeral Expenses' | 'Home Improvements' | 'Household Furnishings' | 'Other Vehicle Purchase' | 'Medical Expenses' | 'Mortgage Cost Funding' | 'Sporting Equipment' | 'Holiday / Travel' | 'Wedding Expenses' | 'Other'payee Required
stringmax: 100If loan_purpose is not Debt Consolidation, the payee should be the customer's name; otherwise, assign N/A.
loan_amount Required
numbermin: 5,000|max: 50,000description SometimesRequired when
stringmax: 100loan_purpose is Otherincomes Required
Array<object>min: 1An array of incomes
income_type Required
'payg' | 'other' | 'self_employed' | 'government_benefit' | 'investment_property_rent' | 'income_protection_work_cover'Mapping from employment_status:
| employment_status | income_type |
|---|---|
casual |
payg |
part_time |
payg |
permanent |
payg |
self_employed |
self_employed |
other |
any of above other than payg and self_employed |
income_amount Required
numbermin: 1income_frequency Required
'fortnightly' | 'monthly' | 'weekly'description Sometimesrequired when
stringincome_type is otherillion_bank_statements_document_id Optional
Array<string>Illion broker code.
Each id must be alphanumeric and no more than 9 characters
src Optional
stringutm_source Optional
stringutm_medium Optional
stringutm_campaign Optional
stringutm_partner_offer_id Optional
stringā¹ļø Examples ā
Request
json
{
"first_name": "Jhony",
"middle_name": "",
"last_name": "Bravo",
"dob": "1980-07-01",
"current_unit_number": 12345,
"current_street_number": "10",
"current_street_name": "VINE",
"current_street_type": "ST",
"current_suburb": "NAGAMBIE",
"current_postcode": "3608",
"current_state": "VIC",
"email": "webmaster@nowfinance.com.au",
"residency_status": "citizen",
"employment_status": "permanent",
"residential_status": "owner",
"marital_status": "single",
"dependents": 0,
"monthly_rental_repayments": 0,
"rental_payments_frequency": "",
"mortgage_repayment_periodic_amount": 0,
"mortgage_repayment_frequency": "",
"product_type": "consumer_personal_loan",
"term_in_months": 18,
"loan_purpose": [
{
"loan_purpose": "Home Improvements",
"payee": "Jhony Bravo",
"loan_amount": "11000.00",
"description": ""
}
],
"incomes": [
{
"income_type": "payg",
"income_amount": 25000,
"income_frequency": "monthly",
"description": "1"
}
],
"illion_bank_statements_document_id": [
"A1B2C3"
]
}Response
json
{
"application_status": "prequalified | not eligible | potential eligible",
"interest_rate": 22.75,
"comparison_rate": 22.75,
"loan_term": 18,
"repayment_frequency": "weekly | fortnightly",
"repayment_amount": 166.69,
"establishment_fee": 0,
"loan_purpose_array": [
{
"loan_purpose": "Car Purchase",
"loan_amount": 20000,
"payee": "Jhony Bravo",
"description": null
}
],
"prequalified_percentage": "0.98",
"campaign_url": "https://redirecturl",
"bs_status": "true | false"
}json
{
"message": "Unauthenticated."
}TIP
When bs_status is true in Response indicates that the prequalified_percentage has been calculated taking the submitted bank statements into consideration.