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
income
number
required

Gross Income ($)

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

Income Period

Available options:
monthly,
annual
monthlyDebt
number

Existing Debt Payments ($)

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

Utilities & Insurance ($)

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

Rent Budget (% of gross income)

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

Rent + Debt Limit (% of gross income)

Required range: 10 <= x <= 80
incomeMultiple
number

Landlord Income Multiple (× monthly rent)

Required range: 0 <= x <= 60

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.