Skip to content

Scopes and grants

Scopes limit what a partner application can do for a customer portfolio.

Scope Allows
portfolio:read List and read granted portfolio metadata.
transactions:read List transactions for granted portfolios.
transactions:write Submit trades to granted portfolios.
imports:read Check import status and validation results.
performance:read Read performance reports for granted portfolios.
tax:read Read tax reports for granted portfolios.

Request the smallest set of scopes your integration needs. For example, a trade uploader usually needs:

portfolio:read transactions:write imports:read

A reporting integration usually needs:

portfolio:read performance:read tax:read

Grants are customer-controlled. Your integration should handle 403 responses by prompting the customer to reconnect or approve the missing scope.