...
Upon being granted access to the Trust Framework (as an Organization Organisation Administrator or Organization Organisation User), you will receive an email with a link to the platform. Follow these steps to create your account using the same email address provided for access:
...
4.3 Onboarding Additional Users
Organization Organisation Administrators can onboard new Organisation Administrators as well as technical https://docs.connect.raidiam.io/users .
The Initial List of Users Supported on the Trust Framework can be seen on in the table below :
User Type | Access Scope |
|---|---|
Organisation Admin | Can Manage all the resources on the Organisation, Technical and Non-Technical |
Primary Business Contact (PBC) | Can Manage Contacts in the Organisation |
Cannot Manage Technical Resources | |
Primary Technical Contact (PTC) | Can Manage all Technical Resources of an Organisation - Data Providers, Applications and Certificates |
Secondary Technical Contact (STC) | Can Manage Data Providers, adding and removing API Endpoints and Certifications. Cannot Manage Applications and Certificates |
User management, including adding or removing users in the Trust Framework, can be done using the platform UI. Detailed instructions can be found at https://docs.connect.raidiam.io/add-users
...
LFIs are responsible for maintaining an up-to-date registry of their https://docs.connect.raidiam.io/authorisation-servers and https://docs.connect.raidiam.io/api-resources that they support the Open Finance Schema. Only valid and accessible resources should be included in the Trust Framework to ensure an interoperable data access journey for TPPs.
4.4.1 Registering a Data Provider
The Data Provider Resource allows organizations Organisations to register details of their OAuth 2.0 Authorization Servers (Open ID Providers), which manage client access to participant-protected APIs.
The interaction rules between clients and Authorization Server endpoints are outlined in the CBUAE FAPI 2.0 Standards.
4.4.
...
Once registered in the Trust Framework, the Authorization Server and API data can be accessed via the Trust Framework APIs, notably the Participants Public API.
Instructions on how to register an Authorization Server can be found at https://docs.connect.raidiam.io/add-data-provider
4.4.2 Registering API Resources
Participants can register https://docs.connect.raidiam.io/xwL5-api-resources for the products and services they offer on the schema. Only approved API endpoints and versions for go-live should be added to the Trust Framework.
Details about the API resources can be obtained through the same Participants Public API used for server information.
Instructions on how to add and maintain API resources are available at https://docs.connect.raidiam.io/manage-apis-for-discovery-and-integration
4.5 Creating Server Certificates
There are three types of server certificates, each serving different purposes. Detailed information about server certificates can be found in the Certificate Standard .
Instructions on creating server certificates are available at https://docs.connect.raidiam.io/manage-certificates-for-organisation
Servers must use valid TLS certificates to protect registered resources in the Trust Framework, with a policy to update these certificates at least once every 12 months.
5. TPPs Quick Access Guide
This guide assumes that the TPP has completed the onboarding process, including submitting all required documentation and passing all necessary KYBs and KYC requirements.
There is no logical difference between Organization Entries used by TPPs or LFIs. Therefore, the procedures for creating accounts, signing documents, and onboarding for TPPs are the same as for LFIs.
5.1 Creating an Account
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.1-Creating-an-Account section.
5.2 Signing the Terms & Conditions Document
The process for a TPP to sign the Terms & Conditions Document is similar to the process for LFIs, with the primary difference being the document type: "TPP - Terms & Conditions."
Access to the Production Environment will be granted once the document is signed and reviewed by the AlTareq team.
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.2-Signing-the-Terms-%26-Conditions-Document section for more details.
5.3 Onboarding Additional Users
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.3-Onboarding-Additional-Users section.
5.4 Registering Applications
...
1 Server Discovery Metadata
When creating a new server, Data Providers (Licensed Financial Institutions or LFIs) and TPPs will use the following fields to provide information about the server to existing users. These fields should be filled out with relevant information that accurately describes the services and the application to ensure optimal discovery by the end users.
Field Name | Field Description | Example |
|---|---|---|
Customer Friendly Name | The name of the financial institution branch/segment/service as it will appear to end users. | Global Finance - Private Banking |
Description | A detailed description of the financial institution, highlighting its key features, services, and benefits. This should give users a comprehensive understanding of what the financial institution offers and how it can support service providers. | Global Financial Services is a leading financial institution offering a wide range of services including savings and checking accounts, loans, mortgages, and investment services. The institution is dedicated to providing secure and efficient financial solutions for individuals and businesses. |
Portal URI | The URL pointing to the financial institution’s portal, directing users to a webpage where they can find more information about the services provided by the institution. | |
Logo URI | The URL pointing to the financial institution’s logo in PNG or JPEG format. This logo will be displayed alongside the financial institution name and description on the platform, providing a visual identifier for users. | https://www.centralbank.ae/media/ouxfisxh/banner-text-en-july28-1.png |
Once registered in the Trust Framework, the Authorization Server can be recovered via the Trust Framework APIs, notably the Participants Public API.
Instructions on how to register an Authorization Server can be found at https://docs.connect.raidiam.io/add-data-provider
4.4.2 Registering API Resources
Participants can register https://docs.connect.raidiam.io/xwL5-api-resources for the products and services they offer on the schema. Only approved API endpoints and versions for go-live should be added to the Trust Framework.
Instructions on how to add and maintain API resources are available at https://docs.connect.raidiam.io/manage-apis-for-discovery-and-integration
Details about the API resources can be obtained through the same Participants Public API accessible under - https://data.directory.openfinance.ae/participants
4.5 Creating Server Certificates
There are three types of server certificates, each serving different purposes. Detailed information about server certificates can be found in the Certificate Standard .
Instructions on creating server certificates are available at https://docs.connect.raidiam.io/manage-certificates-for-organisation
Servers must use valid TLS certificates to protect registered resources in the Trust Framework, with a policy to update these certificates at least once every 12 months.
...
5. TPPs Quick Access Guide
This guide assumes that the TPP has completed the onboarding process, including submitting all required documentation and passing all necessary KYBs and KYC requirements.
There is no logical difference between Organisation Entries used by TPPs or LFIs. Therefore, the procedures for creating accounts, signing documents, and onboarding for TPPs are the same as for LFIs.
5.1 Creating an Account
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.1-Creating-an-Account section.
5.2 Signing the Terms & Conditions Document
The process for a TPP to sign the Terms & Conditions Document is similar to the process for LFIs, with the primary difference being the document type: "TPP - Terms & Conditions."
Access to the Production Environment will be granted once the document is signed and reviewed by the AlTareq team.
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.2-Signing-the-Terms-%26-Conditions-Document section for more details.
5.3 Onboarding Additional Users
Refer to the https://openfinanceuae.atlassian.net/wiki/spaces/TFDocsv2/pages/edit-v2/124387349#4.3-Onboarding-Additional-Users section.
5.4 Registering Applications
The Applications Resource allows Organisations to register details of their OpenID Relying Parties (Clients), which interact with OAuth 2.0 Authorization Servers to access protected APIs. The interaction rules are outlined in the Security Profile - FAPI document.
...
A Table Containing all the Roles and the Technical Access Scopes that they can grant on the Ecosystem can be found below : Access Scopes that they can grant on the Ecosystem can be found below :
| Info |
|---|
The Roles Defined below are currently under validation and will be confirmed once the Trust Framework Sandbox is fully live, on the 05th of September. |
Role | Allowed API Scopes | Allowed Authorization Details Types | Allowed Grant Types |
|---|---|---|---|
BSIP - Bank Service Initation Provider |
|
|
|
BDSP - Bank Data Sharing Provider |
|
|
|
IDSP - Insurance Data Sharing Provider |
|
|
|
5.4.2 Application Discovery Metadata
...
Those three fields should be filled out with relevant information that describes the services and the application to ensure optimal discovery by the end users.
...
Field Name
...
Field Description
...
Example
...
Client Name
...
The name of the application as it will appear to end users
...
Finance Tracker Pro
...
Description
...
A detailed description of the application, highlighting its key features, functionalities, and benefit
...
Finance Tracker Pro helps users manage their personal finances by tracking income, expenses, and savings goals. Features include budget planning, expense categorization, and financial reporting
...
Client Info URI
...
The URL pointing to the application’s webpage. This should direct users to a webpage where they can find more detailed information about the application, including its features, pricing, and support.
...
https://www.financetrackerpro.com
...
Logo URI
...
The URL pointing to the application’s logo in PNG or JPEG format. This logo will be displayed alongside the application name and description on the platform, providing a visual identifier for users.
...
the services and the application to ensure optimal discovery by the end users.
Field Name | Field Description | Example |
|---|---|---|
Client Name | The name of the application as it will appear to end users | Finance Tracker Pro |
Description | A detailed description of the application, highlighting its key features, functionalities, and benefit | Finance Tracker Pro helps users manage their personal finances by tracking income, expenses, and savings goals. Features include budget planning, expense categorization, and financial reporting |
Client Info URI | The URL pointing to the application’s webpage. This should direct users to a webpage where they can find more detailed information about the application, including its features, pricing, and support. | |
Logo URI | The URL pointing to the application’s logo in PNG or JPEG format. This logo will be displayed alongside the application name and description on the platform, providing a visual identifier for users. |
5.4.3 Shari’ah compliance flag
When registering/editing an Application a Field called “Flags” is available to be edited by the User.
This field will include the parameter “Shariah Compliant” with two options “True” and “False”. When registering an Application it’s required that the Shari’ah compliance information is added by the Participant on the Trust Framework (OFTF). This compliance information ensures that financial services and applications align with Shari’ah principles for users who require it.
Once registered, this information will be recovered via the Trust Framework APIs by the Data Providers on the Ecosystem, informing this on the Consent Authorization Flow.
Details about how the Shari'ah compliance will be informed to the end users can be seen on : https://openfinanceuae.atlassian.net/wiki/spaces/standardsv1final/pages/151850813/Common+Rules+and+Guidelines#21.-Shari%E2%80%99ah-compliance-of-TPP
5.4.3 Registering FAPI-RP Certifications
...
The first step is to discover all the resources registered by the LFIs in the Directory, which can be done using the Participants Public API - https://docs.connect.raidiam.io/receive-data#l9cWY / https://docs.connect.raidiam.io/find-data-providers-via-public-api
The Participant's Public APIs provide a single response in JSON format that contains information about all the Data Providers registered on the Ecosystem, including all their metadata and API Information, allowing a single call to provide all the information about who offers what product and the endpoint to access it on the AlTareq Platform.
...