LFI API Hub – v2.1

🕒 5 minute read

Walkthrough – Creating a Server ​

This walkthrough covers publishing your API Hub as a server in the Trust Framework. You MUST complete this before registering API resources or being discoverable by TPPs.

Prerequisites

Before creating a server:

  • Your organisation MUST be onboarded to the Trust Framework with the necessary admin permissions. See Onboarding if you have not yet completed this step.
  • Your API Hub MUST be provisioned and you MUST have received your environment-specific configuration, including your well-known discovery document URI.

Step 1 – Obtain Your Issuer ​

Before creating the server entry, retrieve the issuer value from your API Hub's well-known discovery document. The discovery document URI is provided as part of your environment-specific onboarding configuration.

Open the discovery document URI in a browser or HTTP client and locate the issuer field. You will need this value in Step 3.

Step 2 – Navigate to your Organisation ​

  1. Sign in to the Trust Framework directory.

Environment Mapping

Ensure you are creating the server in the correct Trust Framework environment:

  • Pre-production API Hub → Sandbox Trust Framework (web.sandbox.directory.openfinance.ae)
  • Production API Hub → Production Trust Framework (web.directory.openfinance.ae)
  1. Navigate to your Organisation.
  2. Open the Auth Servers section.
  3. Click + New Server.

Step 3 – Provide the Server Details ​

Fill in the required fields. These values are published in the directory and are visible to TPPs.

FieldGuidance
Customer Friendly Server NameA public-facing name that reflects the brand this API Hub supports (e.g. Acme Bank Retail or Acme Bank Business). If your institution operates multiple API Hubs for different brands, each MUST have a distinct name.
IssuerThe issuer value from your API Hub's well-known discovery document, obtained in Step 1.
DescriptionA short description of the Open Finance service (e.g. Open Finance APIs for Demo Bank's retail customers).

Step 4 – Set the Account Type ​

Indicate the account type(s) supported by this server:

  • Retail — personal and individual customer accounts
  • SME — small and medium enterprise accounts
  • Corporate — corporate and institutional accounts

This allows TPPs to identify which server to use when requesting access to a specific category of accounts.

accounttypes
Click to expand

Upload a logo for this server entry. The logo MUST match the brand that this API Hub supports.

If your institution has multiple API Hubs (e.g. one for retail and one for business), each server MUST use the logo corresponding to its specific brand. This logo is displayed to TPPs and PSUs during consent and authorisation journeys.

logo
Click to expand

Step 6 – Save the Server ​

  1. Skip Additional Details and Server Validity sections.
  2. Click Save to register the server.
  3. Your Server now appears in the Server section of your Organisation.
logo
Click to expand

Finding your Authorisation Server ID

After creation, your Authorisation Server ID is visible on the server detail page. It is also discoverable to TPPs via the API Discovery process.

Next Steps ​

With your server published, you can now add API resources to describe the APIs your institution exposes: