Application steps
Every application has five steps. Each step's fields go in data, and depend on the loan type (formType). These tables are generated from the rules RateMatch validates against, so a request that follows them is accepted.
- Numbers may be sent as numbers or numeric strings.
- Fields not listed are ignored.
- Step 5 is the same for every loan type and is sent with the credit check.
Personal loan formType: "personal"
Step 1: Loan amount
POST /applications
| Field | Required | Values |
|---|---|---|
loanAmount | Yes | number, 1000–100000 |
Step 2: Loan purpose and term
PATCH /applications/{id} with step: 2
| Field | Required | Values |
|---|---|---|
loanPurpose | Yes | "debt_consolidation", "home_improvement", "car_purchase", "medical_expenses", "holiday", "wedding", "education", "business", "other" |
loanTerm | Yes | number, 1–7 |
creditScoreEstimate | "excellent", "good", "average", "below_average", "poor", "unknown" |
Step 3: Employment and income
PATCH /applications/{id} with step: 3
| Field | Required | Values |
|---|---|---|
employmentType | Yes | "full_time", "part_time", "casual", "contract", "contractor", "self_employed", "unemployed", "retired", "student", "centrelink" |
employerName | string, not empty, up to 100 characters | |
employmentYears | number, 0–50 | |
employmentMonths | number, 0–11 | |
grossMonthlyIncome | Yes | number, 0–1000000 |
otherIncome | number, 0–10000000 (default 0) |
Step 4: Living situation
PATCH /applications/{id} with step: 4
| Field | Required | Values |
|---|---|---|
livingSituation | Yes | "renting", "own_outright", "own_mortgage", "living_with_parents", "boarding", "other" |
homeAddress | string, not empty, up to 500 characters | |
homeAddressComponents | object: streetNumber, streetName, streetType, suburb, state, postcode, country, unitNumber | |
monthlyRent | number, 0–50000 (default 0) | |
residentialYears | number, 0–100 | |
residentialMonths | number, 0–11 | |
dependents | number, 0–20 |
Step 5: Applicant details and consent
POST /applications/{id}/credit-check
| Field | Required | Values |
|---|---|---|
firstName | Yes | string, not empty, up to 100 characters |
lastName | Yes | string, not empty, up to 100 characters |
email | Yes | string (email) |
mobileNumber | Yes | string, 8–20 characters |
dateOfBirth | Yes | string, 8–20 characters |
gender | "male", "female", "other", "prefer_not_to_say" | |
maritalStatus | "single", "married", "de_facto", "divorced", "separated", "widowed" | |
address | string, not empty, up to 500 characters | |
homeAddress | string, not empty, up to 500 characters | |
streetNumber | string, up to 20 characters | |
streetName | string, up to 100 characters | |
streetType | string, up to 50 characters | |
suburb | string, up to 100 characters | |
state | "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" | |
postcode | string, up to 10 characters | |
unitNumber | string, up to 20 characters | |
consentCreditCheck | boolean | |
creditCheckConsent | boolean | |
privacyConsent | boolean | |
consentMarketing | boolean (default false) | |
marketingConsent | boolean (default false) | |
consentTerms | boolean | |
termsConsent | boolean |
- Credit check consent is required: send consentCreditCheck: true (creditCheckConsent or privacyConsent are accepted as aliases).
- dateOfBirth accepts YYYY-MM-DD or DD/MM/YYYY.
Car loan formType: "car"
Step 1: Car and purchase
POST /applications
| Field | Required | Values |
|---|---|---|
carLoanPurpose | Yes | "new", "used", "refinance", "NewCarPurchase", "UsedCarPurchase", "RefinanceCarLoan" |
hasFoundCar | "yes", "no" | |
estimatedCarPrice | number, 5000–200000 | |
vehicleYear | number, 1990–2027 | |
usedCarSaleType | "private", "dealer" |
- If hasFoundCar is "yes" (or the purpose is refinance), estimatedCarPrice is required.
- For a used car that has been found, vehicleYear and usedCarSaleType are also required.
Step 2: Loan structure
PATCH /applications/{id} with step: 2
| Field | Required | Values |
|---|---|---|
tradeInValue | number, 0–100000 (default 0) | |
tradeInPayout | number, 0–100000 (default 0) | |
depositAmount | number, 0–50000 (default 0) | |
loanAmount | Yes | number, 5000–200000 |
loanTerm | Yes | number, 1–7 |
balloonPaymentPercent | number, 0–35 (default 0) |
- balloonPaymentPercent must be 0 when loanTerm is 6 or 7 years.
Step 3: Employment and income
PATCH /applications/{id} with step: 3
| Field | Required | Values |
|---|---|---|
employmentType | Yes | "full_time", "part_time", "casual", "contract", "contractor", "self_employed", "unemployed", "retired", "student", "centrelink" |
employerName | string, not empty, up to 100 characters | |
employmentYears | number, 0–50 | |
employmentMonths | number, 0–11 | |
grossMonthlyIncome | Yes | number, 0–1000000 |
otherIncome | number, 0–10000000 (default 0) |
Step 4: Living situation
PATCH /applications/{id} with step: 4
| Field | Required | Values |
|---|---|---|
livingSituation | Yes | "renting", "own_outright", "own_mortgage", "living_with_parents", "boarding", "other" |
homeAddress | string, not empty, up to 500 characters | |
homeAddressComponents | object: streetNumber, streetName, streetType, suburb, state, postcode, country, unitNumber | |
monthlyRent | number, 0–50000 (default 0) | |
residentialYears | number, 0–100 | |
residentialMonths | number, 0–11 | |
dependents | number, 0–20 |
Step 5: Applicant details and consent
POST /applications/{id}/credit-check
| Field | Required | Values |
|---|---|---|
firstName | Yes | string, not empty, up to 100 characters |
lastName | Yes | string, not empty, up to 100 characters |
email | Yes | string (email) |
mobileNumber | Yes | string, 8–20 characters |
dateOfBirth | Yes | string, 8–20 characters |
gender | "male", "female", "other", "prefer_not_to_say" | |
maritalStatus | "single", "married", "de_facto", "divorced", "separated", "widowed" | |
address | string, not empty, up to 500 characters | |
homeAddress | string, not empty, up to 500 characters | |
streetNumber | string, up to 20 characters | |
streetName | string, up to 100 characters | |
streetType | string, up to 50 characters | |
suburb | string, up to 100 characters | |
state | "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" | |
postcode | string, up to 10 characters | |
unitNumber | string, up to 20 characters | |
consentCreditCheck | boolean | |
creditCheckConsent | boolean | |
privacyConsent | boolean | |
consentMarketing | boolean (default false) | |
marketingConsent | boolean (default false) | |
consentTerms | boolean | |
termsConsent | boolean |
- Credit check consent is required: send consentCreditCheck: true (creditCheckConsent or privacyConsent are accepted as aliases).
- dateOfBirth accepts YYYY-MM-DD or DD/MM/YYYY.
Home loan formType: "home"
Step 1: Purpose
POST /applications
| Field | Required | Values |
|---|---|---|
occupancyType | Yes | "owner_occupied", "investment" |
loanPurpose | Yes | "new_property", "refinance", "construction", "equity_release" |
isFirstHomeBuyer | "yes", "no" |
- isFirstHomeBuyer is required when loanPurpose is new_property or construction.
Step 2: Property
PATCH /applications/{id} with step: 2
| Field | Required | Values |
|---|---|---|
propertyValue | Yes | number, 100000–10000000 |
propertyAddress | Yes | string, not empty, up to 500 characters |
propertyAddressComponents | object: streetNumber, streetName, streetType, suburb, state, postcode, country, unitNumber | |
propertyType | Yes | "house", "apartment", "townhouse", "land", "unit", "villa", "other" |
Step 3: Loan details
PATCH /applications/{id} with step: 3
| Field | Required | Values |
|---|---|---|
loanAmount | Yes | number, 50000–10000000 |
loanTerm | Yes | number, 1–30 |
repaymentType | Yes | "principal_and_interest", "interest_only" |
settlementTimeframe | Yes | "within_30_days", "30_60_days", "60_90_days", "90_plus_days" |
Step 4: Employment and living situation
PATCH /applications/{id} with step: 4
| Field | Required | Values |
|---|---|---|
employmentType | Yes | "full_time", "part_time", "casual", "contract", "contractor", "self_employed", "unemployed", "retired", "student", "centrelink" |
livingSituation | Yes | "renting", "own_outright", "own_mortgage", "living_with_parents", "boarding", "other" |
homeAddress | string, not empty, up to 500 characters | |
homeAddressComponents | object: streetNumber, streetName, streetType, suburb, state, postcode, country, unitNumber | |
employmentYears | number, 0–50 | |
employmentMonths | number, 0–11 | |
grossMonthlyIncome | Yes | number, 0–1000000 |
Step 5: Applicant details and consent
POST /applications/{id}/credit-check
| Field | Required | Values |
|---|---|---|
firstName | Yes | string, not empty, up to 100 characters |
lastName | Yes | string, not empty, up to 100 characters |
email | Yes | string (email) |
mobileNumber | Yes | string, 8–20 characters |
dateOfBirth | Yes | string, 8–20 characters |
gender | "male", "female", "other", "prefer_not_to_say" | |
maritalStatus | "single", "married", "de_facto", "divorced", "separated", "widowed" | |
address | string, not empty, up to 500 characters | |
homeAddress | string, not empty, up to 500 characters | |
streetNumber | string, up to 20 characters | |
streetName | string, up to 100 characters | |
streetType | string, up to 50 characters | |
suburb | string, up to 100 characters | |
state | "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" | |
postcode | string, up to 10 characters | |
unitNumber | string, up to 20 characters | |
consentCreditCheck | boolean | |
creditCheckConsent | boolean | |
privacyConsent | boolean | |
consentMarketing | boolean (default false) | |
marketingConsent | boolean (default false) | |
consentTerms | boolean | |
termsConsent | boolean |
- Credit check consent is required: send consentCreditCheck: true (creditCheckConsent or privacyConsent are accepted as aliases).
- dateOfBirth accepts YYYY-MM-DD or DD/MM/YYYY.
Generated from prod@8a304e6.