Connecting Brokers
Open Connect, create grants, and verify account access.
Use Connect so users sign in to their broker, pick accounts, and grant your company access. Store accountId values after success — not broker passwords or connection IDs.
Open Connect
Component failed to load
Unknown docs component path: content/docs-connecting-brokers-open-portal
Client SDK — openPortal() in an iframe with callbacks. Server SDK — create session + portal link on your backend; pass the token to the browser.
Verify grants
Component failed to load
Unknown docs component path: content/docs-connecting-brokers-verify-grants
Treat the Connect success callback as a signal to re-fetch accounts — not as durable storage. Persist accountId values from the list call.
Portal options and troubleshooting
Optional openPortal props: brokers, email, mode, onSuccess, onError, onClose.
- Portal won't open — check token,
init(), and browser console errors. - No accounts after success — wait a few seconds; re-call
listAccounts({ includeSyncStatus: true }). - Connection fails — confirm broker is on the Integrations page and credentials are valid.
Next
- Account Grants — scopes and revoke
- Getting Data — balances, positions, orders
