API Lite testing

Use this guide to test your API Lite integration in the sandbox environment. The test data below triggers specific outcomes so you can verify every customer pathway.

What you need to test

As a minimum, your integration needs to show:

• A new customer and application using the minimum data requirements
• Data formatted correctly following best-practice guidelines
• Endpoints used correctly and at the right stage in the journey
• Login link generated and displayed to the customer

Test data

The data below should be used as the basis for all tests. Sending this data unchanged returns a confirmed offer.

Customer payload

{
    "data": {
        "company": {
            "company_number": "01111112",
            "registered_company_name": "COMPANY NAME",
            "type": "limited_liability_company",
            "trading_from_date": "2010-02-01",
            "last_12_months_turnover": {
                "amount": 700000,
                "valid_from": "{{currentDate}}"
            },
            "vat_status": {
                "is_vat_registered": false
            }
        },
        "people": [
            {
                "uid": "6cf7319e-f9ec-4038-ba4f-3561a6097484",
                "title": "mr",
                "first_name": "Ervin",
                "last_name": "Norton",
                "date_of_birth": "1980-01-01",
                "emails": [
                    {
                        "email": "enorton1777+test@iwoca.co.uk",
                        "type": "primary"
                    }
                ],
                "phones": [
                    {
                        "type": "primary",
                        "number": "07700900370"
                    }
                ],
                "residential_addresses": [
                    {
                        "country": "GB",
                        "date_from": "2014-02-03",
                        "house_number": "286",
                        "postcode": "CB62AG",
                        "residential_status": "owner_with_mortgage",
                        "street_line_1": "Idverifier St",
                        "town": "Ely"
                    }
                ],
                "privacy_policy": {
                    "agreed": true,
                    "valid_from": "{{currentDate}}"
                },
                "roles": [
                    "applicant",
                    "shareholder",
                    "guarantor",
                    "director"
                ]
            }
        ]
    }
}

Application payload

{
    "data": {
        "requests": [
            {
                "amount": 15000,
                "duration": {
                    "amount": 12,
                    "unit": "months"
                }
            }
        ]
    }
}

Simulating different outcomes

Adjust the test data to trigger specific scenarios:

Decline test data

Change the following fields in the customer payload:

{
    "first_name": "James",
    "last_name": "Smythe",
    "date_of_birth": "1985-01-01",
    "company_number": "01111113",
    "house_number": "123",
    "street_line_1": "Decline St",
    "town": "Decline",
    "postcode": "DE61NA"
}

This returns an empty offers array with offer_creation_status: "decline" when you call GET /offers/.

Validation checklist

Before submitting for review, verify:

• Customer data formatted correctly with minimum required fields.
• Application created successfully with valid amount.
• Login link generated and redirects to iwoca.
• Webhook responses received (if applicable).

Next steps