1. API Flows

This API provides a standardized mechanism for retrieving report data from the OFP.

1.1 Step 1. Invoke the TPP Reports Operation

The flow MUST being with the TPP and a valid access token (with scope), solicited using the Client Credentials grant type, from the OFP Authorization Server for a given LFI to call the TPP Reports operation.

...

The OFP MUST return a 200 OK together with the response body containing the requested report data.

2. TPP Reports Examples

2.1 The TPP Invokes the TPP Reports Operation

2.1.1 TPP Reports Operation Request

GET /open-finance/reporting/v1.0-rc2/tpp-reports?PeriodStartDate=2025-01-01&PeriodEndDate=2025-01-21&ReportType=API+Call+Volume
Host: lfi1.openfinanceplatform.ae
Accept: application/json
Authorization: Bearer 590baa7a-2f66-481e-b18c-8ce8bbf71477

2.1.2 TPP Reports Operation Response

HTTP/1.1 200 OK
Content-type: application/json
x-fapi-interaction-id: 86b446a7-b2de-4615-8731-167df9e64336
{
  "Data": [
    {
      "Type": "API Call Volume",
      "ReportingPeriodDate": "2019-01-01",
      "LfiId": "c6b2288a-29c8-4a89-b982-33059da8f420",
      "LfiName": "Example LFI 1",
      "ApiSet": "BankDataSharing",
      "HttpMethod": "GET",
      "Url": "/open-finance/bank-data-sharing/v1.0-rc2/accounts",
      "HttpResponseCodeGroup": "2xx",
      "TotalCalls": 100002
    },
    {
      "Type": "API Call Volume",
      "ReportingPeriodDate": "2019-01-01",
      "LfiId": "c6b2288a-29c8-4a89-b982-33059da8f420",
      "LfiName": "Example LFI 1",
      "ApiSet": "BankServiceInitiation",
      "HttpMethod": "POST",
      "Url": "/open-finance/bank-service-initiation/v1.0-rc2/payments",
      "HttpResponseCodeGroup": "2xx",
      "TotalCalls": 50
    },
    ...
  ],
  "Links": {
    "Self": "https://admin.openfinanceplatform.ae/open-finance/reporting/v1.0-rc2/tpp-reports?PeriodStartDate=2025-01-01&PeriodEndDate=2025-01-21&ReportType=API+Call+Volume"
  },
  "Meta": {}
}

3. OpenAPI Description

See the TPP Reports API - OpenAPI Description page.

4. Notes

• TPP reports are provided at each LFI instance at the OFP. A given TPP must therefore request report data from all LFIs TPP Report APIs.

• All report types are bundled into one response for convenience for the TPP. They can, however, be requested individually as described above.

• Unsigned responses are provided for this API. Signed responses are not supported.

• For clarity, each report line can be uniquely identified based on a composite key using the following components:

  • Type

  • ReportingPeriodDate OR (PeriodStartDate and PeriodEndDate).

  • LfiId

  • APISet

  • HttpMethod

  • Url

  • Where included, HttpResponseCodeGroup

• The parameters PeriodStartDate and PeriodEndDate are inclusive.

• Pages for the report data will be returned based on the default OFP page size.

5. Security

A tpp-reports scope is used for the TPP Reports operation.

...