Finatic Logo
Sign Up

Portal Configuration

Learn how to configure the Finatic portal appearance and behavior.

Configure Connect to match your application's design and requirements. Client SDK calls pass these options to openPortal(). Server SDK portal-link calls only create the short-lived one-time token for the session.

Overview

Use portal configuration to control:

  • Appearance with mode ('light' or 'dark')
  • Broker visibility with brokers filtering
  • User convenience with pre-filled email

Mode

Control the portal's appearance with the mode parameter. You can use 'light' or 'dark':

1// Light mode 2await finatic.openPortal({ mode: 'light' }); 3 4// Dark mode 5await finatic.openPortal({ mode: 'dark' });

Filtering Brokers

Show only specific brokers:

1// Show only Interactive Brokers and TastyTrade 2await finatic.openPortal({ 3 brokers: ['interactive-brokers', 'tastytrade'] 4});

Filtering by Type (Broker vs Exchange)

Show only traditional brokers or only exchanges (e.g. crypto exchanges). Use kind: 'broker' or kind: 'exchange':

1// Show only exchanges (e.g. Coinbase, Kraken) 2await finatic.openPortal({ kind: 'exchange' }); 3 4// Show only brokers (e.g. Interactive Brokers, TastyTrade) 5await finatic.openPortal({ kind: 'broker' });

Filtering by Asset Types

Show only providers that support specific asset types (e.g. equity, crypto, options). Multiple values use AND logic—only providers that support all listed types are shown:

1// Show only providers that support both equity and options 2await finatic.openPortal({ 3 asset_types: ['equity', 'options'] 4}); 5 6// Crypto-only providers 7await finatic.openPortal({ asset_types: ['crypto'] });

Common asset type values: equity, crypto, options, futures, forex.

Pre-filling User Email

Pre-fill the user's email for faster authentication:

1await finatic.openPortal({ 2 email: 'user@example.com' 3});

Next Steps

  1. Connecting Brokers - Launch the portal in your broker connection flow.
  2. Quick Start - Review initialization patterns for client and server SDKs.
  3. Error Handling - Add robust handling for portal and API failures.