Permissions

Permissions in the Investment API are modelled as OAuth 2.0 scopes.

We consider related endpoints in the Investment API to be a {topic} and each individual scope grants you permission to perform a set of {action}s in that "topic". The available {topic}s and {action}s are described below.

Scopes are specified as string IDs, in the format {topic}:{action}.

If you need a particular scope to access a group of functionality in the Investment API, you must specify them when requesting the OAuth 2.0 access token.

The following {topic}s are available:

• accounts: Accounts and account groups.
• account_liquidations: Account liquidations.
• account_returns: Account returns.
• businesses: Business entities.
• cash_balance_transfers: Cash balance transfers.
• checks: User checks like KYC, POR, INSTRUMENT_FIT, and COMPLIANCE.
• corporate_actions: Corporate actions.
• credit_fundings: Credit fundings.
• fees: Fee collections.
• files: Files.
• instruments: Instruments.
• isa_transfers: ISA transfers.
• mandates: Mandates.
• orders: Orders.
• payments: Pay-ins and withdrawal operations.
• pensions: German pension accounts.
• portfolios: Portfolios.
• positions: Positions.
• reference_accounts: Reference accounts.
• reports: Reports.
• roles: Roles.
• savings_plans: Savings plans.
• securities_transfers: Securities transfers.
• taxes: Tax residencies.
• transaction_fees: Transaction fees.
• transactions: Transactions.
• users: (End) users.
• valuations: Account valuations.
• virtual_cash_balances: Virtual cash balances.
• webhooks: Webhooks.

There are two {action}s available:

• admin: Allows read-and-write access to the resources covered by the {topic}. In most (but not all!) cases, writing includes create, update and delete operations.
• read: Allows read-only access to the resources covered by the {topic}.