Core Resources
Banking Api
Energy Api
Common api
Below enpoint returns a list of all the permissions your app requests
Permissions
When Authenticating accounts, a set of permissions must be provided so End Users can understand what data they are giving your application access to. These should be provided when customising your authentication screens. The list of permissions are listed below.
Scope
Description
Info
Allow access to an End Users identity information held by the Institutions
Accounts
Allows access to an End Users account balance and details
Balances
Allows access to an End Users account name, type and balance
Transactions
Allows access to an End Users account transaction details
Payments
Allows access to an End Users Direct Debit and Scheduled Payment information
Payees
Allows access to an End Users save payees information (the saved contacts at the bank)
Energy Accounts
Allows access to an End Users energy account plan and details
Energy Concessions
Allows access to an End Users energy account concessions and assitance information
Energy Payments
Allows access to an End Users energy account payment preferences, including billing frequency and scheduled payments
Energy Billing
Allows access to an End Users billing payments and history
Energy NMI Standing Data
Allows access to an End Users electricity site information, connection and meter
Energy Electricity Usage
Allows access to an End Users meter interval data
Energy Device Information
Allows access to an End Users energy generation and storage device information
These permissions will become important to understand when you are customising your authentication screens. Keep in mind that when in the production environment, you should only be using the permissions for the data you require.
Was this page helpful?