Scopes
The following is a list of scopes that can be included in the Authorization URL scope parameter.
A description of the data structure that is returned for each one can be found in the Journey API ReferenceAPI.
| Scope | Description |
|---|---|
accounts | The users bank account details, including sort code and account number. |
accounts.balances | The users bank account balances.
Requires the accounts scope. |
accounts.bank_address | The address of the bank that manages the users account.
Requires the accounts scope. |
address | The users address. |
age_over_18 | A flag for if the user is over 18 years old. |
date_of_birth | The users date of birth. |
dbs | Enable a DBS ID check journey. |
email | The users email address. |
fraud | Fraud check results. |
idscan | Attributes about any document(s) the user manually scanned. |
openid | An ID token from the /token API. |
pep_and_sanctions | PEP (Politically Exposed Person) and Sanctions check results. |
phone | The users phone number. |
profile | The users name. |
rtw | Enable a Right to Work check journey. |
Was this page helpful?