Overview

Get started quickly with our comprehensive Postman collection that includes all API endpoints, example requests and responses, and environment configurations for both sandbox and production environments.

Prerequisites

To use our Postman collection, you'll need:

A Postman account (free at postman.com)
API credentials
Postman desktop app (recommended) or web client

Quick Start

When you click the button above, you'll be taken to our public Postman workspace. Follow these steps to get started:

Sign in to Postman - You'll need a Postman account
Fork the Collection - Click "Fork" to create a copy of our collection in your own workspace
Select Your Workspace - Choose which workspace to add the collection to (or create a new one)
Start Testing - Once forked, you can begin using the collection with your own API credentials

What's Included

Complete API Coverage - All endpoints organized by functional area
Example Requests - Pre-configured requests with sample data
Authentication Setup - OAuth 2.0 configuration templates

Environment Setup

1. Import the Collection

Click the "Run in Postman" button above or manually import using:

Collection URL: https://www.postman.com/youlend/youlend-api

2. Configure Envrironment Variables

Set up the following variables in your Postman environment:

Variable	Description	Example
`base_url`	API base URL	`https://partners.staging-youlendapi.com`
`client_id`	Your client ID	`your_client_id_here`
`client_secret`	Your client secret	`your_client_secret_here`
`audience`	API identifier	`https://staging.youlendapi.com/onboarding`

3. Authentication

Our collection includes pre-request scripts that automatically handle OAuth 2.0 authentication. The access token will be refreshed automatically when needed. For complete setup instructions and environment details, see our Authentication Guide.

Collection Structure

Authentication

The Authentication collection provides pre-configured requests to obtain access tokens for all API domains. Once you have your client credentials (client_id and client_secret), these requests will automatically handle the OAuth 2.0 flow and generate the necessary tokens for each service area:

Onboarding token
Notification token
Prequalification token
Loan token
Preapproval token

This eliminates the need to manually configure authentication for each API domain - simply run the relevant authentication request and the token will be automatically set for use across all related endpoints.

Prequalification

Check merchant eligibility and get pre-qualification offers before starting the full application process.

Prequalification

1-Click Referral

Create lead

Partner Hosted Application

Endpoints for partners who want to host the application process within their own platform or interface.

Create lead
Add significant persons
Submit bank statements (JSON)
Submit bank statements (PDF)
Submit stage 1

Preapproval Solution

This folder contains the endpoints needed to deliver the preapproval solution.

Application Stage

Submit and manage loan applications, including document uploads and application status tracking.

Create lead
Add significant persons
Submit bank statement (JSON)
Submit JSON payment data
Submit account information
Submit stage 1

Pushbacks

Handle and respond to requests for additional information or clarification during the application review process.

Submit a response to pending information
Terminate a lead

Offers and Signing

Retrieve loan offers, accept terms, and manage document signing workflows.

Calculate loan offers
Accept a loan offer
Retrieve the documents to sign for the lead
Sign documents via 'instant signing'

Post Funding

Manage funded loans, including retrieving loan details, accessing settlement account information with account opening letters, and downloading loan documents.

Retrieve a loan by loan id
List settlement details with account opening letter
Retrive a document for a loan

Reporting

Access reporting data for loans and onboarding activities. Includes endpoints to retrieve loan information, repayment details, lead status, and onboarding progress for tracking purposes.

Loans Reporting

List loans with optional filtering
List loans by lead id
List repayment information for a loan

Onboarding Reporting

List leads with filtering applied
Retrieve onboarding details
Retrieve organisation details

Webhooks

Configure and manage webhook subscriptions to receive real-time notifications about loan status changes and events.

Creating a webhook
Get all events
Update webhook subscription
Delete a subscription