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.

Overview

Overview

Authentication, base URLs, and endpoint flows by integration type

The iwoca Lending API lets you refer customers for business finance, track their application, and surface offers. The endpoints you call depend on your integration type.

Endpoint flow by integration type

Create a customer and hand off to iwoca.

  1. 1
    POST /customers/

    Create the customer with company and director details.

  2. 2
    POST /customers/{customer_id}/applications/

    Submit a loan application with the requested amount.

  3. 3
    GET /customers/{customer_id}/login_link/

    Redirect the customer to iwoca to complete the process.

Additional endpoints

Beyond the core flow, you can use additional endpoints for document uploads, repayment schedules, funding account details, prequalification, and more. Browse the sidebar to explore all endpoints.


Authentication

curl -X GET https://stage.iwoca-dev.co.uk/api/lending/v2.2/authentication_check/ \
-H "Authorization: Bearer {your_api_token}" \
-H "Accept: application/json"
{
"data": {
"api_version": "2.2.0"
}
}
  1. 1
    Get your API token

    Retrieve your token from the Partner Developer Portal. You'll have separate tokens for sandbox and production.

  2. 2
    Set required headers

    Every request needs Authorization and Accept. POST/PATCH requests also need Content-Type.

  3. 3
    Verify your connection

    Call GET /authentication_check/ to confirm everything is working before building your integration.

Reference