Version 5

Date TBC

1. What’s new?

• Added API Hub Domains & DNS

• Added Consent Manager API Guide

• Added Authorisation Server API Guide

• Added Ozone Connect Implementation Guide

2. What’s changed?

• Removed Infrastructure Integration Questionnaire as the information is included on the pages for pre-prod and prod environment specific configuration pages.

3. What’s to come?

Version 4

Date: TBC

1. What's new?

2. What’s changed?

• Updated the network diagram to better illustrate the Ozone Connect APIs to implement by the LFIs.

• Updated the

• Updated steps and additional information to be provided in the following Pre-Production Environment Specific Configuration and Production Environment Specific Configuration

• Added Volume and Billing Report screenshot to Admin Portal User Guide

• Changed Authorization Server OpenAPI (changes described on page)

• Changed Bank Data Sharing OpenAPI (changes described on page)

• Changed Bank Service Initiation OpenAPI (changes described on page)

• Changed Consent Event & Actions OpenAPI (changes described on page)

• Changed Consent Manager API Guide (changes described on page)

• Changed Insurance Data Sharing OpenAPI (changes described on page)

• Changed Testing Tool User Guide with the following:

  • Made some updates to 6.1 options table.

  • Added a new section for the recently introduced input test configuration files.

  • Integrated the input test configuration files by updating the command parameters.

  • Included a video walkthrough demonstrating the usage of the testing tool.

  • Corrected several configuration options for improved accuracy.

• Updated the following OpenAPI descriptions following changes for errata 2 of the standards. Changes are listed in the description property of each OpenAPI description document:

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Authorization%20Server%20OpenAPI

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Data%20Sharing%20OpenAPI

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20OpenAPI

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Consent%20Event%20%26%20Actions%20OpenAPI

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Consent%20Manager%20OpenAPI

  • https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Insurance%20Data%20Sharing%20OpenAPI

3. What's to come?

Version 3

Date: 05 Aug 2024

1. What's new?

• Moved the Sequence Diagrams to its own section with subpages
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Sequence%20Diagrams

• Added a Sequence Diagram UAE Service Initiation - Multi-Authorization Journey example including error flows.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20-%20Multi-Authorization%20Journey

• Added a Sequence Diagram UAE Service Initiation - Payment Refund Journey example.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20-%20Payment%20Refund

• Updated the Key API Hub Components section with details about the Health Check APIs and Consent Event & Action APIs.
  https://openfinanceuae.atlassian.net/wiki/spaces/AHDV/pages/edit-v2/180781122#3.5-Key-API-Hub-Components

• Added questionnaires and configuration guides section. https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Questionnaires%20and%20Configuration%20Guides

• Added an API Hub Reporting section. https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=API%20Hub%20Reporting

• Added a page for the Testing Tool. https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Testing%20Tool%20User%20Guide

• Added Insurance Data Sharing specification. https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Insurance%20Data%20Sharing%20OpenAPI

2. What’s changed?

• Updated the network diagram on the Infrastructure Diagram and https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Integration%20Overview pages.

  • Added C1 and S1 icons.

  • Updated the Certificate description block.

  • Removed one service that is not in scope for the OFP.

• Added a legend to the network diagrams to clarify the abbreviations.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Keys%2C%20Certificates%20%26%20CSRs

• Updated Sequence Diagram UAE Data Sharing - Account Access adding error flows.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Data%20Sharing

• Updated Sequence Diagram UAE Service Initiation - Single Immediate Payment adding error flows.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20-%20Single%20Immediate%20Payment

• Updated Sequence Diagram UAE Data Sharing - Insurance adding error flows.
  https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Insurance%20Data%20Sharing.

• Updated https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Admin%20Portal%20User%20Guide to include section 6.4. LFI reports.

• Replaced API Hub Reporting Datasets with https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=API%20Hub%20Reports%20%26%20Datasets and moved from specifications section into https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=API%20Hub%20Reporting section.

