Developer Portal — v1.2 — Mock-Net Active

Build on Falah OS™

The complete developer environment for the Sovereign Digital Economy. Live API sandbox, SDK downloads, and pre-audited Shariah contract primitives — everything you need to ship your first compliant app.

Open API Sandbox Read the Docs →

📦

Install SDK

TypeScript, Python, Go, Swift. Pick your language and go.

🧪

Mock-Net Sandbox

Test every API call safely. No real value, full fidelity.

📜

RAMZ Contracts

Qard, Mudarabah, Zakat — Shariah contracts as code.

Quick Start 5 Minutes

Think of the Falah OS API like a set of LEGO bricks — each brick (Identity, Wallet, Contracts) snaps cleanly onto the others. You don't need to understand the internals to build with them.

# 1. Install the SDK
npm install falah-sdk-ts

# 2. Import and initialise
import { FalahClient } from 'falah-sdk-ts'

const falah = new FalahClient({
  apiKey: 'your-api-key',
  network: 'mock-net'   // use 'mainnet' for production
})

# 3. Create an Ummah ID
const identity = await falah.identity.register({
  jurisdiction: 'MY'
})

console.log(identity.ummah_id)  // UID-A1B2C3D4-XYZ

# 4. Spin up a wallet
const wallet = await falah.wallet.create({
  ummah_id: identity.ummah_id,
  currency: 'FLH'
})

console.log(wallet.wallet_id)   // FLH-XXXX-XXXX-XXXX

# 5. Execute a Shariah contract
const contract = await falah.contracts.execute({
  contract_type: 'qard_al_hasan',
  amount: 500,
  parties: { party_a: wallet.wallet_id, party_b: 'FLH-RECIPIENT' }
})

console.log(contract.shariah_verified)  // true ✓

SDK Downloads 4 Languages

Each SDK ships with Mock-Net test harnesses, type definitions, and RAMZ contract bindings built in.

TypeScript

falah-sdk-ts

npm i falah-sdk-ts

Python

falah-sdk-py

pip install falah-sdk

falah-sdk-go

go get falah.io/sdk

Swift

falah-sdk-swift

swift package add falah

API Reference Live Endpoints

All endpoints below are live on Mock-Net. Click any endpoint to expand its documentation.

GET /api/health System & service status

Returns the operational status of all Falah OS core services. Use this as your canary before making other API calls.

curl https://dev.falah-os.com/api/health

POST /api/identity/register Create a new Ummah ID (ZK Identity)

Generates a zero-knowledge identity proof. Like getting a passport — your identity is verified without revealing your personal details to anyone, including us.

Parameter	Type	Required	Description
jurisdiction	string	No	ISO country code. Default: MY
level	string	No	standard \| enhanced \| institutional

curl -X POST https://dev.falah-os.com/api/identity/register \
  -H "Content-Type: application/json" \
  -d '{"jurisdiction": "MY", "level": "standard"}'

GET /api/identity/verify Verify an existing Ummah ID

Parameter	Type	Required	Description
ummah_id	string	Yes	The Ummah ID to verify

curl "https://dev.falah-os.com/api/identity/verify?ummah_id=UID-ABC123"

POST /api/wallet/create Create a sovereign wallet

Creates a new sovereign wallet linked to an Ummah ID. Think of this as opening a bank account — except you own it completely.

Parameter	Type	Required	Description
ummah_id	string	No	Link to existing Ummah ID
currency	string	No	FLH \| MYR \| USD. Default: FLH

curl -X POST https://dev.falah-os.com/api/wallet/create \
  -H "Content-Type: application/json" \
  -d '{"ummah_id": "UID-ABC123", "currency": "FLH"}'

GET /api/wallet/balance Get wallet balance

Parameter	Type	Required	Description
wallet_id	string	Yes	Wallet ID from /wallet/create

curl "https://dev.falah-os.com/api/wallet/balance?wallet_id=FLH-XXXX-XXXX"

GET /api/contracts/templates List all Shariah contract templates

Returns all pre-audited RAMZ contract primitives. These are your Shariah-compliant building blocks — like choosing from a menu of legal deeds that are already approved by scholars.

curl https://dev.falah-os.com/api/contracts/templates

POST /api/contracts/execute Execute a Shariah contract

Parameter	Type	Required	Description
contract_type	string	Yes	qard_al_hasan \| mudarabah \| zakat
amount	number	Yes	Contract value
currency	string	No	FLH \| MYR. Default: FLH
parties	object	No	{party_a, party_b} wallet IDs

curl -X POST https://dev.falah-os.com/api/contracts/execute \
  -H "Content-Type: application/json" \
  -d '{"contract_type": "qard_al_hasan", "amount": 500, "currency": "FLH"}'

Live API Sandbox Mock-Net

Your flight simulator. Call every endpoint live against the Mock-Net. Zero risk, full fidelity.

⚡ API Sandbox — Mock-Net Connected to Mock-Net

Select Endpoint Request Body / Params

Response

// Response will appear here. // Select an endpoint and click Run Request.