Reporting Rail

Regulatory and operational reporting endpoints.

Overview

The Reporting rail provides:

• Regulatory reports
• Compliance reports
• Operational dashboards
• Custom report generation

Endpoints

Generate Report

POST /v1/reports

const report = await iof.reports.generate({
  type: "AAOIFI_FAS_28",
  period: {
    start: "2024-01-01",
    end: "2024-12-31",
  },
  format: "pdf",
  parameters: {
    jurisdiction: "MY",
  },
});

Response:

{
  "id": "rpt_abc",
  "type": "AAOIFI_FAS_28",
  "status": "generating",
  "createdAt": "2024-01-15T10:30:00Z"
}

Get Report

GET /v1/reports/:id

const report = await iof.reports.get("rpt_abc");

Download Report

GET /v1/reports/:id/download

const file = await iof.reports.download("rpt_abc");

List Reports

GET /v1/reports

const reports = await iof.reports.list({
  type: "AAOIFI_FAS_28",
  status: "completed",
  limit: 20,
});

Schedule Report

POST /v1/reports/schedules

const schedule = await iof.reports.createSchedule({
  type: "monthly_summary",
  frequency: "monthly",
  dayOfMonth: 1,
  recipients: ["finance@bank.com"],
});

Report Types

Regulatory Reports

Type	Description	Standard
AAOIFI_FAS_28	Murabaha disclosure	AAOIFI
AAOIFI_FAS_32	Ijarah disclosure	AAOIFI
BNM_FORM_1	BNM regulatory	Malaysia
CBUAE_PRUDENTIAL	Prudential report	UAE

Operational Reports

Type	Description
monthly_summary	Monthly overview
transaction_log	Transaction details
audit_trail	Audit log
risk_exposure	Risk analysis

Report Status

Status	Description
pending	Queued for generation
generating	In progress
completed	Ready for download
failed	Generation failed

Output Formats

Format	Description
pdf	PDF document
xlsx	Excel spreadsheet
csv	CSV data
json	JSON data

Webhooks

Event	Description
report.completed	Report ready
report.failed	Generation failed

Next Steps

• Analytics Rail - Real-time insights
• Compliance Rail - Compliance checks