Skip to content

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/check
typescript
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/:id
typescript
const check = await iof.compliance.getCheck("check_abc");

List Frameworks

http
GET /v1/compliance/frameworks
typescript
const frameworks = await iof.compliance.listFrameworks({
  jurisdiction: "MY",
});

Create Alert

http
POST /v1/compliance/alerts
typescript
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/reports
typescript
const report = await iof.compliance.generateReport({
  type: "AAOIFI_FAS",
  period: {
    start: "2024-01-01",
    end: "2024-12-31",
  },
  format: "pdf",
});

Compliance Frameworks

FrameworkDescriptionJurisdiction
shariahIslamic finance principlesGlobal
bnmBank Negara MalaysiaMalaysia
cbuaeCentral Bank of UAEUAE
samaSaudi Arabian Monetary AuthoritySaudi Arabia
aaoifiAccounting standardsGlobal

Rule Categories

CategoryDescription
shariahIslamic law compliance
regulatoryRegulatory requirements
disclosureTransparency requirements
reportingReporting obligations
operationalOperational standards

Webhooks

EventDescription
compliance.check.completedCheck completed
compliance.alert.triggeredAlert triggered
compliance.report.readyReport generated

Next Steps

Licensed under the Apache License 2.0