Documentation index for AI agents (llms.txt)

Append .md to any page URL for its markdown source, or fetch llms-full.txt for the complete corpus.

Developer Portal
Application

Get user latest application

Returns user's latest application information

GET/customers/{customer_id}/applications/latest/

Authorizations

Authorizationstringheaderrequired

You must put the word Bearer or Token in the Authorization header before your token e.g:

Authorization: Bearer <Your API token>

Examples generated from this schema may be missing the word Bearer.

Path parameters

customer_idstringrequired

The unique customer_id used to represent a customer.

Responses

application_idstring<uuid>required

uid of application (uuid4)

When an application has been declined, this field will describe the reasons for the decline.

Array of object
reasonstringrequired
Allowed values:Approval requirement declineCredit assessment declineAuto-reject assessment declineResource declineIneligibility declineUnknownOther
reason_detailstring
is_closedbooleanrequired

Has the application been closed

Estimated revenue over the last 12 months. For a young business without a full year of revenue, revenue to date should be given.

amountnumberrequired

Amount submitted by customer in local currency or other estimate.

valid_fromstring<date-time>

Datetime when user submitted data, with expected ISO 8601 format.

Array of object
amountnumber<float>required
detailed_purposestringrequired

detailed_purpose is usually submitted if a purpose of other has been set.

is_topupbooleanrequired

Whether this request is a top-up on an existing loan.

purposestringrequired

A purpose may not be submitted if the customer is simply looking to get approved for the future, rather than a specific need.

Allowed values:stock_purchasebridging_loanmarketingequipment_purchasepay_billpay_staffrefinancing_debtfinancing_client_orderpay_tax_billothernull
urgencystringrequired

Describes whether the customer needs the funding immediately (asap), over the next few weeks (weeks) or is simply looking to get approved for future use (future).

Allowed values:asapweeksfuture_usenull
statusstringrequired

The current status of the user's latest application

Allowed values:fundedexpiredtalking_to_customeroffereddeclineddeferredin_underwritingawaiting_underwriteropenaction_requiredoffer_revokedcustomer_to_link_open_bankingconditional_offerconditional_offer_criteria_met