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.

Eligibility check

Check whether a company is eligible to apply for a loan with iwoca

Submit a single company's details and get an immediate eligible / not eligible verdict.

POST/eligibility_check/

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.

Body

companies_house_numberstringrequired

Companies House number of the business being checked.

<= 255 characters
detailsstring

Optional free-text metadata to attach to this check - for example, your internal lead tier. Must not contain personal data.

<= 255 characters
mcc_codestring

Optional MCC code for the business being checked.

<= 255 characters
sic_codestring

Optional SIC code for the business being checked.

<= 255 characters

Responses

Eligibility verdict

eligibility_check_idstring<uuid>required

Reference ID for this check. Quote this when raising support queries with iwoca.

is_eligiblebooleanrequired

True if the company is eligible to apply, else false.