Use YouLend's staging test-support endpoints to move a test lead through offer creation, signing, loan creation, and funding without waiting for manual operational steps.

Overview

The self-serve testing flow follows the same core lifecycle as an Onboarding API integration, with additional Test Support API calls that let you create deterministic test offers and progress the loan state.

API areas

Two API areas are used in this flow:

Authentication and environments

Authenticate with YouLend's APIs using the Client Credentials flow from OAuth 2.0. See Authentication for token URLs, audience URLs, request examples, and bearer-token usage.

For self-serve testing, use the Test Support audience URL when requesting an access token for Test Support API endpoints.

The endpoint paths in this guide are relative to the relevant staging base URL:

• Onboarding API paths should be called against the Onboarding API base URL.
• Test Support API paths should be called against the Test Support API base URL.

Required IDs

Store each ID returned during the flow. Later steps depend on these values.

Happy path

1. Create a lead and submit it to stage 1

Create the lead using the Onboarding API. Then complete the usual lead setup steps required by your integration, such as significant persons, bank statements, and account information.

When the lead is ready, submit it to stage 1. No request body is required.

2. Create a fixed test offer

Use the Test Support API to create one or more fixed offers for the lead.

Example request:

{
  "offers": [
    {
      "youWillGet": 10000.0,
      "youWillRepay": 12000.0,
      "currencyISOCode": "GBP",
      "sweep": 15.0,
      "daysUntilRepayment": 180,
      "minimumWeeklyRepayment": 250.0,
      "maturityDate": "2026-10-01T00:00:00Z"
    }
  ]
}

Use the returned offers[].offerId in the next step.

3. Accept the offer

Accept the selected offer using the Onboarding API. No request body is required.

{
  "eligibleForInstantSigning": true
}

4. Retrieve documents to sign

Retrieve the unsigned documents using the Onboarding API. You will use the document id and name values when creating the signing request.

5. Create the signing request

Use the Test Support API to create a signing request.

Example request:

{
  "documentsToSign": [
    {
      "document": {
        "documentId": "11111111-1111-1111-1111-111111111111",
        "documentName": "Receivables Purchase Agreement.pdf"
      },
      "documentType": "loanDocument"
    }
  ]
}

Supported documentType values:

{
  "documentSigningId": "22222222-2222-2222-2222-222222222222"
}

6. Prepare the loan

Use the Test Support API to complete checks and prepare the loan. No request body is required.

This step completes the required test checks and prepares the loan prerequisites. If something is missing, the response will explain the missing prerequisite, such as borrower account details, lender selection, or suggested-loan readiness.

7. Create the loan

Use the Test Support API to create the loan. No request body is required.

{
  "loanId": "33333333-3333-3333-3333-333333333333",
  "loanNumber": 123456,
  "status": "Unfunded",
  "leadId": "44444444-4444-4444-4444-444444444444",
  "sourceOfferId": "55555555-5555-5555-5555-555555555555"
}

8. Fund the loan

Use the Test Support API to fund the latest loan for the lead. No request body is required.

{
  "leadId": "44444444-4444-4444-4444-444444444444",
  "loanId": "33333333-3333-3333-3333-333333333333"
}

Optional: Test non-happy-path states

Use these endpoints when testing non-happy-path scenarios, such as rejected leads, pending checks, credit-risk pushbacks, or loan lifecycle events.

{
  "status": "Ineligible",
  "reasons": [
    {
      "reasonCode": "EL017",
      "additionalInfo": "No longer progressing this lead"
    }
  ]
}

{
  "reasonCode": "PB001",
  "note": "Please provide proof of ID."
}

Common issues

Notes

• Use these endpoints only in staging/test environments.
• Store the returned IDs from each step; later steps depend on them.
• Most lifecycle endpoints do not require a request body.