API Specifications v2.1
The official UAE Open Finance OpenAPI specifications are maintained in a single repository. All specifications are in OpenAPI YAML format. The main branch always reflects the current live specifications.
Repository Structure
Specifications are organised under dist/ by the audience that consumes them:
| Path | Description |
|---|---|
dist/api-hub/ | APIs the API Hub exposes to LFIs |
dist/standards/ | APIs the API Hub exposes to TPPs |
dist/ozone-connect/ | APIs LFIs must implement for the API Hub to call |
Each category is versioned independently. The most up-to-date version across all categories is v2.1.
API Categories
API Hub (dist/api-hub/)
These specifications describe the APIs that the API Hub exposes to LFIs. LFIs integrate against these APIs to participate in the Open Finance ecosystem — for example to authenticate, manage consents, and receive event callbacks.
Standards (dist/standards/)
These specifications describe the APIs that the API Hub exposes to TPPs. TPPs use these APIs to access financial data and initiate services on behalf of their customers.
Ozone Connect (dist/ozone-connect/)
These specifications describe the APIs that LFIs must implement for the API Hub to call. When a TPP makes a valid request to the API Hub, the API Hub proxies that request to the relevant LFI using these Ozone Connect APIs.
API Flow Overview
The API Hub acts as a gateway between TPPs and LFIs. There is a natural mapping between the Standards APIs (TPP → API Hub) and the Ozone Connect APIs (API Hub → LFI):
+======================================================================+
| AlTareq Trust Framework (Directory) |
|----------------------------------------------------------------------|
| |
| +-------------------------+ |
| | TPP | |
| +------------+------------+ |
| | |
| +-----------------+-----------------+ |
| | | | |
| +---v---+ +---v---+ +---v---+ |
| |API Hub| |API Hub| ... |API Hub| |
| +-------+ +-------+ +-------+ |
| | | | |
| +---v---+ +---v---+ +---v---+ |
| | LFI 1 | | LFI 2 | ... | LFI N | |
| +-------+ +-------+ +-------+ |
| |
+======================================================================+Versioning
Specifications follow a vMAJOR.MINOR scheme. Errata releases (e.g. v2.0-errata1) contain targeted corrections to a published version without incrementing the version number.
Watch for updates
Implementers are encouraged to watch the repository on GitHub to stay informed of new versions and changes as the specification evolves.