Skip to content

Compliance Rail

Regulatory and Shariah compliance checking endpoints.

The Compliance rail provides:

  • Shariah compliance validation
  • Regulatory framework checks
  • Jurisdiction-specific rules
  • Compliance reporting
POST /v1/compliance/check
const check = await iof.compliance.check({
resourceType: "contract",
resourceId: "contract_123",
frameworks: ["shariah", "bnm"],
});

Response:

{
"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 /v1/compliance/checks/:id
const check = await iof.compliance.getCheck("check_abc");
GET /v1/compliance/frameworks
const frameworks = await iof.compliance.listFrameworks({
jurisdiction: "MY",
});
POST /v1/compliance/alerts
const alert = await iof.compliance.createAlert({
type: "threshold",
conditions: {
metric: "daily_volume",
operator: "gt",
value: 1000000,
},
actions: [{ type: "webhook", url: "https://..." }],
});
POST /v1/compliance/reports
const report = await iof.compliance.generateReport({
type: "AAOIFI_FAS",
period: {
start: "2024-01-01",
end: "2024-12-31",
},
format: "pdf",
});
FrameworkDescriptionJurisdiction
shariahIslamic finance principlesGlobal
bnmBank Negara MalaysiaMalaysia
cbuaeCentral Bank of UAEUAE
samaSaudi Arabian Monetary AuthoritySaudi Arabia
aaoifiAccounting standardsGlobal
CategoryDescription
shariahIslamic law compliance
regulatoryRegulatory requirements
disclosureTransparency requirements
reportingReporting obligations
operationalOperational standards
EventDescription
compliance.check.completedCheck completed
compliance.alert.triggeredAlert triggered
compliance.report.readyReport generated