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.

Customer

Customer overview

Key requirements and best practices for creating customers

Create an iwoca account for a business customer. You provide company and director details, and receive a customer_id used in all subsequent requests.

Essentials

  1. 1
    Include minimum data

    The following data is the minimum needed to make a decision and the complete set needed for an automated decision. Missing data means no automated decisions or indicative offers.

    CategoryFields
    Personal informationFirst name, Last name, Role within business (director), Email(s), Phone number(s), Date of birth, Residential address, Privacy policy agreement
    Business informationCompany name, Company number, Company type, Trading from date, Last 12 months turnover
    Request informationAmount
  2. 2
    Set the applicant role

    Exactly one person must have "roles": ["applicant", "director", "guarantor"]. The applicant must be a director who can provide a personal guarantee.

The privacy_policy.agreed: true field is required. It confirms your privacy policy covers sharing data with iwoca, and that soft credit checks and fraud prevention agency sharing are disclosed.

Avoiding duplicate customers

Duplicate customers cause delays because our team often needs to review them manually. Avoid submitting multiple duplicate requests to iwoca for the same customer.

Handle this on your end by preventing the same customer submitting a POST request to /customers/ multiple times. As a safeguard, you can also pass your own unique identifier (for example, your internal user or company ID) in the external_customer_id field. If you send a second POST /customers/ with the same external_customer_id, iwoca returns a 409 Conflict response containing the original customer_id rather than creating a duplicate:

{
"errors": [{
"code": "ConflictError",
"detail": "external_customer_id already exists",
"meta": {"customer_id": "894ff74b-b8fb-46ab-97d6-f9ff3428b779"}
}]
}

Use the returned customer_id from the 409 response to continue working with the existing customer rather than retrying the creation.

Reference