Skip to content

Scopes and grants

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

ScopeAllows
portfolio:readList and read granted portfolio metadata.
transactions:readList transactions for granted portfolios.
transactions:writeSubmit trades to granted portfolios.
imports:readCheck import status and validation results.
performance:readRead performance reports for granted portfolios.
tax:readRead 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.