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.

ScopeDescriptionAvailable with OneID Products
accountsThe users bank account details, including sort code and account number.Sign-up Plus
accounts.balancesThe users bank account balances. Requires the accounts scope.Contact Support
accounts.bank_addressThe address of the bank that manages the users account. Requires the accounts scope.Sign-up Plus
addressThe users address.
  • Age Assure
  • Sign-in Refresh
  • Sign-up
  • Sign-up Plus
  • ID Proof
  • ID Assure
age_over_18A flag for if the user is over 18 years old.
  • Age Verification
  • Age Assure
date_of_birthThe users date of birth.
  • Age Assure
  • Sign-up
  • Sign-up Plus
  • ID Proof
  • ID Assure
dbsEnable a DBS ID check journey.ID Scan - DBS
emailThe users email address.
  • Age Assure
  • Sign-in Refresh
  • Sign-up
  • Sign-up Plus
fraudUK fraud check results.ID Assure
idscanAttributes about any document(s) the user manually scanned.Contact Support
openidAn ID token from the /token API.
  • Age Check
  • Age Verification
  • Age Assure
  • Sign-in
  • Sign-in Refresh
  • Sign-up
  • Sign-up Plus
  • ID Live
  • ID Check
  • ID Proof
  • ID Assure
pep_and_sanctionsPEP (Politically Exposed Person) and Sanctions check results.Contact Support
phoneThe users phone number.
  • Age Assure
  • Sign-in Refresh
  • Sign-up
  • Sign-up Plus
profileThe users name.
  • Age Verification
  • Age Assure
  • Sign-in Refresh
  • Sign-up
  • Sign-up Plus
  • ID Check
  • ID Proof
  • ID Assure
rtwEnable a Right to Work check journey.ID Scan - RTW
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
On This Page
Scopes