API Reference

Welcome to the Islamic Open Finance™ API Reference. This documentation covers all available endpoints across our 29 specialized rails.

Base URL

All API requests should be made to:

Environment	Base URL
Production	https://api.islamicopenfinance.com
Sandbox	https://sandbox.islamicopenfinance.com

Authentication

All API requests require authentication using an API key:

curl https://api.islamicopenfinance.com/v1/contracts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

See Authentication for more details.

Request Format

• All requests must use HTTPS
• Request bodies should be JSON encoded
• Include Content-Type: application/json header

Response Format

All responses are JSON encoded with the following structure:

{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

For list endpoints:

{
  "data": [ ... ],
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  },
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 150,
    "totalPages": 8
  }
}

Available Rails

Core Rails

Rail	Description	Endpoints
Contracts	Islamic financial contracts lifecycle	15
KYC	Customer verification & identity	12
Compliance	Regulatory compliance checks	10
AML	Anti-money laundering screening	8

Financial Rails

Rail	Description	Endpoints
Treasury	Position & liquidity management	14
Clearing	Settlement & clearing operations	11
Ledger	Double-entry accounting	9
Billing	Usage metering & invoicing	7

Infrastructure Rails

Rail	Description	Endpoints
Webhooks	Event notifications	6
Search	Full-text search	4
Analytics	Real-time analytics	8
Reporting	Regulatory reports	6

Rate Limits

API requests are rate limited based on your plan:

Plan	Requests/minute	Requests/day
Sandbox	100	10,000
Starter	500	50,000
Growth	2,000	200,000
Enterprise	Custom	Custom

Rate limit headers are included in every response:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 498
X-RateLimit-Reset: 1705312800

Errors

All errors follow a consistent format:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": [
      {
        "field": "amount",
        "message": "Amount must be positive"
      }
    ]
  },
  "meta": {
    "requestId": "req_abc123"
  }
}

See Errors for the complete error code reference.

Versioning

The API is versioned via the URL path. The current version is v1:

https://api.islamicopenfinance.com/v1/contracts

SDKs

Official SDKs are available for:

• TypeScript/JavaScript
• Python
• Go
• Java