LFI API Hub – v2.1

🕒 5 minute read

Walkthrough – Creating an API Resource ​

This walkthrough covers registering an API resource under your server. You must have an server already created before following these steps.

Step 1 – Navigate to your Authorisation Server ​

  1. Sign in to the Trust Framework directory.
  2. Navigate to your Organisation.
  3. Click into the Server we are adding the APIs to
  4. Open the API Resources section.
  5. Click + New API Resource.

Step 2 – Create the API Resource ​

  1. From the API Family dropdown, select the family that corresponds to the API you are registering. The following API families are available:

    • Account Information (account-information) — banking data sharing
    • Payment Initiation (payment) — domestic single and multi-payments
    • Confirmation of Payee (confirmation) — payee name verification
    • ATM (atm) — ATM location data
    • Products & Leads (product) — product catalogue and lead generation

    For full details on what each family contains, including the endpoints and their mappings, see the API Resources Overview.

  2. Set the API Version (e.g. 2.1).

  3. Click Save. The resource now appears in your Active API Resources list.

If your institution offers multiple API families (e.g. both data sharing and payment initiation), repeat Steps 1–2 for each family. Each family MUST be registered as a separate API resource.

Step 3 – Add API Discovery Endpoints ​

Once your API resource is saved, you MUST add the discovery endpoints so that TPPs can discover and call your APIs.

  1. Click the actions menu on the API resource and select + Add API Discovery Endpoints.

  2. Enter the API Base URL. The format is always your API Hub resource server:

    EnvironmentBase URL
    Pre-productionhttps://rs1.{LFICODE}.preprod.apihub.openfinance.ae
    Productionhttps://rs1.{LFICODE}.apihub.openfinance.ae

    Replace {LFICODE} with your institution's LFI code.

  3. Click Generate Endpoints. The system will populate the list of available endpoints for this API family.

  4. Tick all the endpoints you support. Check all endpoints are correct, then click Save.

API Hub Default Endpoints

Some endpoints are served directly by the API Hub and do not call your Ozone Connect server — for example, /account-information/v2.1/account-access-consents. These endpoints MUST always remain ticked. See the API Resources Overview for which endpoints are marked as API Hub default.

The endpoints are now published to your server entry in the Trust Framework. TPPs can discover them via the API Discovery process.

Verifying Registration ​

You can verify that your API resource is correctly registered by calling the Trust Framework API:

GET /organisations/{OrganisationId}/authorisationservers/{AuthorisationServerId}/apiresources

This returns the list of API resources associated with your authorisation server, as they would appear to a TPP querying the directory.