Appearance
!--methodPOST--!/customerApplicationSubmission
Submit the application to credit for decision.
This page is only for a
Single Auto Loan
application.
Broker APIAuto LoanSingle
🔑 Authentication
- Bearer Token - Your API token
📝 Content-Type
Request | application/json |
Response | application/json |
📦 Request Body
customer_id RequiredCustomer's ID
number
hash RequiredCustomer's hash
string
duration_months SometimesEmployment duration in monthsRequired when
number
min: 1|max: 999employment_status
is NOT other
job_description SometimesRequired when
string
max: 100employment_status
is NOT other
employer_name SometimesRequired when
string
max: 100employment_status
is NOT other
employer_primary_contact_phone_number SometimesRequired when
string
employment_status
is NOT self_employed
or other
employer_australian_business_number SometimesRequired when
string
employment_status
is self_employed
other_employment_description SometimesRequired when
string
max: 100employment_status
is other
previous_employment_status SometimesRequired when
'casual' | 'other' | 'part_time' | 'permanent' | 'self_employed'
employment_status
is NOT other
and duration_months < 18
previous_duration_months SometimesEmployment duration in months for the previous jobRequired when
number
min: 1|max: 999employment_status
is NOT other
and duration_months < 18
previous_job_description SometimesRequired when
string
max: 100employment_status
is NOT other
and duration_months < 18
previous_employer_name SometimesRequired when
string
max: 100employment_status
is NOT other
and duration_months < 18
previous_employer_primary_contact_phone_number SometimesRequired when
string
employment_status
is NOT self_employed
or other
and duration_months < 18
previous_employer_australian_business_number SometimesRequired when
string
employment_status
is self_employed
and duration_months < 18
previous_other_employment_description SometimesRequired when
string
employment_status
is other
and duration_months < 18
incomes RequiredAn array of incomes
Array<object>
min: 1income_type Required
'payg' | 'other' | 'self_employed' | 'government_benefit' | 'investment_property_rent' | 'income_protection_work_cover'
income_amount Required
number
min: 1income_frequency Required
'fortnightly' | 'monthly' | 'weekly'
description Sometimesrequired when
string
income_type
is other
sales_incentive_commission OptionalThe percentage of the income that is from sales incentives or commissions.
It must be no more than
number
min: 0|max: 99It must be no more than
99%
when combined with annual_bonus
annual_bonus OptionalThe percentage of the income that is from annual bonus.
It must be no more than
number
min: 0|max: 99It must be no more than
99%
when combined with sales_incentive_commission
partner_employed Required
0 | 1
1
if your partner is contributing to expenses, 0
otherwisemonthly_rental_repayments SometimesRequired when
number
residential_status
is renting
, boarding_with_parents
, boarding_other
or other
rental_payments_frequency SometimesRequired when
'fortnightly' | 'monthly' | 'weekly'
monthly_rental_repayments
presentsmortgage_repayment_periodic_amount Required
number
min: 0|max: 999,999,999mortgage_repayment_frequency Required
'fortnightly' | 'monthly' | 'weekly'
mortgage_current_balance RequiredMust be greater or equal to
number
min: 0|max: 20,000,000mortgage_repayment_periodic_amount
accommodations_payed_by_partner SometimesPercentage of accommodation expenses paid by the partnerRequired when
number
min: 0|max: 99partner_employed
is 1
general_wellbeing RequiredThe amount of money spent on general wellbeing
number
min: 0|max: 99,999,999general_wellbeing_frequency Required
'fortnightly' | 'monthly' | 'weekly'
residence_cost RequiredThe amount of money spent on residence
number
min: 0|max: 99,999,999residence_cost_frequency Required
'fortnightly' | 'monthly' | 'weekly'
transport_insurance RequiredThe amount of money spent on transport and insurance
number
min: 0|max: 99,999,999transport_insurance_frequency Required
'fortnightly' | 'monthly' | 'weekly'
other_living_expenses Required
number
min: 0|max: 99,999,999other_living_expenses_frequency Required
'fortnightly' | 'monthly' | 'weekly'
living_expenses_payed_by_partner SometimesPercentage of living expenses paid by the partnerRequired when
number
min: 0|max: 99partner_employed
is 1
credit_card_limit RequiredFor credit card liabilities, the credit limit in dollars
number
min: 0|max: 999,999,999credit_card_balance RequiredBalance of the loan or credit facility in dollars
number
min: 0|max: 999,999,999other_loan_repayment_periodic_amount Required
number
min: 0|max: 999,999,999other_loan_repayment_frequency Required
'fortnightly' | 'monthly' | 'weekly'
other_loan_current_balance RequiredMust be greater or equal to
number
min: 0|max: 999,999,999other_loan_repayment_periodic_amount
balloon_percentage OptionalOnly fillable when
number
min: 0|max: 99balloon_amount
is not presentballoon_amount OptionalOnly fillable when
number
min: 0|max: 99,999,999balloon_percentage
is not presentaccuracy_acknowledgement RequiredMust be accepted to submit the application
true
discretionary_expenses_acknowledgement RequiredMust be accepted to submit the application
true
privacy_consent_provided RequiredMust be accepted to submit the application
true
electronic_communication_acknowledgement RequiredMust be accepted to submit the application
true
equifax_ve_acknowledgement RequiredMust be accepted to submit the application
true
brokerflow_document_ids OptionalIllion broker code.
Each id must be no more than 9 characters
Array<string>
Each id must be no more than 9 characters
ℹ️ Examples
Request
json
{
"customer_id": "531805",
"hash": "r9nkL0e2Ji2WGvobusR1bmhkYSW5vQh93eq5psbzgeBqIRrCss6TIXUP",
"duration_months": "20",
"job_description": "EmployerRole",
"employer_name": "TFH hire",
"employer_primary_contact_phone_number": "0404111111",
"employer_australian_business_number": "11223491505",
"other_employment_description": "",
"previous_employment_status": "self_employed",
"previous_job_description": "",
"previous_employer_name": "",
"previous_employer_primary_contact_phone_number": "",
"previous_employer_australian_business_number": "",
"previous_duration_months": "",
"previous_other_employment_description": "",
"incomes": [
{
"income_type": "payg",
"income_amount": 1000,
"income_frequency": "monthly",
"description": "1"
}
],
"annual_bonus": 0,
"sales_incentive_commission": 0,
"general_wellbeing": 1,
"gender": "m",
"mobile_phone": "0412345678",
"residence_cost": 1,
"transport_insurance": 1,
"other_living_expenses": 1,
"monthly_rental_repayments": 1231,
"mortgage_repayment_periodic_amount": "0",
"credit_card_limit": "0",
"credit_card_balance": "0",
"other_loan_repayment_periodic_amount": "0",
"other_loan_current_balance": "0",
"mortgage_current_balance": "0",
"accuracy_acknowledgement": true,
"privacy_consent_provided": true,
"discretionary_expenses_acknowledgement": true,
"electronic_communication_acknowledgement": true,
"equifax_ve_acknowledgement": true,
"partner_employed": 0
}
Response
json
{
"data": {
"customerId": 531805,
"hash": "r9nkL0e2Ji2WGvobusR1bmhkYSW5vQh93eq5psbzgeBqIRrCss6TIXUP",
"joint_application": 0,
"partner_id": "pepper-direct",
"loan_purpose": "Asset Purchase - Private Sale",
"loan_purpose_description": null,
"loan_amount": "15500.00",
"app_status": "eligible",
"interest_rate": "18.75",
"comparison_rate": "18.75",
"total_amount_inc_fees": "15500.00",
"establishment_fee": "0.00",
"debit_fee": "0.00",
"repayment_frequency": "Weekly",
"repayment_amount": "129.99",
"repayments_count": 156,
"loan_term": 36,
"application_number": 1141619,
"application_status": "Application Submitted",
"no_of_debts": 0,
"first_name": "ALEGACYPRAH",
"last_name": "PRAHLLEGACYA",
"middle_name": "ALEGACYM",
"email": "webmaster+74@nowfinance.com.au",
"dob": "1980-07-01",
"gender": "m",
"mobile": "0412345678",
"score": 659,
"cr_score": 628,
"one_score": 659,
"nfp_cr_score": 919,
"nfp_cr_secured_score": 919,
"marital_status": "married",
"residential_status": "renting",
"length_residence": 56,
"income_frequency": "weekly",
"dependents": 0,
"primary_id_type": "driver_licence",
"id_type": null,
"employment_status": "permanent",
"address": "Testar Grove, Caulfield North VIC, Australia",
"current_unit_number": null,
"current_street_number": "10",
"current_street_name": "VINE",
"current_street_type": "ST",
"current_suburb": "NAGAMBIE",
"current_state": "VIC",
"current_postcode": "3608",
"previousaddress": null,
"prevs_unit_number": null,
"previous_street_number": "test",
"previous_street_name": "Tester",
"previous_street_type": "GROVE",
"previous_suburb": "Caulfield North",
"previous_state": "QLD",
"previous_postcode": "3161",
"partner_first_name": "test",
"partner_middle_name": "test",
"partner_last_name": "test",
"partner_email": "testwebmaster+2@nowfinance.com.au",
"partner_dob": "1980-03-12",
"partner_marital_status": null,
"partner_residential_status": null,
"partner_length_residence": 11,
"partner_income_frequency": null,
"partner_current_state": "VIC",
"partner_current_postcode": "3608",
"partner_gender": "m",
"partner_bank_statement_status": false,
"partner_employment_status": "permanent",
"partner_employed": 0,
"partner_score": null,
"partner_cr_score": null,
"partner_one_score": null,
"partner_nfp_cr_score": 0,
"partner_nfp_cr_secured_score": 0,
"genesis_decline_rules": null,
"enable_bank_statements_module": true,
"bank_statement_status": false,
"secured_application": 1,
"security_type": "watercraft",
"engine_number": null,
"family_or_model": null,
"asset_class": null,
"registration_jurisdiction": null,
"make": null,
"category": "Camper Trailer",
"vehicle_identification_number": null,
"actual_kms": null,
"variant": null,
"drivetrain": null,
"guide_asset_code": null,
"model_year": null,
"value_determined_by_origination": "15500.00",
"trailer_registration_jurisdiction": null,
"trailer_registration_number": null,
"boat_trailer_description": null,
"boat_length_metres": null,
"hull_identification_number": null,
"body_type_description": null,
"series": null,
"axle": null,
"berths": null,
"style": "99",
"manual_entry": 1,
"date_added": "2024-09-04T05:33:44.000000Z",
"lead_id": null,
"network_id": null,
"dealer_id": null,
"braze_external_id": "$5$nfVRU1nJyh2dsS$lUsLAKbXC3bVxoFKC6czwH9rs7HV7hHPYW1mAI7ROo3",
"oe_application_key": "a3c129ba-f2b0-4f4c-a214-f69d543f73d5",
"applicant_oe_hash_key": "8cb9367c-5fca-4157-86c4-842d884d5e6e",
"partner_oe_hash_key": null,
"external_id": "$5$nfVRU1nJyh2dsS$lUsLAKbXC3bVxoFKC6czwH9rs7HV7hHPYW1mAI7ROo3",
"pcr_id": "SKWrODHxil1M8lgNKhN12sR9RDAthKX7its6otuntFIdxrpl8fZfFltv2OOx",
"origination_id": 386682,
"origination_user_name": null,
"braze_partner_external_id": null,
"page_url": "https://staging.nowfinance.com.au/partner-customer-landing?&pcr_id=SKWrODHxil1M8lgNKhN12sR9RDAthKX7its6otuntFIdxrpl8fZfFltv2OOx",
"campaign_url": "https://gmr-pepper.staging.nowfinance.com.au/?return=r9nkL0e2Ji2WGvobusR1bmhkYSW5vQh93eq5psbzgeBqIRrCss6TIXUPwfmU&",
"digital_id": {
"main_result": null,
"recorded": null,
"checks": {
"liveness": null,
"face_match": null,
"dvs": null,
"details_match": null,
"document_fraud": null
},
"attempts_remaining": null,
"completed_at": null,
"partner_main_result": null,
"partner_recorded": null,
"partner_checks": {
"liveness": null,
"face_match": null,
"dvs": null,
"details_match": null,
"document_fraud": null
},
"partner_attempts_remaining": null,
"partner_completed_at": null
},
"origination_fee": 0,
"product_type": "Joint Auto Loan",
"loan_contract": {
"eligibility": false,
"details": {
"bank_account": null,
"repayment_schedule": null
},
"loan_progress": {
"email_verified": {
"main": false
},
"payment_details_uploaded": false,
"signed_loan_contract": {
"main": false
}
}
},
"loan_repayment_options": [
{
"loan_term": 18,
"repayment_frequency": "weekly",
"repayment_amount": "228.24"
},
{
"loan_term": 24,
"repayment_frequency": "weekly",
"repayment_amount": "178.90"
},
{
"loan_term": 36,
"repayment_frequency": "weekly",
"repayment_amount": "129.99"
},
{
"loan_term": 48,
"repayment_frequency": "weekly",
"repayment_amount": "105.96"
},
{
"loan_term": 60,
"repayment_frequency": "weekly",
"repayment_amount": "91.86"
},
{
"loan_term": 72,
"repayment_frequency": "weekly",
"repayment_amount": "82.73"
},
{
"loan_term": 84,
"repayment_frequency": "weekly",
"repayment_amount": "76.43"
},
{
"loan_term": 18,
"repayment_frequency": "fortnightly",
"repayment_amount": "457.19"
},
{
"loan_term": 24,
"repayment_frequency": "fortnightly",
"repayment_amount": "358.34"
},
{
"loan_term": 36,
"repayment_frequency": "fortnightly",
"repayment_amount": "260.33"
},
{
"loan_term": 48,
"repayment_frequency": "fortnightly",
"repayment_amount": "212.17"
},
{
"loan_term": 60,
"repayment_frequency": "fortnightly",
"repayment_amount": "183.93"
},
{
"loan_term": 72,
"repayment_frequency": "fortnightly",
"repayment_amount": "165.63"
},
{
"loan_term": 84,
"repayment_frequency": "fortnightly",
"repayment_amount": "152.99"
}
],
"customer_risk_tier": null,
"mlops_logs": null,
"ab_pricing_random_number": null,
"ab_pricing_partner_code": null,
"src": null,
"traffic_source": null,
"risk_tier_logs": null,
"not_eligible_reason": null,
"rate_plan": null,
"is_direct": true,
"age_of_credit_file": "59.79",
"partner_age_of_credit_file": null,
"tier": null,
"balloon_amount": null,
"balloon_percentage": "0.00%",
"broker_commission": null,
"loan_purpose_array": [
{
"loan_purpose": "Asset Purchase - Private Sale",
"loan_amount": 15500,
"payee": "ALEGACYPRAH ALEGACYM PRAHLLEGACYA",
"description": null
}
]
}
}
json
{
"message": "Unauthenticated."
}
🕓 Changelog
2024-10-17
🐞 Bug Fixes:
- Field
sales_incentive_commission
andannual_bonus
are now showing the correct maximum value