Scopes provide a way to grant limited access to the application without sharing full control so they let you specify exactly what type of user's access you need. Each scope represents a specific action the application can perform, such as requesting confirmation codes or updating profile information. Scopes do not grant any additional permission beyond that which the user already has.
Below you will find all available scopes for users, categorized by the application's functional groups. All scopes available for user's account can be retrieved by the Retrieve User Information endpoint.
User
User scope
Description
user_mfa:read
The user is allowed to read the service information.
user_mfa:create
The user can initiate two-factor authentication process.
Accounts
User scope
Description
accounts:read
The user is allowed to read the service information.
Crypto
User scope
Description
deposit_crypto:show
The feature was purchased by the partner and is available in their app.
deposit_crypto:create
The user can create a wallet address for receiving deposits.
Exchange
User scope
Description
exchange:show
The feature was purchased by the partner and is available in their app.
exchange:create
The user can create exchange operations.
Withdraw
User scope
Description
withdraw_crypto:show
The feature was purchased by the partner and is available in their app.
withdraw_crypto:create
The user can create crypto withdrawal operations.
Payin
User scope
Description
payin:show
The feature was purchased by the partner and is available in their app.
payin:read
The user is allowed to read the service information.
payin:create
The user can create payin operations.
payin:block
Payin operations are blocked for the user due to compliance reasons.
Cards
User scope
Description
cardholder_user:show
The feature was purchased by the partner and is available in their app.
cardholder_user:kyc
The user has passed KYC verification and is authorized to issue a card.
cardholder_user:read
The user is allowed to read the service information.
cardholder_user:write
The user is allowed to write or modify the service information.
IBANs
User scope
Description
bank_account:show
The feature was purchased by the partner and is available in their app.
top_up_bank:show
The feature was purchased by the partner and is available in their app.
withdraw_bank:show
The feature was purchased by the partner and is available in their app.
bank_account:forbidden
The user has passed the basic level of SUMSUB KYC verification and based on the documents provided is not allowed to open an IBAN account.
bank_account:kyc
The user has passed KYC verification and is authorized to create an IBAN.
bank_account:read
The user is allowed to read the service information.
withdraw_bank:create
The user can create bank withdrawal operations.
deposit_bank:create
The user can create bank deposit operations.
bank_account:edit
The user can create, list and view details for specified bank account.