• Updated enumeration and object definitions so that they are aligned with CBUAE RC2 specifications within the following: https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Consent%20Manager%20OpenAPI https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Data%20Sharing%20OpenAPI https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20OpenAPI.

• Updated some headers to be mandatory within the following: https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Consent%20Event%20%26%20Actions%20OpenAPI https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Data%20Sharing%20OpenAPI https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20OpenAPI

• Added query parameters for pagination in alignment with CBUAE RC2 specifications within the following:https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Data%20Sharing%20OpenAPI.

• Added new endpoint Get /payment-consents/{consentId}/refund in alignment with CBUAE RC2 specifications within the following: https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Bank%20Service%20Initiation%20OpenAPI.

• Restructured documentation to make it clear who the consumer audience is and aligned title consistency.

3. What's to come?

Changes subject to final quality review

Version 2

09 Jul 2024

1. What's new?

• Added https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Application%20Layer%20Authentication page.

• Added https://openfinanceuae.atlassian.net/wiki/spaces/AHDV/pages/edit-v2/180782389 to track changes to the releases.

• Reorganised the structure of the documentation into groups based on implementation themes

• Added a section on https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Infrastructure%20Integration%20Questionnaire consisting of pages for Infrastructure Diagram, https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Keys%2C%20Certificates%20%26%20CSRs, https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Infrastructure%20Integration%20Questionnaire and https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Application%20Layer%20Authentication

• Added specifications for https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Health%20Checks%20OpenAPI and https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Consent%20Event%20%26%20Actions%20OpenAPI

2. What’s changed?

https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Authorization%20Server%20OpenAPI

• Updated terminology to align with terms used in CBUAE context.

https://openfinanceuae.atlassian.net/wiki/pages/createpage.action?spaceKey=AHDV&title=Admin%20Portal%20User%20Guide

• OTP login steps updated with screenshots.

API Hub LFI Implementation Plan

• Removed ‘Engagement Session Details’ table and replaced with a link to the published agenda area.

• Added 2.1 Onboarding Process.

  • Addition of Regular Expression facility for executing selected tests.

  • Addition of an html output report.

  • Implemented more than 250 test cases Ozone Connect Test Cases

  • Only 1 configuration file for all the tests.

  • Customizable Fields for Ozone Connect Testing Tool

  • Reorganisation of test cases: Improved structure for better clarity and management.

  • Selective test execution: Added the ability to run specific test cases or suites with precision.

  • Payments section: Introduced a payments section in the config.yamlfile.

  • Consolidated configuration: Streamlined input configurations by removing multiple files. All inputs are now managed through a single file,config/config.yaml.

  • Addition of Payments test cases: New test cases added for the payments related APIs.

  • Video recordings: New features are now documented with video demonstrations.

• Included a question around enabling IP whitelisting on the admin portal to Production Environment Specific Configuration and Pre-Production Environment Specific Configuration

• Updated network diagram Integration Overview

• Changed Bank Data Sharing sequence diagram to include information on login_hint signing and encryption.

• Changed Bank Service Initiation - Single Immediate Payment sequence diagram to include information on PII and login_hint signing and encryption and payment initiation request verification.

• Changed Insurance Data Sharing sequence diagram to include information on login_hint signing and encryption.

3. What’s to come?

Version 4

6 Sept 2024

Release Notes

Version 3

05 Aug 2024

Release Notes

Version 2

09 Jul 2024

Release Notes

Version 1

28 Jun 2024

https://openfinanceuae.atlassian.net/wiki/spaces/AHDV/pages/180781122/Integration+Overview#3.4-Sequence-Diagrams

• Updated sequence diagrams.

3. What's to come?

This is the second of the draft releases. A further release is scheduled for 15 Jul 2024 consisting of updates to sequence diagrams.

The specifications will be updated to remove references to standards other than CBUAE, making the documents easier to consume.

The release starts introducing LFIs to the questionnaires that will be discussed in the 1:1 sessions. These will be transposed to JSD forms, but are presented here for discussion.

Version 1

28 Jun 2024

First draftAPIHubDocsv1