Compliance Rail
Regulatory and Shariah compliance checking endpoints.
Overview
The Compliance rail provides:
- Shariah compliance validation
- Regulatory framework checks
- Jurisdiction-specific rules
- Compliance reporting
Endpoints
Check Compliance
http
POST /v1/compliance/checktypescript
const check = await iof.compliance.check({
resourceType: "contract",
resourceId: "contract_123",
frameworks: ["shariah", "bnm"],
});Response:
json
{
"id": "check_abc",
"resourceId": "contract_123",
"compliant": true,
"checks": [
{
"framework": "shariah",
"rules": [
{ "rule": "no_riba", "passed": true },
{ "rule": "asset_backed", "passed": true }
]
},
{
"framework": "bnm",
"rules": [{ "rule": "disclosure", "passed": true }]
}
]
}Get Check
http
GET /v1/compliance/checks/:idtypescript
const check = await iof.compliance.getCheck("check_abc");List Frameworks
http
GET /v1/compliance/frameworkstypescript
const frameworks = await iof.compliance.listFrameworks({
jurisdiction: "MY",
});Create Alert
http
POST /v1/compliance/alertstypescript
const alert = await iof.compliance.createAlert({
type: "threshold",
conditions: {
metric: "daily_volume",
operator: "gt",
value: 1000000,
},
actions: [{ type: "webhook", url: "https://..." }],
});Generate Report
http
POST /v1/compliance/reportstypescript
const report = await iof.compliance.generateReport({
type: "AAOIFI_FAS",
period: {
start: "2024-01-01",
end: "2024-12-31",
},
format: "pdf",
});Compliance Frameworks
| Framework | Description | Jurisdiction |
|---|---|---|
shariah | Islamic finance principles | Global |
bnm | Bank Negara Malaysia | Malaysia |
cbuae | Central Bank of UAE | UAE |
sama | Saudi Arabian Monetary Authority | Saudi Arabia |
aaoifi | Accounting standards | Global |
Rule Categories
| Category | Description |
|---|---|
shariah | Islamic law compliance |
regulatory | Regulatory requirements |
disclosure | Transparency requirements |
reporting | Reporting obligations |
operational | Operational standards |
Webhooks
| Event | Description |
|---|---|
compliance.check.completed | Check completed |
compliance.alert.triggered | Alert triggered |
compliance.report.ready | Report generated |
Next Steps
- AML Rail - Anti-money laundering
- Contracts Rail - Contract compliance