Skip to content

UI Behaviour Driven by API Fields

Permissions and Data Access

The table below outlines the text displayed to users on the Consent Page when they expand each data category associated with the consent permissions.

Your Account Details
PermissionWhat the user sees shared
ReadAccountsBasicBasic account information (account number/ID, type of account, currency, nickname you gave it, and account holder name)
ReadAccountsDetailFull account information (account number/ID, type and description of account, currency, nickname you gave it, and account holder name, opening date)
ReadBalancesYour current account balances (available balance, booked balance, credit limit/overdraft if any, and when the balance was last updated)
Your Regular Payments
PermissionWhat the user sees shared
ReadBeneficiariesBasicBasic beneficiaries information (saved payee account number/ID, type, name and nickname, bank name and details, reference)
ReadBeneficiariesDetailFull beneficiaries information (saved payee account number/ID, type, name and nickname, bank name and details, address, reference)
ReadStandingOrdersBasicBasic standing orders information (payee name and nickname, reference, frequency, first/next/final payment amounts and dates, number of payments, purpose, status, type)
ReadStandingOrdersDetailFull standing orders information (payee name and nickname, reference, frequency, first/next/final payment amounts and dates, number of payments, purpose, status, type)
ReadScheduledPaymentsBasicBasic scheduled payments information (payee name and nickname, instructed amount, scheduled date/time, ID, type)
ReadScheduledPaymentsDetailFull scheduled payments information (payee account details, name and nickname, creditor/debtor reference, instructed amount, scheduled date/time, ID, type)
ReadDirectDebitsDirect debits information (account ID, direct debit ID, status, frequency, mandate identification, name, previous payment amount and date)
Your Account Transactions
PermissionWhat the user sees shared
ReadTransactionsBasicBasic transactions information (date/time, amount, type, description/narrative, status, reference)
ReadTransactionsDetailFull transactions information (date/time, amount, type, description/narrative, payee/merchant name and details, category, status, reference, currency exchange if applicable)
Your Account Statements
PermissionWhat the user sees shared
ReadStatementsAccount statements (monthly/periodic summaries including transaction lists, opening/closing balances, fees, interest, and period details)
Your Product Information
PermissionWhat the user sees shared
ReadProductProduct information (details about your account's financial product, including name, features, interest rates, fees, and key terms)
Contact and Party Details
PermissionWhat the user sees shared
ReadPartyUserDetailed personal details (name, date of birth, contact information, residential address)
ReadPartyUserIdentityDetailed personal identity details (name, date of birth, contact information, Emirates ID, nationality, residential address, employer details)
ReadPartyYour legal or registered name as the account holder
Your Finance Rates
PermissionWhat the user sees shared
ReadProductFinanceRatesDetails of the interest or profit rate on your mortgage, finance, or credit card. In some cases, your bank may protect this information by sending it in a locked format and issue you a code (via SMS or email). You'll need to enter this code within the service so that it can show you the rate.

Account Sub Type Filtering

The AccountSubType field in authorization_details acts as a filter, controlling which of the user's accounts are presented for selection on the LFI Authorisation Page.

AccountSubTypeLFI Authorisation Page Behaviour
ProvidedOnly accounts whose sub-type matches one of the specified values are shown. If the user holds no accounts of the requested sub-type, the LFI returns an error and the authorisation flow cannot proceed.
Not providedAll of the user's available accounts are shown for selection, regardless of account type.

TIP

Use AccountSubType to restrict access to specific account types (e.g. Mortgage). Omit it to allow selection from all account types.

On Behalf Of

When a TPP acts on behalf of another entity (e.g. an aggregator operating under a different trading name), OnBehalfOf.TradingName can be passed to identify the entity to the user on the LFI Authorisation Page.

OnBehalfOf.TradingNameLFI Authorisation Page Behaviour
ProvidedThe trading name is displayed within the Authorisation Page so the user clearly understands which entity they are sharing data with.
Not providedThe TPP's name is displayed in place of the trading name.

TIP

Always populate OnBehalfOf.TradingName so users see a recognisable name rather than a blank or placeholder on the Authorisation Page.