Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Author

Chris Michael David Plews

Version

1.0

Classification

PublicDRAFT

1. Introduction

This document describes the different components involved in delivering the integration between the API Hub and a LFI. The goal is to give a clear picture of which components exist, how they are used and what is expected to be delivered by each party.

...

In order to deliver the end to end journey for the User, the following APIs will be deployed.

  • The Authorisation Server and Consent Manager is built, deployed and maintained by Ozone.

  • The LFI is expected to build, deploy and maintain screens on their mobile and/or web app to support the Consent Authorisation flow.

  • The LFI is expected to build, deploy and maintain the Ozone Connect API for Data Sharing and Service Initiation.

Component

Provider

Consumer

Interface

Description

Connection

Usage

Authorisation Server

API Hub

LFI

API

  • Swagger specification will be made available

  • Exposes endpoints to the LFI to support:

    • Consent Authorisation Flow

    • Access token issuing

MTLS

Authorisation Flow

Consent Manager

API Hub

LFI

API

  • Swagger specification will be made available

  • TPPs do not connect to the consent manager directly

  • Exposes endpoints to the LFI to support:

    • Consent Authorisation Flow

    • Consent management and reporting

MTLS

Authorisation Flow

Consent Dashboard

Ozone Connect

LFI

API Hub

API

  • Swagger specification will be made available for Account InformationData Sharing, Service Initiation and Insurance

  • TPPs do not connect to the Ozone Connect API directly

  • The Ozone Connect API is an interface on top of the LFI core banking system. LFIs will be responsible for the mapping between their core banking system and the Ozone Connect API specification

  • LFIs only implement the Ozone Connect API endpoints to support their existing offering i.e
    Data Sharing: Accounts, Balance, Transactions etc

    Service Initiation: Domestic payment, Standing Orders, International Payments etc
    Insurance: Motor insurance quotes

MTLS

Account Information

Service Initiation

Insurance

...

The API Hub Software Development Kit (SDK) will include:

  1. Detailed Sequence Diagrams API Hub Integration Overview for LFIs

  2. https://openfinanceuae.atlassian.net/wiki/spaces/MarketEngagement/pages/edit-v2/101482510#3.4-Sequence-Diagrams

  3. API Hub LFI Implementation Plan

  4. API Hub Consent Manager API Specification

  5. API Hub Authorisation Server API Specification

  6. API Hub Ozone Connect API Specification - Data Sharing

  7. API SpecificationHub Ozone Connect API Specification - Service Initiation API SpecificationConnectivity Requirements & Guides

  8. API Hub Admin Portal - LFI User Guide

  9. API Hub Reporting Datasets

  10. Postman collection to simulate TPP journey and LFI / Ozone integration

  11. Supporting documentation - FAQs, video tutorials, data mappingAPI Hub Admin Portal User Guide

Additionally the Open Finance Standards will define the required UX for Consent Authorisation including

...