Scopes
Control what access you have to your user's data using scopes.
A list of space-separated scopes need to be included in the scope parameter when you create an auth link or implement a direct bank authentication link. In the auth link builder in Console, scopes are referred to as Permissions.
Scopes represent the categories of data you're asking the user to share as well as how long you'll be able to access the user's data. The auth dialog uses scopes to determine what information to display to the user when collecting consent. Ultimately scopes limit the Data API endpoints you are authorised to access.
| Scope | Description | API Endpoint |
|---|---|---|
info | Allows access to End user’s identity information held by the Provider | /data/v1/info |
accounts | Allows access to End user’s account numbers and details | /data/v1/accounts/data/v1/accounts/${account_id} |
accounts + balance | Allows access to End user’s account balances | /data/v1/accounts/${account_id}/balance |
accounts + transactions | Allows access to End user’s account transactions | /data/v1/accounts/${account_id}/transactions |
accounts + transactions + balance | Allows access to End user’s account transactions along with running balance | /data/v1/accounts/${account_id}/transactions |
cards | Allows access to End user’s card numbers and details | /data/v1/cards/data/v1/cards/${account_id} |
cards + balance | Allows access to End user’s card balances | /data/v1/cards/${account_id}/balance |
cards + transactions | Allows access to End user’s card transactions | /data/v1/cards/${account_id}/transactions |
cards + transactions + balance | Allows access to End user’s card transactions along with running balance | /data/v1/cards/${account_id}/transactions |
offline_access | Allows access to End user’s data after the short-lived access_token expires. When this permission is granted a refresh_token will be returned | refresh_token |
direct_debits | Allows access to End user’s direct debits (open banking providers only) | /data/v1/accounts/${account_id}/direct_debits |
standing_orders | Allows access to End user’s standing orders (open banking providers only) | /data/v1/accounts/${account_id}/standing_orders |
Product permissions
You can also enable scopes for TrueLayer products within the Permissions tab of the Auth Link Builder
in Console. They are enabled by default in the Sandbox environment, but to enable them for production, contact Support.
| Scope | Description |
|---|---|
verification | Enables the Verification API for use with the auth link. |
signupplus | Enables Signup+ for use with the auth link. |
Updated about 1 year ago