Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
grossIncome
number
required

Monthly Gross Income ($)

Required range: 0 <= x <= 99999999
interestRate
number
required

Annual Interest Rate (%)

Required range: 0 <= x <= 50
loanTerm
number
required

Loan Term (years)

Required range: 1 <= x <= 50
existingDebts
number

Existing Monthly Debts ($)

Required range: 0 <= x <= 99999999
downPayment
number

Down Payment ($)

Required range: 0 <= x <= 99999999
loanType
enum<string>

DTI Preset

Available options:
mortgage,
personal,
auto,
custom
frontEndDti
number

Front-End DTI Limit (%)

Required range: 10 <= x <= 60
backEndDti
number

Back-End DTI Limit (%)

Required range: 10 <= x <= 70

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.