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 | Available with OneID Products |
|---|---|---|
accounts | The users bank account details, including sort code and account number. | Sign-up Plus |
accounts.balances | The users bank account balances.
Requires the accounts scope. | Contact Support |
accounts.bank_address | The address of the bank that manages the users account.
Requires the accounts scope. | Sign-up Plus |
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. | ID Scan - DBS |
email | The users email address. |
|
fraud | UK fraud check results. | ID Assure |
idscan | Attributes about any document(s) the user manually scanned. | Contact Support |
openid | An ID token from the /token API. |
|
pep_and_sanctions | PEP (Politically Exposed Person) and Sanctions check results. | Contact Support |
phone | The users phone number. |
|
profile | The users name. |
|
rtw | Enable a Right to Work check journey. | ID Scan - RTW |
Was this page helpful?