Start Here

A guide to the Cladfy Microlender Embedded Finance API.

Welcome to the Cladfy Microlender API, the Embedded Finance surface for integrating third-party systems with Cladfy.

What you can build

• Ops syncs: clients, loans, repayments, savings
• Credit scoring, Know Your Customer and Know Your Business.
• Embedded borrower experiences (client portal APIs)

Base URL

https://{host}/api/v1/{tenant_slug}/partner/v1

Replace {tenant_slug} with your lender’s slug (visible in the Cladfy admin URL).

First call

1. Create a test key under Admin → Developers → API Keys.
2. Call GET /ping with header X-API-Key: clfy_test_….
3. Import the Postman collections from the Cladfy repo (external/postman/).

Response shape

JSON

{
  "code": "success",
  "message": "Success",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {}
}

Always log request_id when debugging.

Guides

Guide	Description
Authentication	API keys, scopes, and security
Test vs live	Sandbox vs production behavior
Quickstart	Five-call curl smoke test
Integration guide	Step-by-step onboarding (happy path)
Client portal	Embedded borrower APIs

API reference

Endpoint groups (Health, Clients, Loans, …) appear below this page in the sidebar.

Production base URL

https://app.cladfy.com/api/v1/{tenant_slug}/partner/v1