Start Here

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

What you can build

Ops syncs: clients, loans, repayments, savings
Embedded borrower experiences (client portal APIs)
Webhook-driven event consumers

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

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

Response shape

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

Always log request_id when debugging.

Guides

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

API reference

Endpoint groups (Health, Clients, Loans, …) appear below this page in the sidebar. Start with Quickstart or expand Loans → Available loan products for live product_id values.

Production base URL

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