Skip to main content

Why versioning matters

A compliance decision has to be checkable later. An auditor or a Shariah board reviewing a holding months afterwards needs to know which rules produced its determination, so every compliance response includes the exact methodology, both in the resource and in meta.methodology:
That reads as: AAOIFI Shari’ah Standard No. 21, halal.sh implementation version 2026.1.

Version format

  • methodology_id: the screening methodology, aaoifi-ss21 for an operating company; aaoifi-ss57, aaoifi-ss20 or halal-sh-etf-taxonomy for a pooled vehicle decided on its structure (see Pooled vehicles)
  • year: calendar year of the implementation
  • revision: incremental revision within the year
The id and version are also returned as separate fields by the methodologies endpoints and inside every Evidence Packet.

When the version changes

An extraction improvement leaves the version unchanged: the screening rules are the same, and only the data going into them is better. Better data can still change a determination; an unchanged version means the rules did not.

Inspecting the methodology

Fetch the methodology, its thresholds and its screen definitions:
Every response uses the latest version of the methodology it names, and a response names exactly one. An operating company is always aaoifi-ss21; the structural ids appear only on the pooled vehicles the compliance endpoint serves as stocks. Pinned versions, if we add them, will be additive: your existing requests will not change.

Reproducibility

Three things identify the inputs to a determination:
  1. Methodology version: meta.methodology (e.g. aaoifi-ss21@2026.1)
  2. Filing set: filing.hash on /compliance
  3. Market data: the market cap in each ratio’s denominator in the Evidence Packet, from the analysis dated as_of
The Evidence Packet has each ratio’s numerator and denominator, the threshold, and the filing each value came from, so you can recompute every ratio and its pass or fail. The explanation and the business-activity screen are judgments made in each analysis, so a new analysis of the same filings can word the explanation differently and can judge a close business-activity case differently. For a structural methodology, the filing set is the issuer document set behind filing.hash, and the record to check is the checklist in screens.structural: the criteria, the verdicts and the quoted evidence.