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.

Offers

Offers overview

Offer types, data requirements, and retrieval strategies

Generate and retrieve loan offers for a customer's application. Offers range from sample estimates to fully confirmed terms the customer can draw down on.

Essentials

  1. 1
    Call and wait

    This endpoint can take up to 30 seconds on the first call. Show a loading indicator. Subsequent calls are faster.

  2. 2
    Check offer type

    Offers progress from sample to indicative to confirmed. Only confirmed offers can be drawn down. Check data_requirements on non-confirmed offers to see what's needed to upgrade.

  3. 3
    Use webhooks for updates

    Rather than polling, listen for application_status_changed and application_offered webhooks. If polling, check GET /applications/latest/ for offered status before calling this endpoint.

New fields may be added at any time. Code defensively and ignore unrecognised fields.

Displaying offers

How you present an offer to the customer depends on its type.

Confirmed offers

Confirmed offers have fixed terms – the amount, monthly interest rate, and repayment schedule are set and will not change. The customer can draw down instantly.

  • Display the amount, monthly interest rate, duration, and total repayable as firm figures.
  • The CTA should allow the customer to draw down straight away (for example, 'Accept offer' or 'Draw down').

Indicative and sample offers

Indicative and sample offers are estimates based on the information available so far. The monthly interest rate, amount, and other terms are approximate and may change once iwoca completes a full assessment.

  • Clearly communicate that the figures shown are indicative and subject to change.
  • Do not present these as guaranteed terms.
  • The CTA should read 'Continue to iwoca' – directing the customer to complete any outstanding requirements and receive a confirmed offer.

Displaying indicative or sample offers as confirmed terms is misleading to customers. Always make it clear that these figures may change.

Reference