Source of truth · OpenAPI 3.x

API Specifications

The official UAE Open Finance OpenAPI specifications are maintained in a single repository. The OpenAPI YAML files are the source of truth for every API in the ecosystem — where a guide or this site disagrees with a spec, the spec wins.

GitHub repository

Nebras-Open-Finance / api-specs

The canonical OpenAPI repository. All specs on this site are fetched from its dist/ directory at build time — no YAML is committed here.

dist/standards/APIs the API Hub exposes to TPPs.
dist/api-hub/APIs the API Hub exposes to LFIs.
dist/ozone-connect/APIs LFIs must implement for the API Hub to call.
main Live source of truth — published, authoritative, externally consumable. New implementers should work from the latest version on main.
other branches Drafts of future content (for example a forthcoming v2.2). The Nebras Open Finance team will announce when draft content is ready for ecosystem review.
Open on GitHub
Reference

How the repository works

Viewing the specifications

The pages under each section render every spec inline. To view a spec directly from the repository, Redocly gives a clean, navigable rendering of any YAML file — paste its raw GitHub URL into the Redocly viewer.

Versioning & errata

Specifications follow a vMAJOR.MINOR scheme. The same logical release spans all three categories — dist/api-hub/v2.1.x/, dist/ozone-connect/v2.1.x/, and dist/standards/v2.1/. Errata releases (for example dist/standards/v2.1-errata1/) contain targeted corrections; where an errata folder exists, the files inside it supersede the corresponding base version.

Governance folders

The repository's supporting/ directory holds material alongside the specs: breaking-changes/ records breaking changes knowingly accepted within an errata (enforced by an oasdiff test), and future-updates/ is a forward-looking design backlog for the next major version.

Watch for updates Implementers are encouraged to watch the repository on GitHub to stay informed of new versions and changes as the specification evolves.