Mezan:Investing API integration & Shariah data services

Halal compliance verdict API

Submit a ticker (e.g. AAPL, 2222.SR) and get back the verdict (Compliant / Questionable / Not Compliant), the screening methodology used, and a timestamp. Used by trading platforms to gate or label trades before order submission.

Financial ratio breakdown API

Returns the exact ratios that decided the verdict: interest-bearing debt ratio, cash & interest-bearing securities ratio, non-permissible revenue percentage, plus the threshold each was tested against. Use case: explainer panels in Islamic robo-advisory dashboards and audit logs for Shariah supervisory boards.

Watchlist sync

Read and write the user's personal watchlist of tickers. Use case: when a user adds a ticker in your broker app, mirror it into Mezan; when Mezan re-screens that ticker and the verdict flips, push a webhook back so your front-end can flag the position.

Learning module progress

Expose how far a user is through the structured learning modules (foundations of halal investing, Islamic finance principles, reading stock charts, market analysis). Use case: gamified onboarding inside neo-banks, where completed modules unlock new product tiers.

Mezan Pro entitlement check

A lightweight endpoint that confirms whether the linked Mezan account holds an active Pro subscription. Use case: B2B partners that want to grant premium content cross-app without rebuilding the billing layer.

Bulk screening & webhook stream

Submit a list of up to several thousand tickers in one call, receive a paginated verdict report, and subscribe to webhooks when verdicts change between screening cycles. Use case: monthly Shariah portfolio reviews and ETF re-balancing.

1. Halal pre-trade gate inside an Islamic broker

Business context: an Islamic-friendly broker wants every market order to be screened before it goes to the exchange, so non-compliant trades surface a warning or a hard block. Data involved: compliance verdict + interest-bearing debt ratio. OpenFinance mapping: a consent-scoped read of the verdict at order-construction time, mirroring how PSD2 SCA-style checks fire on payment initiation. The verdict is cached for the trading session and refreshed on a daily webhook.

2. Robo-advisory portfolio re-balancing

Business context: a Shariah robo-advisor needs to re-screen its model portfolios monthly. Data involved: bulk verdict export + ratio breakdown for every ticker in the universe. OpenFinance mapping: scheduled batch pull through an authorized B2B contract, equivalent to an account-information service drawing transaction history on a recurring schedule. We deliver a paged export endpoint plus a webhook stream for verdict deltas.

3. Accounting & zakat calculation pipeline

Business context: a zakat or wealth-management tool wants to attach a "halal-eligible" flag to every holding it imports from a user's brokerage. Data involved: per-ticker verdict + non-permissible revenue percentage. OpenFinance mapping: similar to a categorization layer over open-banking transactions, but applied to securities holdings; the verdict tags the holding so the zakat engine can compute the right base.

4. Watchlist mirror across two apps

Business context: a user keeps a watchlist in their broker app and a separate halal watchlist in Mezan; both should stay in sync. Data involved: watchlist read/write API + verdict change webhook. OpenFinance mapping: bidirectional account-information + payment-initiation pattern, where the broker is the system of record for "what I own" and Mezan is the system of record for "what I'm allowed to own."

5. Compliance audit feed for a Shariah supervisory board

Business context: a Shariah Supervisory Board (the AAOIFI-style three-scholar committee that every Islamic financial institution maintains) needs an evidence trail for every screened ticker. Data involved: verdict + ratios + timestamp + screening methodology (DJ / FTSE / S&P / MSCI / AAOIFI). OpenFinance mapping: read-only audit endpoint with consent-scoped tokens, log-shipped into the board's review tool; we provide WORM-style retention guidance.

Deliverables checklist

• OpenAPI / Swagger specification for every endpoint
• Protocol & auth flow report (OAuth-style token chain, refresh, session)
• Runnable source code in Python or Node.js (compliance lookup, ratio fetch, watchlist sync, webhook receiver)
• Postman collection plus pytest / Jest test harness
• Integration runbook: rate limits, retry strategy, schema versioning
• Compliance guidance: AAOIFI screening methodology references, consent & data-minimization notes

API example: compliance verdict (pseudocode)

POST /api/v1/mezan/compliance/check
Content-Type: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "ticker": "AAPL",
  "methodology": "AAOIFI"
}

200 OK
{
  "ticker": "AAPL",
  "verdict": "Compliant",
  "ratios": {
    "interest_bearing_debt_ratio": 0.21,
    "cash_ratio": 0.14,
    "non_permissible_revenue_pct": 0.02
  },
  "thresholds": { "debt": 0.33, "cash": 0.33, "revenue": 0.05 },
  "as_of": "2026-04-29T08:00:00Z"
}

API example: watchlist sync (pseudocode)

// Read user's watchlist
GET /api/v1/mezan/users/{uid}/watchlist
Authorization: Bearer <ACCESS_TOKEN>

// Add ticker
POST /api/v1/mezan/users/{uid}/watchlist
{ "ticker": "2222.SR" }

// Webhook on verdict change
POST https://your.app/webhooks/mezan
{
  "event": "verdict.changed",
  "ticker": "TSLA",
  "from": "Compliant",
  "to": "Questionable",
  "as_of": "2026-04-29T08:00:00Z"
}

API example: bulk screening + auth (pseudocode)

POST /oauth/token
grant_type=client_credentials
client_id=...&client_secret=...

POST /api/v1/mezan/compliance/bulk
Authorization: Bearer <ACCESS_TOKEN>
{
  "tickers": ["AAPL","MSFT","TSLA","2222.SR","005930.KS"],
  "methodology": "AAOIFI",
  "page": 1, "page_size": 100
}

// Errors
401 invalid_token   // refresh and retry
429 rate_limited    // exponential backoff, retry-after header
422 bad_ticker      // unknown symbol

About us

We are an independent technical studio focused on app interface integration, OpenData / OpenFinance / OpenBanking, and authorized API delivery. The team has shipped integrations for retail brokers, payment gateways, and Islamic-finance products across the GCC, Southeast Asia, and Europe. We understand AAOIFI and IFSB expectations, GDPR-grade privacy handling, and how to keep a halal-data feed auditable without leaking user identity.

• Halal investing, robo-advisory, zakat tooling, Islamic-banking add-ons
• Protocol analysis & reverse engineering for authorized data extraction
• Custom Python / Node.js / Go SDKs, OpenAPI specs, and webhook receivers
• End-to-end flow: scope → protocol analysis → build → validation → compliance review
• Source code delivery from $300 — runnable API source code and full documentation; pay after delivery upon satisfaction
• Pay-per-call API billing — access our hosted endpoints and pay only per call, no upfront cost

Contact

Send us the target app and your concrete requirements (compliance lookup, watchlist sync, bulk screening, learning-progress export, etc.) and we will respond with a scope estimate, timeline, and price.

Contact page

Engagement workflow

1. Scope confirmation: which Mezan endpoints you need (compliance, ratios, watchlist, learning, Pro entitlement) and your auth model.
2. Protocol analysis & API design — typically 2–5 business days.
3. Build & internal validation against a real device or sandbox account — 3–8 business days.
4. Documentation, sample integrations, and test suite — 1–2 business days.
5. First delivery usually lands in 5–15 business days; methodology vetting by a Shariah supervisory board on the client side may extend the timeline.

FAQ

What do you need from me to start?

How long does the first integration take?

How do you handle Shariah compliance specifically?

Do you provide investment advice?