---
title: "API Lite"
description: "Collect customer information in your platform and refer them to iwoca"
icon: "code"
---

> For the complete documentation index, see [llms.txt](/llms.txt).

Integrate iwoca's lending by collecting customer information in your platform, then referring the customer to iwoca to view their decision and complete the final steps.
API Lite strikes a good balance between impact and effort – you reduce customer friction without building complex UI.

## Prerequisites

Before you begin, make sure you have:

- Access to our Partner Developer Portal, where you can get your API token for the sandbox environment.

<Info>
**Don't have access?** Chat with your Partnership Manager to gain access to the Partner Developer Portal.
</Info>


<Accordion title="Meet our compliance requirements" icon="shield" variant="important">
  Before sharing the customer's information with iwoca, you must include a clear privacy notice.
  Your privacy notice must disclose the following:

  1. **Data sharing with iwoca** – Customer data will be shared with iwoca to process their application.
  2. **Soft credit checks** – Credit reference agencies will run soft credit and identity checks (which will not affect the customer's credit score).
  3. **Fraud prevention agencies** – Data will be shared with fraud prevention agencies, and if fraud is detected, the customer or others could be refused services, finance, or employment.
  4. **iwoca's privacy policy** – Include an easily accessible link to iwoca's privacy policy.
     You can also include this within your own privacy policy.

  <Warning>
  This notice must be clearly visible to the customer before you submit their data to iwoca.
  It cannot be buried in general terms and conditions. iwoca will verify this is in place during the go-live review.
  </Warning>

  **Example wording:**

  Use the version that matches who you share customer data with.

  **Sharing with iwoca only**

  <Info>
  'We plan to show you credit offers from our finance partner iwoca. Tick here to let us know that we have your permission to share relevant data with iwoca. iwoca will share your information with credit reference agencies to run soft credit and identity checks, but don't worry – this will not affect your credit score. They will also share it with fraud prevention agencies – please be aware, if they do spot fraud, you or others could be refused services, finance, or employment. For more information, please see [iwoca's privacy policy](https://www.iwoca.co.uk/privacy-policy/).'
  </Info>

  **Sharing with a panel of lenders**

  Use this version if you share data with a wider panel of providers.
  Here, 'our privacy policy' links to your own privacy policy, which must in turn link to [iwoca's privacy policy](https://www.iwoca.co.uk/privacy-policy/).

  <Info>
  'We plan to show you credit offers from carefully selected providers. Tick here to let us know that we have your permission to share relevant data with these providers. These providers will share your information with credit reference agencies to run soft credit and identity checks, but don't worry – this will not affect your credit score. They will also share it with fraud prevention agencies – please be aware, if they do spot fraud, you or others could be refused services, finance, or employment. For more information please see [our privacy policy](#).'
  </Info>
</Accordion>

---

<Accordion title="Build with AI?" icon="microchip-ai" variant="boxed">
Add our docs to your AI coding tool and let it scaffold the integration for you. The manual steps below remain the source of truth if you'd rather build by hand.

<Steps>
  <Step title="Point your AI tool at our docs">
    This gives your AI assistant the full text of our documentation to work from.

    <Prompt description="Paste into your AI tool" actions={["copy"]}>
Read the iwoca Lending API docs at https://lending-api-docs.iwoca.co.uk/llms-full.txt and help me build my integration.
    </Prompt>
  </Step>
  <Step title="Use this prompt to get started">
    Copy this into Claude, Cursor, or ChatGPT:

    <Prompt description="I'm building an API Lite integration with iwoca's lending API. Help me create a customer, submit a loan application, and retrieve a login link so the customer can complete their journey on iwoca's platform. Use the iwoca lending docs for reference." actions={["copy", "cursor"]}>
I'm building an API Lite integration with iwoca's lending API. Help me create a customer, submit a loan application, and retrieve a login link so the customer can complete their journey on iwoca's platform. Use the iwoca lending docs for reference.
    </Prompt>
  </Step>
</Steps>
</Accordion>

---

## Integration steps

<Tip>
**Building the customer-facing screens?**
See our [UX guidance](/guides/general/ui-implementation-guidance) for the customer and application forms – company search, director selection, address lookup, amount validation, and the privacy notice.
</Tip>

<Steps>
  <Step title="Create a customer">
    Send your customer's contact information to iwoca.

    ```http
    POST /customers/
    ```

    **You'll need:**

    - Company details (for example, registration number, name, turnover in last 12 months, VAT status)
    - Applicant details (name, email, phone, address, date of birth)

    **Response:** You'll receive a `customer_id` to use in subsequent requests.
    Store it — you'll need it later.

    See the [Customer overview](/api-reference/customer/overview) for full field requirements.
  </Step>
  <Step title="Submit an application">
    Send your customer's product request information.

    ```http
    POST /customers/{customer_id}/applications/
    ```

    **You'll need:**

    - Loan amount (£1,000–£1,000,000)
    - Loan duration (optional)
    - Purpose of funds (optional)

    **Response:** You'll receive an `application_id` and the application status.
    Store it — you'll need it later.

    This creates the application, which allows iwoca to start the credit decision.
    One of our Account Managers will reach out to you or your customer (according to your contact strategy — the agreed plan for who iwoca contacts and how).

    See the [Application overview](/api-reference/application/overview) for details.
  </Step>
  <Step title="Retrieve a login link">
    Generate a secure link that allows the customer to view their application or offer on iwoca's website directly, with a single click.

    ```http
    GET /customers/{customer_id}/login_link/
    ```

    **Response:** You'll receive a single-use URL.

    This redirects your customer to iwoca's platform.
    Depending on their assessment, they'll either upload additional documents or accept an offer and draw down the funds.

    See the [Login link overview](/api-reference/login-link/overview) for details.
  </Step>
</Steps>

---

## Next steps

<CardGroup cols={2}>
  <Card title="API Plus" icon="arrow-up-right-dots" href="/guides/integration-options/enhanced-integration">
    Surface offers directly in your platform
  </Card>
  <Card title="Additional features" icon="puzzle-piece" href="/guides/additional-concepts/sharing-documents">
    Discover endpoints for a better customer experience
  </Card>
  <Card title="Webhooks" icon="bell" href="/guides/webhooks/overview">
    Real-time notifications on application status changes
  </Card>
  <Card title="Testing & go-live" icon="flask" href="/guides/testing/overview">
    Test your integration before going live
  </Card>
</CardGroup>