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.

Additional Concepts

Eligibility check

Find out if a business is eligible to apply for a Flexi-Loan

The eligibility check endpoint tells you whether a business is eligible to apply for a loan with iwoca, before you create an application. You send the business's Companies House number, and we let you know whether the company is eligible to apply.

Not enabled by default. The eligibility check must be switched on for your account before you can use it. To get started, contact your iwoca Partnership Manager or email partners@iwoca.co.uk.

How it works

  1. 1
    Check the business
    POST /eligibility_check/

    You'll need:

    • The business's Companies House number
    • Optionally, its SIC code
    • Optionally, its MCC code
    • Optionally, your own reference, such as a tier, or other non-PII data

    Response: You'll receive is_eligible and an eligibility_check_id for your records.

  2. 2
    If it's eligible, send it to iwoca

    Eligible means the business can apply, not that it's approved for a loan. Create the customer and their application as usual, using API Lite or API Plus.

  3. 3
    If it's not eligible, don't send it

    iwoca can't help this business right now, so sending it would give your customer a poor experience.

Run a new check before each submission, as a business's eligibility can change.

Test in the sandbox

Three Companies House numbers return deterministic verdicts on the sandbox:

Companies House numberResponse
01111112is_eligible: true
01111113is_eligible: true
01111119is_eligible: false

These test numbers only work in the sandbox. In production, every call runs a real check.


Next steps