Serviceability Request Fields

This page describes the fields you send to the serviceability endpoint. Monetary amounts are integer cents (for example, 320000). To send a LIXI CAL package instead of JSON, see LIXI CAL.

Top-level envelope

Field	Type	Required	Notes
brokerDetails	object	Yes	Identity of the submitting broker. See broker details.
scenario	object	Yes	Declared serviceability data. See scenario block.
partnerScenarioReference	string	No	Non-unique partner trace reference, echoed back. The unique preSubmissionRequestUid is what links the quote at submission (via X-PreSubmission-Ref).

Scenario block

The scenario object carries the declared serviceability data. It contains no direct identifiers such as names or dates of birth.

Field	Type	Required	Notes
applicants	integer	Yes	Number of adult applicants. Drives the HEM benchmark.
loan	object	Yes	The proposed loan. See proposed loan.
dependants	integer	No	Number of financial dependants in the household.
postcode	string	No	Australian postcode of the applicant's current residential address (for example, "3000").
incomes	array	No	Declared income streams. See incomes.
expenses	number	No	Declared monthly living expenses in cents. Omit to let Slate apply the HEM benchmark; supply a figure to override it upward. Slate assesses on the higher of the two.
liabilities	array	No	Declared existing liabilities. See liabilities.
security	object	No	The property backing the loan. See security.

Incomes

scenario.incomes is an array of declared income streams. Each entry has:

Field	Type	Required	Notes
type	string	Yes	Income type code: PAYG, SELF_EMPLOYED, RENTAL, or GOVERNMENT.
annualAmount	number	Yes	Gross annualised amount in cents, regardless of frequency.
frequency	string	Yes	How the broker captured it: ANNUAL, MONTHLY, FORTNIGHTLY, or WEEKLY. Does not change annualAmount.

Liabilities

scenario.liabilities is an array of declared existing liabilities. Each entry has:

Field	Type	Required	Notes
type	string	Yes	Liability type code: CREDIT_CARD, PERSONAL_LOAN, BNPL, or HECS.
balance	number	No	Outstanding balance in cents.
limit	number	No	Credit limit in cents. Applicable to revolving facilities such as credit cards.
monthlyRepayment	number	No	Contractual monthly repayment in cents.

Proposed loan

scenario.loan is a single proposed loan. Slate sets the interest rate from the selected product and may split the loan internally into a primary and a deposit-boost component.

Field	Type	Required	Notes
amount	number	Yes	Requested loan amount in cents. The total Slate may split into a primary and a deposit-boost component.
termYears	integer	Yes	Loan term in years (for example, 30).
purpose	string	Yes	OwnerOccupied or Investment. Selects the product line the scenario routes to.

The product the scenario routes to is named per 1% LVR band (see Products).

Security

scenario.security describes the property backing the loan. Supply it to receive an lvrPercent on the response and to let Slate assess LVR-dependent products such as deposit boost. Omit it and the response omits the LVR.

Field	Type	Required	Notes
estimatedValue	number	Yes	Estimated value of the security property in cents. Slate derives LVR as loan.amount / estimatedValue.

Broker details

The brokerDetails object identifies the broker submitting the scenario. All fields are required for traceability and compliance. A missing field is rejected without echoing any submitted value.

Field	Type	Required	Notes
brokerName	string	Yes	Broker full name.
brokerId	string	Yes	Broker identifier within your platform.
aclNumber	string	Yes	Australian Credit Licence (ACL) number the broker operates under.
acrNumber	string	Yes	Australian Credit Representative (ACR) number of the broker.
brokerEmail	string	Yes	Broker contact email address.

Further reading

See the API Reference for full request and response schemas, and the Error Reference for validation and routing errors.