List approvals | Finput Docs

[
  {
    "name": "Low doc to $150k, property owner",
    "doc_level": "low_doc",
    "id": 1,
    "organisation_id": 1,
    "priority": 0,
    "min_deposit_percentage": "string",
    "min_deposit_amount": "string",
    "max_term": 1,
    "min_term": 1,
    "min_abn_age": 1,
    "max_abn_age": 1,
    "min_gst_age": 1,
    "max_gst_age": 1,
    "min_asset_age": 1,
    "max_asset_age": 1,
    "min_asset_cost": "string",
    "max_asset_cost": "string",
    "min_borrower_age": 1,
    "max_borrower_age": 1,
    "min_file_age": 1,
    "max_file_age": 1,
    "min_credit_score": 1,
    "max_credit_score": 1,
    "home_owner": true,
    "private_sale": true,
    "sale_hire_back": true,
    "asset_state": "none",
    "transaction_types": [
      "purchase"
    ],
    "industries": [
      "string"
    ],
    "assets": [
      1
    ]
  }
]

Approval destinations visible to the caller. Reads are open to any authenticated user — a broker’s matrix results are derived from these rows, so they are not secret.

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Query parameters

organisation_idintegerOptional

Filter to one financier.

Response

Approvals

namestring<=99 characters

doc_levelenum

Documentation burden. Results sort least-onerous first.

Allowed values:

idintegerOptionalRead-only

organisation_idintegerOptional

Owning financier. Set from the caller.

priorityfloatOptionalDefaults to 0

Ordering within a financier's group — higher sorts first, so a financier decides which of their approvals is the headline row.

min_deposit_percentagestring or nullOptional

min_deposit_amountstring or nullOptional

max_terminteger or nullOptional

Longest term (months) this approval will write. Does two jobs: it is shown on the Matrix result row, and it is the upper bound a supplied term is tested against.

min_terminteger or nullOptional

Shortest term (months) this approval will write. Criterion only — unlike max_term it is not shown on the result row.

min_abn_ageinteger or nullOptional

Months.

max_abn_ageinteger or nullOptional

min_gst_ageinteger or nullOptional

Months.

max_gst_ageinteger or nullOptional

min_asset_ageinteger or nullOptional

Months.

max_asset_ageinteger or nullOptional

min_asset_coststring or nullOptional

GST-inclusive dollars.

max_asset_coststring or nullOptional

min_borrower_ageinteger or nullOptional

Years — brokers state borrower age in years, not months.

max_borrower_ageinteger or nullOptional

min_file_ageinteger or nullOptional

Credit-file age in months.

max_file_ageinteger or nullOptional

min_credit_scoreinteger or nullOptional

Credit score floor. Distinct from credit-file age.

max_credit_scoreinteger or nullOptional

home_ownerboolean or nullOptional

Tri-state — null is "not checked", true/false must match.

private_saleboolean or nullOptional

sale_hire_backboolean or nullOptional

asset_stateenumOptional

Allowed values:

transaction_typeslist of enumsOptional

Empty means every transaction type.

Allowed values:

industrieslist of stringsOptional

ANZSIC divisions. Empty means every industry.

assetslist of integersOptionalRead-only