Scopes

A scope represent a permission according to an entity or a group of entities. Scopes are requested and associated with a client Id when requesting your credentials.

🚧
Request new scopes
If you want to change your available scopes, you need to request new credentials through our support.

Common scopes follow the openid connect specification.

Scope	Description
openid	Will send back an id_token when exchanging code for tokens as specified in the Open Id Connect specification. See step 3 - Id token below for details.
profile	Add profile informations in id_token claims (openid scope required)
email	Add email and email_verified claims in id_token claims (openid scope required)
phone	Add phone in id_token claims (openid scope required)
bank:transfers:read	Query user bank transfers (see Bank transfers)
bank:transfers:write	Create a bank transfer order (Bank transfers) Endpoints using this scope are restricted
bank:transfers:recipients:read	Query user bank transfer recipients (see Bank Transfers Recipients)
bank:transfers:recipients:write	Create a bank transfer recipient (see Bank Transfers Recipients) Endpoints using this scope are restricted
bank:transactions:read	Query user transactions (see Bank Transactions)
bank:accounts:read	Query user bank accounts (see Bank Accounts)
user:companies:read	Get complete informations about the user company (see Companies Profiles)
user:profile:read	Get complete informations about the user (see Users Profiles)
invoices:read	Query user invoices
invoices:write	Create & update invoices
receipts:read	Query user receipts
receipts:write	Create & update receipts
user	Includes user:profile:read & user:companies:read
bank	Includes all bank:* scopes
invoices	Includes invoices:read & invoices:write
receipts	Includes receipts:read & receipts:write

🚧
OpenID scopes
profile, email & phone scopes require the openid scope.