POST/v2/getCustomerAccessSeekerEligibility

Conduct an Access Seeker check to confirm client eligibility and get the rate.
This page is only for a Joint Unsecured Personal Loan application.

Broker APIPersonal LoanJointUnsecured

💡 Migrate from v1

ID details collection has been removed from Access Seeker v2 and moved to Application Submission v2.
For more details, please refer to the Changelog.

TIP

Properties starting with partner_ are for the partner's details.

TIP

Possible application_status of the result are eligible, not eligible and Not Qualify.

eligible - Move to the next step
not eligible - Refer to not_eligible_reason in the response
Not Qualify - loan_amount need to be reduced until it's eligible

🔑 Authentication

Bearer Token - Your API token

📝 Content-Type

Request	application/json
Response	application/json

📦 Request Body

product_type Required

'joint_consumer_personal_loan'

The product type of the loan application. This can be fetched from the Get products endpoint

customer_id Required

number

Customer's ID generated by the Generate lead endpoint

hash Required

string

Customer's hash generated by the Generate lead endpoint

access_seeker_authorisation Required

1

Must be accepted to proceed

secured_application Required

0

joint_application Required

1

term_in_months Required

18 | 24 | 36 | 48 | 60 | 72 | 84

Loan term in months.
Can only be 18, 24 or 36 when total loan amount is less than 8,000

billing_frequency Required

'fortnightly' | 'weekly'

Repayment frequency

loan_purpose Required

Array<object>min: 1|max: 4

An 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' | 'Autoupgrade' | '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' | 'Travel' | 'Wedding Expenses' | 'Other'

payee Required

stringmax: 100

loan_amount Required

numbermin: 5,000|max: 50,000

description Sometimes

stringmax: 100

Required when loan_purpose is Other

first_name Required

stringmax: 60

middle_name Optional

stringmax: 60

last_name Required

stringmax: 60

email Required

stringmax: 100

dob Required

YYYY-MM-DD

Applicant's date of birth, and must be at least 18 years old.
E.g. 1991-04-04

gender Required

'm' | 'f' | 'o'

m for Male, f for Female and o for Other

mobile_phone Required

string

E.g. 0491570157

partner_first_name Required

stringmax: 60

partner_middle_name Optional

stringmax: 60

partner_last_name Required

stringmax: 60

partner_email Required

stringmax: 100

partner_gender Required

'm' | 'f' | 'o'

m for Male, f for Female and o for Other

partner_dob Required

YYYY-MM-DD

Partner's date of birth, and must be at least 18 years old.
E.g. 1991-04-04

partner_mobile_phone Required

string

E.g. 0491570157

employment_status Required

'casual' | 'other' | 'part_time' | 'permanent' | 'self_employed'

partner_employment_status Required

'casual' | 'other' | 'part_time' | 'permanent' | 'self_employed'

residential_status Required

length_residence Required

numbermin: 1|max: 999

Length of time at current address in months

current_unit_number Required

string | nullmax: 20

Pass null if the address does not have a unit number

current_street_number Required

stringmax: 20

current_street_name Required

stringmax: 100

current_street_type Required

string

e.g. RD, ST, etc.

current_suburb Required

stringmax: 50

current_postcode Required

stringmin: 1|max: 4

current_state Required

'ACT' | 'NSW' | 'NT' | 'QLD' | 'SA' | 'TAS' | 'VIC' | 'WA'

previous_unit_number Sometimes

string | nullmax: 20

Pass null if the address does not have a unit number