# iwoca Lending API

> Public API documentation for iwoca's Lending API (UK). Integrate embedded business lending into your platform.

## Full documentation

- [Complete documentation as a single file](https://lending-api-docs.iwoca.co.uk/llms-full.txt): Every page in one file — guides and reference overviews in full, endpoints as title, tag and summary
- [OpenAPI schema](https://lending-api-docs.iwoca.co.uk/api-reference/openapi/overview.md): How to use the machine-readable OpenAPI 3.1 spec, downloadable at `/openapi.json`, including webhook payload schemas
- [Any page as markdown](https://lending-api-docs.iwoca.co.uk/llms.txt): Append `.md` to any page path, e.g. /guides/webhooks/overview.md — an endpoint's `.md` carries its parameters, schemas and examples

## Guides

- [Funding account details](https://lending-api-docs.iwoca.co.uk/guides/additional-concepts/funding-account-details.md): Pre-populate customer bank account information to streamline drawdown
- [Prequalification](https://lending-api-docs.iwoca.co.uk/guides/additional-concepts/prequalification.md): Show customers personalised loan amounts before they apply
- [Repayment Schedule](https://lending-api-docs.iwoca.co.uk/guides/additional-concepts/repayment-schedule.md): Generate detailed repayment breakdowns to help customers plan their cash flow
- [Sharing documents](https://lending-api-docs.iwoca.co.uk/guides/additional-concepts/sharing-documents.md): Upload documents and bank statements to improve outcomes for your customers
- [Broker integration guidance](https://lending-api-docs.iwoca.co.uk/guides/brokers/overview.md): How iwoca works for brokers and hybrid partners
- [API versioning policy](https://lending-api-docs.iwoca.co.uk/guides/general/api-versioning-policy.md): How iwoca manages API versions, upgrades, and deprecation
- [Developer Services Licence Agreement](https://lending-api-docs.iwoca.co.uk/guides/general/dsla.md): Terms and conditions for using iwoca's Developer Services and Lending API
- [FAQs](https://lending-api-docs.iwoca.co.uk/guides/general/faqs.md): Frequently asked questions about the iwoca Lending API
- [UX guidance](https://lending-api-docs.iwoca.co.uk/guides/general/ui-implementation-guidance.md): Screen-by-screen guidance for building your customer-facing lending journey
- [Build with AI](https://lending-api-docs.iwoca.co.uk/guides/getting-started/ai-integration.md): Use AI coding tools to build your iwoca integration faster
- [Access the API](https://lending-api-docs.iwoca.co.uk/guides/getting-started/authentication.md): How to authenticate with the iwoca Lending API
- [Our product: Flexi-Loan](https://lending-api-docs.iwoca.co.uk/guides/getting-started/flexi-loan.md): Understanding iwoca's flagship flexible credit facility for small businesses
- [Introduction to iwoca](https://lending-api-docs.iwoca.co.uk/guides/getting-started/introduction-to-iwoca.md): Learn about iwoca's embedded lending platform for partners
- [API Plus](https://lending-api-docs.iwoca.co.uk/guides/integration-options/enhanced-integration.md): Build a fully customised lending experience where customers see offers from within your platform
- [No-code link](https://lending-api-docs.iwoca.co.uk/guides/integration-options/no-code-lending-link.md): Offer your customers iwoca lending in minutes – just share a link
- [Overview](https://lending-api-docs.iwoca.co.uk/guides/integration-options/overview.md): Choose how to integrate iwoca's business lending into your platform
- [API Lite](https://lending-api-docs.iwoca.co.uk/guides/integration-options/referral-api-integration.md): Collect customer information in your platform and refer them to iwoca
- [API Plus testing](https://lending-api-docs.iwoca.co.uk/guides/testing/decision-relayed-testing.md): Test scenarios and data for the API Plus integration
- [Go live](https://lending-api-docs.iwoca.co.uk/guides/testing/go-live.md): Submit your integration for review and launch to production
- [Test your integration](https://lending-api-docs.iwoca.co.uk/guides/testing/overview.md): Test your integration in the sandbox environment before going live
- [API Lite testing](https://lending-api-docs.iwoca.co.uk/guides/testing/referral-integration-testing.md): Test scenarios and data for the API Lite integration
- [Event types](https://lending-api-docs.iwoca.co.uk/guides/webhooks/event-types.md): Available webhook events, when they fire, and example payloads
- [How webhooks work](https://lending-api-docs.iwoca.co.uk/guides/webhooks/overview.md): Receive real-time notifications when application statuses change
- [Security](https://lending-api-docs.iwoca.co.uk/guides/webhooks/security.md): Verify webhook signatures and handle retries

## API reference overviews

- [Application overview](https://lending-api-docs.iwoca.co.uk/api-reference/application/overview.md): Application statuses, update rules, and key constraints
- [Customer overview](https://lending-api-docs.iwoca.co.uk/api-reference/customer/overview.md): Key requirements and best practices for creating customers
- [Developer Portal overview](https://lending-api-docs.iwoca.co.uk/api-reference/developer-portal/overview.md): Invite team members to your partner developer account
- [Documents overview](https://lending-api-docs.iwoca.co.uk/api-reference/documents/overview.md): Upload formats, timing, and JSON bank statement structure
- [Funding account details overview](https://lending-api-docs.iwoca.co.uk/api-reference/funding-account-details/overview.md): Specify where iwoca should send funds
- [Fundings overview](https://lending-api-docs.iwoca.co.uk/api-reference/fundings/overview.md): Retrieve draw down history for a customer
- [Introducers overview](https://lending-api-docs.iwoca.co.uk/api-reference/introducers/overview.md): Manage introducer records associated with your partner account
- [Login link overview](https://lending-api-docs.iwoca.co.uk/api-reference/login-link/overview.md): Generate single-use magic links for customer access
- [Offers overview](https://lending-api-docs.iwoca.co.uk/api-reference/offers/overview.md): Offer types, data requirements, and retrieval strategies
- [OpenAPI schema](https://lending-api-docs.iwoca.co.uk/api-reference/openapi/overview.md): Download the machine-readable OpenAPI 3.1 schema for the Lending API
- [Overview](https://lending-api-docs.iwoca.co.uk/api-reference/overview.md): Authentication, base URLs, and endpoint flows by integration type
- [Prequalification overview](https://lending-api-docs.iwoca.co.uk/api-reference/prequalification/overview.md): Upload customer data for pre-screening before a full application
- [Repayment schedule overview](https://lending-api-docs.iwoca.co.uk/api-reference/repayment-schedule/overview.md): Month-by-month repayment breakdowns for offers
- [Offer selection overview](https://lending-api-docs.iwoca.co.uk/api-reference/select/overview.md): Selecting offers for customer draw down
- [Webhooks overview](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/overview.md): How to receive real-time events from iwoca, and the endpoints that manage them

## API reference

### Authentication Check

- [GET /authentication_check/](https://lending-api-docs.iwoca.co.uk/api-reference/authentication-check/get-authentication-check.md) — Authentication check for partners

### Customer

- [POST /customers/](https://lending-api-docs.iwoca.co.uk/api-reference/customer/post-customers.md) — Create an iwoca account for a new customer

### Application

- [POST /customers/{customer_id}/applications/](https://lending-api-docs.iwoca.co.uk/api-reference/application/post-customers-applications.md) — Create user application
- [PUT /customers/{customer_id}/applications/](https://lending-api-docs.iwoca.co.uk/api-reference/application/put-customers-applications.md) — Create or update user application
- [GET /customers/{customer_id}/applications/latest/](https://lending-api-docs.iwoca.co.uk/api-reference/application/get-customers-applications-latest.md) — Get user latest application
- [PATCH /customers/{customer_id}/applications/latest/](https://lending-api-docs.iwoca.co.uk/api-reference/application/patch-customers-applications-latest.md) — Update user application

### Login Link

- [GET /customers/{customer_id}/login_link/](https://lending-api-docs.iwoca.co.uk/api-reference/login-link/get-customers-login-link.md) — Get a login link for a customer

### Offers

- [GET /applications/{application_id}/offers/](https://lending-api-docs.iwoca.co.uk/api-reference/offers/get-applications-offers.md) — Generate offers

### Repayment Schedule

- [GET /offers/{offer_id}/repayment_schedule/](https://lending-api-docs.iwoca.co.uk/api-reference/repayment-schedule/get-offers-repayment-schedule.md) — Get repayment schedule for an offer

### Documents

- [GET /document_upload/{customer_id}/](https://lending-api-docs.iwoca.co.uk/api-reference/documents/get-document-upload.md) — Get list of documents uploaded
- [POST /document_upload/{customer_id}/](https://lending-api-docs.iwoca.co.uk/api-reference/documents/post-document-upload.md) — Upload a document
- [POST /bank_statements/{customer_id}/](https://lending-api-docs.iwoca.co.uk/api-reference/documents/post-bank-statements.md) — Upload a JSON bank statement

### Select

- [POST /offers/{offer_id}/select/](https://lending-api-docs.iwoca.co.uk/api-reference/select/post-offers-select.md) — Select user offer and update entity to contact

### Fundings

- [GET /customers/{customer_id}/fundings/](https://lending-api-docs.iwoca.co.uk/api-reference/fundings/get-customers-fundings.md) — List funds the customer has taken

### Funding Account Details

- [POST /funding_account_details/{customer_id}/](https://lending-api-docs.iwoca.co.uk/api-reference/funding-account-details/post-funding-account-details.md) — Create funding account details for user

### Introducers

- [GET /introducers/](https://lending-api-docs.iwoca.co.uk/api-reference/introducers/get-introducers.md) — Get introducers associated with a partner
- [POST /introducers/](https://lending-api-docs.iwoca.co.uk/api-reference/introducers/post-introducers.md) — Create introducer associated with a partner

### Developer Portal

- [POST /partner_developer_invite/](https://lending-api-docs.iwoca.co.uk/api-reference/developer-portal/post-partner-developer-invite.md) — Invite partner developer

### Prequalification

- [GET /prequalification_data/](https://lending-api-docs.iwoca.co.uk/api-reference/prequalification/get-prequalification-data.md) — List prequalification quotes generated for a partner.
- [POST /prequalification_data/](https://lending-api-docs.iwoca.co.uk/api-reference/prequalification/post-prequalification-data.md) — Pre-qualify customers

### Webhook Management

- [GET /webhooks/configuration/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/get-webhooks-configuration.md) — Get current webhook configuration
- [PUT /webhooks/configuration/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/put-webhooks-configuration.md) — Configure webhook url and token
- [GET /webhooks/subscriptions/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/get-webhooks-subscriptions.md) — Get webhook subscriptions
- [POST /webhooks/subscriptions/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/post-webhooks-subscriptions.md) — Subscribe to webhooks
- [DELETE /webhooks/subscriptions/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/delete-webhooks-subscriptions.md) — Unsubscribe from webhooks
- [GET /webhooks/event_types/](https://lending-api-docs.iwoca.co.uk/api-reference/webhook-management/get-webhooks-event-types.md) — Get available webhook event types

### Webhooks

- [Webhook event: application_attributed](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-application-attributed.md) — application_attributed
- [Webhook event: application_declined](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-application-declined.md) — application_declined
- [Webhook event: application_deferred](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-application-deferred.md) — application_deferred
- [Webhook event: application_offered](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-application-offered.md) — application_offered
- [Webhook event: application_status_changed](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-application-status-changed.md) — application_status_changed
- [Webhook event: customer_funded](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-customer-funded.md) — customer_funded
- [Webhook event: funding_created_202607](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-funding-created-202607.md) — funding_created_202607
- [Webhook event: indicative_offer_created](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-indicative-offer-created.md) — indicative_offer_created
- [Webhook event: prequalification_202505](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-prequalification-202505.md) — prequalification_202505
- [Webhook event: prequalification_data_file_processed_202510](https://lending-api-docs.iwoca.co.uk/api-reference/webhooks/post-prequalification-data-file-processed-202510.md) — prequalification_data_file_processed_202510