TPP · Trust Framework · LFI Discovery

Flags & Meta Data 2 min read

Flags and API metadata returned alongside /participants let TPPs filter, select, and drive business logic on top of the LFIs and API families published in the Trust Framework Directory.

01 Flags

Additional attributes on Organisations and Authorisation Servers

Flags provide additional attributes about an Organisation or Authorisation Server within the /participants response.

Example:

Flags excerptjson

"Flags": {
  "AccountType": [
    "Retail"
  ]
}

This example indicates that the Authorisation Server supports Retail account types only. Integrators should interpret this as a restriction, meaning non-retail (e.g., corporate or SME) account types are not supported by this server.

TPPs should use flags to apply filtering and implement business logic decisions during participant selection and integration.

02 API Meta Data

Per-API attributes for filtering, fees, and conditional logic

Each ApiResources object may include an ApiMetadata section, which provides additional information about the API that TPPs can use for business logic, filtering, or display purposes.

Example:

ApiMetadata excerptjson

"ApiMetadata": {
  "AccountSubType": [
    "CurrentAccount",
    "Savings",
    "CreditCard"
  ],
  "OverLimitFees": "0.01"
}

This example indicates that the account-information API family supports the account subtypes CurrentAccount, Savings, and CreditCard, and that data sharing fees exceeding the limits as defined in the commercial model will be set at 0.01 AED for this API family.

TPPs can leverage ApiMetadata to:

Filter available APIs by account types or product subtypes.
Calculate or display applicable data sharing fees to end-users.
Apply conditional business logic based on API capabilities.