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 begin with a TPP who has a client certificate signed by the OFTF for the purposes of providing client authentication for transport layer security. No other credentials are required to invoke the TPP Reports Operation.

The TPP MUST:

• Set the Period Start Date parameter to indicate the start date for the data to be returned.

• Set the Period End Data parameter to indicate the end date for the data to be returned.

• Optionally set the Report Type parameter to only return one of the available report data sets.

The OFP MUST:

• Validate the presented client certificate and verify it is valid and signed by the OFTF.

• Reject the connection attempt if the client certificate presented by the TPP cannot be validated.

• Introspect the certificate to retrieve the TPP ID from the relevant assertions encoded on the certificate.

• Retrieve the raw report data for the period in question and aggregate that data based on the requested period start and end dates. For API Call Volume report data this must be grouped in periods of one day.

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: admin.openfinanceplatform.ae
Accept: application/json

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

• 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.