← Islamic Open Finance™Documentation

Complete API documentation.

Production-grade guides, OpenAPI references, type-safe SDKs in TypeScript / Python / Java / Go / Ruby, an MCP server for AI agents, and a SEPA Instant cookbook with four end-to-end recipes — everything you need to ship a Shariah-compliant flow in a sprint, not a quarter.

Quick start

Get your first API call working in under 5 minutes.

1

Get API Key

Request sandbox access to provision a tenant. Once approved, generate your API key from the Developer Portal.

curl -X POST https://api.islamicopenfinance.com/v1/auth/register
2

Create a Contract

Use the Contracts API to create your first Murabaha contract with a single POST request.

curl -X POST https://api.islamicopenfinance.com/v1/contracts/murabaha \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"assetDescription": "Vehicle", "costPrice": 50000}'
3

Check Compliance

Run automated Shariah compliance checks against AAOIFI standards on any contract.

curl https://api.islamicopenfinance.com/v1/compliance/check/CONTRACT_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

API reference

89 specialized rails across 19 categories, exposed via 142+ RESTful endpoints.

45+ endpoints

Core Islamic Contracts

Murabaha, Ijarah, Musharakah, Mudarabah, Salam, Istisna, Wakalah — 19 contract rails with full lifecycle management.

30+ endpoints

Compliance & Governance

Shariah compliance checks, audit trails, governance workflows, and regulatory reporting across multiple jurisdictions.

25+ endpoints

Financial Operations

Payments, treasury management, FX, risk assessment, liquidity, and profit distribution rails.

20+ endpoints

Capital Markets

Sukuk issuance, trading, settlement, valuation, and compliance for Islamic capital market instruments.

Integration guides

Step-by-step guides covering authentication, contracts, compliance, and multi-tenant configuration.

Authentication & API Keys

Sandbox and production key management, OAuth 2.0 flows, token refresh, and multi-tenant API key scoping.

Contract Lifecycle Management

Create, execute, amend, and close Islamic finance contracts. Covers all 19 contract types with event-driven state machines.

Compliance Integration

Automate AAOIFI compliance checks, generate regulatory evidence packs, and configure jurisdiction-specific policies.

Multi-Tenant Architecture

Tenant provisioning, workspace isolation, attribute-based access control (ABAC), and subdomain routing configuration.

SDKs & libraries

Official client libraries for your preferred language.

JavaScript / TypeScriptnpm install @iof/sdk
Pythonpip install iof-sdk
Gogo get github.com/islamic-open-finance/sdk-go
cURLNo installation needed
View all SDKs on GitHub
Related: Use cases · Readiness self-test · Training tracks · Contact · Certification