> This page is for Web API. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://ibkrcampus.com/docs/llms.txt. # Single Sign On The `/api/v1/sso-browser-sessions` endpoint can be used to create Single Sign On (SSO) session to seamlessly connect user to the IBKR Client Portal. The IBKR Client Portal is a browser based interface where users can view portfolio information, manage account settings, manage orders, initiate funding, and access account statements. The portal will reflect hosting firms branding (logo, company name, color theme) IF white branding is configured. Parameters for target page are case and space sensitive. #### Workflow 1. Hosting firm will call the `/api/v1/sso-browser-sessions` and provide `credential` and `ip` of the end user. * `credential:` IBKR username associated with the user. * `ip:` Static IP is required and must be the actual customer's computer (their IP-REMOTE_ADDR). * ***Example*** * `POST /api/v1/sso-browser-sessions { "ip": "206.106.137.230", "credential": "potest123"}` 2. IBKR returns a response URL with SID (unique token). Hosting firm invokes the URL with SID token into the users browser, new window opens and the user lands in IBKR White Branded Portal. * SID is only valid for 60 seconds and can only be accessed from the IP which was included in the original request. * Error will be triggered IF unique SID is accessed more than once, entered after 60 seconds, OR if IP which SID is accessed from is different from IP that was passed in the original request to create single sign on session. * ***Example of IBKR Response*** * `https://www.clientam.com/sso/resolver?` 3. Optionally, set 'Target' page by appending ACTION to URL * See details [here](https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/#single-sign-on) to set target page including available actions. * ***Example of URL if target page is set for Statements*** * `https://www.clientam.com/sso/resolver?ACTION=Statement&SID=` #### Limitations * SSO is only supported for browsers (Desktop or Mobile Browser). SSO is not supported for natively installed mobile applications. * When an account is initially created, IBKR will assign a temporary password to the account. One time setup where the user is required to reset the temporary password after the account has been created. * Authentication using the IBKR credential (username) and password is required when adding withdrawal instructions and initiating withdrawal requests using the IBKR hosted portal. ### Set Target Page By default, when you create an SSO session for an opened account, your users will land on the Client Portal home page. However, you can direct users to a specific target page by adding the `ACTION` parameter to your start call. If you set a target page, the IBKR navigation panel will be displayed by default, allowing users to access other features within the Portal beyond just the target page. For a more streamlined experience, we offer an "IFRAME" option that removes the IBKR navigation panel. To create IFRAME, simply include `showNavBar=false` in your SSO URL. | SSO- Standard | SSO with IFRAME | | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | ACTION=TransferFunds\&method=WIRE\&type=WITHDRAWAL\¤cy=**USD** | ACTION=TransferFunds\&method=WIRE\&type=WITHDRAWAL\¤cy=USD\&showNavBar=false | | | | ### Request Parameters | Parameter | Type | Usage | | ---------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ACTION | Varies based on action, see table below. | Optional- If not set OR invalid, user is directed to the Client Portal home page. | | showNavBar | true false | Optional- If missing OR set to true, user will land on Client Portal home page. If set to false, navigation bar will not be displayed and this will create 'IFRAME'. showNavBar=false is only supported for select features. IF set for unsupported feature, user will land on Client Portal home page. | #### Common Target Pages | Landing Page | ACTION | IFRAME Supported? | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | Account Settings | ACTION=AccountSettings\&SID=\<> | Y | | Auto Select Account (for Linked Accounts) | If the autoSelect parameter is passed with an account ID, portal will select that account on the landing page (if the account is available for selection). Example where U1234 = Account ID ACTION=autoSelect=U1234\&noPickerClear=T Example if using auto select for Funding: ACTION=TransferFunds\&autoSelect=U1234\&noPickerClear=T | N | | Link Existing Account to master | forwardTo=AA_LINKAGE\&masterAccountId=\ | N | | Client Profile | ACTION=AccountSettings\&config=Profile\&SID=\<> | Y | | Recurring Investments | ACTION=RecurringInvestment\&SID=\<> | Y | | Saved Banking Instructions | ACTION=FUNDING_INSTRUCTIONS\&SID=\<> | N | | Statements | ACTION=Statement\&SID=\<> | Y | | Trading Permissions | ACTION=AccountSettings\&config=TradingPermissions\&SID=\<> | Y | | Transaction History | **Funding:** ACTION=TransactionHistory\&SID=\<> **All Transactions:** ACTION=RpTransactionHistory\&SID=\<> | Y | | Transfer Funds | **ACTION**=TransferFunds\&SID=\<> *The following parameters can be set IF ACTION=TransferFunds* **type**: DEPOSIT or WITHDRAWAL **method**: ACH, BPAY_NOTIFICATION, BILL_PAY_NOTIFICATION, CHECK_NOTIFICATION, DIRECT_DEPOSIT, EDDA, EFT, LVP, OPEN_BANKING, WIRE, WISE_BALANCE, WISE_BANK_NOTIFICATION,, WISE_OUTBOUND, **currency**: USD, CAD, HKD, CNH, EUR, GBP, AUD **A few examples below:** **Deposit** (Display all saved instructions): ACTION=TransferFunds\&type=DEPOSIT\¤cy=USD\&SID=\<> **ACH Deposit:** ACTION=TransferFunds\&method=ACH\&type=DEPOSIT\¤cy=USD\&SID=\<> **EFT Deposit:** ACTION=TransferFunds\&method=EFT\&type=DEPOSIT\¤cy=CAD\&SID=\<> **Open Banking** **Plaid Europe:** ACTION=TransferFunds\&type=DEPOSIT\&method=OPEN_BANKING\¤cy=\ **Wire Deposit:** ACTION=TransferFunds\&method=WIRE_NOTIFICATION\&type=DEPOSIT\¤cy=**XXX** **Wise Balance:** ACTION=TransferFunds\&method=WISE_BALANCE\&type=DEPOSIT\¤cy=XXX **Wise Deposit:** ACTION=TransferFunds\&method=WISE_BANK_NOTIFICATION\&type=DEPOSIT\¤cy=**XXX** **Withdrawal** (Display all saved instructions): ACTION=TransferFunds\&type=WITHDRAWAL\¤cy=USD\&SID=\<> **ACH Withdrawal:** ACTION=TransferFunds\&method=ACH\&type=WITHDRAWAL\¤cy=**XXX** **EFT Withdrawal:** ACTION=TransferFunds\&method=EFT\&type=WITHDRAWAL\¤cy=CAD\&SID=\<> **Local Bank Transfer:** ACTION=TransferFunds\&method=LVP\&type=WITHDRAWAL\¤cy=**XXX** **SEPA Withdrawal:** ACTION=TransferFunds\&method=SEPA\&type=WITHDRAWAL\¤cy=**XXX** **Wire Withdrawal:** ACTION=TransferFunds\&method=WIRE\&type=WITHDRAWAL\¤cy=**XXX** **Wise Withdrawal:** ACTION=TransferFunds\&method=WISE_OUTBOUND\&type=WITHDRAWAL\¤cy=**XXX** | Y | | Transfer Positions | **ACTION**=TransferPositions\&SID=\<> *The following parameters can be set IF ACTION=TransferPositions* **type**: POSITION_INBOUND, POSITION_OUTBOUND, INTERNAL **method:** ACATS, ATON, FOP, DRS, DWAC, ASSET_TRANSFER **A few examples below:** **Incoming ACATS Transfer:** ACTION=TransferPositions\&type=POSITION_INBOUND\&method=ACATS\&SID=\<> **Incoming US FOP:** ACTION=TransferPositions\&type=POSITION_INBOUND\&method=FOP\&SID=\<> **Internal Transfer:** ACTION=INTERNAL\&SID=\<> **Outgoing Basic Non-US FOP:** ACTION=TransferPositions\&type=POSITION_OUTBOUND\&method=ASSET_TRANSFER\&SID=\<> | Y | ## View All Landing Pages | Target | ACTION | Limitations | | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Account Alias | ACTION=AccountSettings\&config=AccountAlias\&SID=\<> | | | Account Confirmation Letter | ACTION=RM_ACCOUNT_CONFIRMATION_LETTER\&SID=\<> | | | Account Inheritance | ACTION=AccountSettings\&config=AccountBeneficiary\&SID=\<> | | | Account Type | ACTION=ACCOUNT_TYPE\&SID=\<> | | | Account Type | ACTION=AccountSettings\&config=AccountType\&SID=\<> | | | Activity Notifications | ACTION=AM_NOTIFICATIONS\&SID=\<> | | | Add External Account | ACTION=ADD_EXTERNAL_ACCOUNTS\&SID=\<> | | | Administrator Search | ACTION=TA_VIEW_ADM_MKT_PLACE\&SID=\<> | | | Advertise Services | ACTION=MpApply\&SID=\<> | | | Advisor Authorizations | ACTION=AccountSettings\&config=AdvisorAuthorizations\&SID=\<> | | | Advisor Search | ACTION=ADVISORS_MKT_PLACE_SEARCH\&SID=\<> | | | Alert Notification | ACTION=ALERT_NOTIFICATION\&SID=\<> | | | Alert Notification | ACTION=UserSettings\&config=AlertNotification\&SID=\<> | | | ASIC Short Positions Reporting | ACTION=AccountSettings\&config=AsicShortPosition\&SID=\<> | | | Audit Trail | ACTION=AccountSettings\&config=AuditTrail\&SID=\<> | | | Base Currency | ACTION=AccountSettings\&config=BaseCurrency\&SID=\<> | | | Bill Pay | ACTION=BILL_PAY\&SID=\<> | | | Cash Management | ACTION=CASH_MGMT\&SID=\<> | | | CFDs and Metals | ACTION=AccountSettings\&config=UklAccountCreation\&SID=\<> | | | Chat under Support | ACTION=CS_CHAT\&SID=\<> | | | Close Account | ACTION=CLOSE_ACCOUNT\&SID=\<> | | | Close Account | ACTION=AccountSettings\&config=CloseAccount\&SID=\<> | | | Commission Pricing Structure | ACTION=COMM_PRICE_STRUCTURE\&SID=\<> | | | Contact IB | ACTION=CS_CONTACT_IB\&SID=\<> | | | Contract Details | ACTION=CONTRACT_DETAILS\&SID=\<> | | | Contract Search | ACTION=CS_CONTRACT_SEARCH\&SID=\<> | | | Corp Action | ACTION=CS_CORP_ACTION\&SID=\<> | | | Debit Card Signup for Clients | ACTION=AccountSettings\&config=ClientDebitcardConfig\&SID=\<> | | | Declared Investor Status | ACTION=AccountSettings\&config=SingaporeInvestorCategory\&SID=\<> | | | Dividend Election | ACTION=AccountSettings\&config=DividendReinvestment\&SID=\<> | | | Email Address | ACTION=CHANGE_EMAIL\&SID=\<> | | | Email Address | ACTION=UserSettings\&config=EmailAddress\&SID=\<> | | | EMIR & LEI Information | ACTION=AccountSettings\&config=Emir\&SID=\<> | | | Excess Funds Sweep | ACTION=AccountSettings\&config=ExcessFundsSweep\&SID=\<> | | | Exposure Fee | ACTION=RM_EXPOSURE_FEE\&SID=\<> | | | Financial Info | ACTION=FINANCIAL_INFO\&SID=\<> | | | Financial Profile | ACTION=AccountSettings\&config=FinancialInfo\&SID=\<> | | | Financial Transactions | ACTION=FINANCIAL_TRANS_HISTORY\&SID=\<> | | | Find Services | ACTION=MpSearch\&SID=\<> | | | Flex Queries | ACTION=RM_FLEX_QUERIES\&SID=\<> | | | Flex Queries Delivery | ACTION=FLEX_QUERIES_DELIVERY\&SID=\<> | | | Flex Queries Delivery | ACTION=UserSettings\&config=FlexQueriesDelivery\&SID=\<> | | | Flex Web Service | ACTION=AccountSettings\&config=FlexWebService\&SID=\<> | | | FYI Notifications | ACTION=AccountSettings\&config=IbfyiNotification\&SID=\<> | | | Goal Tracker | ACTION=GoalTracker\&SID=\<> | | | Groups & Households | ACTION=Groups\&SID=\<> | | | HFCIP Search | ACTION=TA_HFCI_VIEW\&SID=\<> | | | IB FYI | ACTION=TA_FYI\&SID=\<> | | | IB Notes | ACTION=AccountSettings\&config=IbNotes\&SID=\<> | | | IB SLB Tools | ACTION=CS_SLB\&SID=\<> | | | IBKR Pricing Plan | ACTION=IBKR_LITE\&SID=\<> | | | IBKR Pricing Plan | ACTION=AccountSettings\&config=ibkrLite\&SID=\<> | | | Institutional Services | ACTION=AccountSettings\&config=InstitutionalService\&SID=\<> | | | Insured Bank Deposit Sweep Program | ACTION=AccountSettings\&config=PROMONTORY_CONFIG\&SID=\<> | | | Investor Category | ACTION=AccountSettings\&config=InvestorCategory\&SID=\<> | | | IP Restrictions | ACTION=UserSettings\&config=IpRestriction\&SID=\<> | | | IPO Subscription Permission | ACTION=AccountSettings\&config=IpoSubscriptionConfig\&SID=\<> | | | IRA Activity | ACTION=AccountSettings\&config=IraActivity\&SID=\<> | | | IRA Conversion | ACTION=AccountSettings\&config=IraConversion\&SID=\<> | | | IRA Recharacterization | ACTION=AccountSettings\&config=IraRecharacterization\&SID=\<> | | | Large Trader ID | ACTION=AccountSettings\&config=LargeTraderId\&SID=\<> | | | Link Account to Advisor/Broker/Administrator | ACTION=LINK_ACCOUNT\&SID=\<> | | | Link Account to Advisor/Broker/Administrator | ACTION=AccountSettings\&config=Linkage\&SID=\<> | | | Manage Administrators | ACTION=AccountSettings\&config=AdminManagement\&SID=\<> | | | Market Data Assistant | ACTION=CS_MARKET_DATA_ASSISTANT\&SID=\<> | | | Market Data Restriction | ACTION=UserSettings\&config=MarketDataRestriction\&SID=\<> | | | Market Data Subscriptions | ACTION=UserSettings\&config=MarketData\&SID=\<> | | | Market Overview | ACTION=ACCT_MGMT_MAIN\&loginType=1\&clt=0\&RL=1#/markets\&SID=\<> | | | Marketing Preference | ACTION=MKT_PREFERENCE\&SID=\<> | | | Marketing Preferences | ACTION=UserSettings\&config=MarketingPreference\&SID=\<> | | | Message Center | ACTION=CS_WEB_TICKET\&SID=\<> | | | Message Center Notification Settings | ACTION=UserSettings\&config=MessageCenterNotification\&SID=\<> | | | Message Center Notifications | ACTION=CS_MESSAGE_CENTER_NOTIFICATIONS\&SID=\<> | | | Mifid Client Category | ACTION=MIFID_CLIENT_CATEGORY\&SID=\<> | | | MiFID Client Category | ACTION=AccountSettings\&config=MifidClientCategory\&SID=\<> | | | Mifir | ACTION=AccountSettings\&config=Mifir\&SID=\<> | | | Mobile Number | ACTION=UserSettings\&config=MobileNumber\&SID=\<> | | | Mobile Number Configuration | ACTION=MOBILE_VERIFICATION\&SID=\<> | | | Money Manager Search | ACTION=TA_VIEW_MM_MKT_PLACE\&SID=\<> | | | New Features Poll (New) / Provide Feedback | ACTION=FEEDBACK\&SID=\<> | | | New ticket creation | ACTION=NEW_TICKET\&SID=\<> | | | Non-US Dividend Tax Relief | ACTION=AccountSettings\&config=DividendTaxRelief\&SID=\<> | | | Online Features | ACTION=UserSettings\&config=VoterSubscription\&SID=\<> | | | Online Features (a.k.a. Voter Registration) | ACTION=UM_VOTER_REGISTRATION\&SID=\<> | | | Open an Additional Account | ACTION=AccountSettings\&config=AdditionalAccount\&SID=\<> | | | Order Ticket | ACTION=ACCT_MGMT_MAIN\&loginType=1\&clt=0\&RL=1#/order-ticket/stock\&SID=\<> | Requires a minimum of 1200px width. If smaller then we only provide side-car order ticket which doesn't open on a new page. Meaning, this can only be used when connecting from desktop browser, not mobile. | | Other Reports | ACTION=RM_MARGIN_REPORTS\&SID=\<> | | | Paper Trading Account | ACTION=AccountSettings\&config=PaperTrading\&SID=\<> | | | Paper Trading Account Reset | ACTION=AccountSettings\&config=PaperTradingReset\&SID=\<> | | | Paper Trading Configuration | ACTION=TA_PAPER_TRADING\&SID=\<> | | | Password | ACTION=UserSettings\&config=Password\&SID=\<> | | | Password Change | ACTION=PASSWORDCHG\&SID=\<> | | | PDT Reset under Support | ACTION=PDTRESET_STATUSCHECKED\&SID=\<> | | | Pending Items | ACTION=DOC\&SID=\<> | | | Portfolio | ACTION=ACCT_MGMT_MAIN\&loginType=1\&clt=0\&RL=1#/portfolio\&SID=\<> | | | Portfolio Analyst | ACTION=PA_DELIVERY\&SID=\<> | | | Portfolio Analyst | ACTION=PORTFOLIOANALYST\&SID=\<> | | | PortfolioAnalyst | ACTION=RM_PORTFOLIO_ANALYST\&SID=\<> | | | PortfolioAnalyst Delivery | ACTION=UserSettings\&config=PaDelivery\&SID=\<> | | | PRIIPS | ACTION=CS_PRIIPS\&SID=\<> | | | Professional Advisor Qualification | ACTION=AccountSettings\&config=ProAdvisorQualification\&SID=\<> | | | Profile | [ACTION=AccountSettings\&config=Profile\&SID=\<>](https://www.clientam.com/sso/resolver?action=AccountSettings\&config=Profile\&sid=%3c%3e) | | | Promontory | ACTION=promontory\&SID=\<> | | | Questionnaire | ACTION=QUESTIONNAIRE\&SID=\<> | | | Read-Only Access | ACTION=UserSettings\&config=TradingReadOnly\&SID=\<> | | | Read-only Setting | ACTION=TA_MOBILE_READONLY\&SID=\<> | | | Refer a Friend | ACTION=AccountSettings\&config=FriendReferral\&SID=\<> | | | Registration Information | ACTION=AccountSettings\&config=JurisdictionInfo\&SID=\<> | | | Regulatory Information | ACTION=AccountSettings\&config=RegulatoryInformation\&SID=\<> | | | Required Minimum Distribution Calculator | ACTION=Rmd\&SID=\<> | | | Research Subscriptions | ACTION=TA_DATA_SERVICES\&SID=\<> | | | Research Subscriptions | ACTION=UserSettings\&config=ResearchSubscription\&SID=\<> | | | Risk Appetite Questionnaire | ACTION=AccountSettings\&config=BondRiskAppetite\&SID=\<> | | | Risk Scores | ACTION=RiskScores\&SID=\<> | | | Risk Scores | ACTION=AccountSettings\&config=AdvisorQuestionnaireEdito\&SID=\<> | | | Section 13 | ACTION=AccountSettings\&config=Acors\&SID=\<> | | | Secure Login Settings | ACTION=SECURE_LOGIN\&SID=\<> | | | Secure Login System | ACTION=UserSettings\&config=SecureLogin\&SID=\<> | | | Securities Class Action Recovery | ACTION=AccountSettings\&config=litigationRecovery\&SID=\<> | | | Security Questions | ACTION=UserSettings\&config=SecurityQuestions\&SID=\<> | | | Settings | ACTION=ACCOUNT_SETTINGS\&SID=\<> | | | SFTR | ACTION=AccountSettings\&config=Sftr\&SID=\<> | | | SMS Address | ACTION=UserSettings\&config=SmsAddress\&SID=\<> | | | SMS Alerts | ACTION=SMS_ALERTS\&SID=\<> | | | SMS Alerts | ACTION=UserSettings\&config=SmsAlerts\&SID=\<> | | | Soft Dollar Configuration | ACTION=AccountSettings\&config=SoftDollar\&SID=\<> | | | Soft Dollars Disbursement | ACTION=AccountSettings\&config=SoftDollarDisbursement\&SID=\<> | | | Statements | ACTION=Statement\&SID=\<> | | | Statements Delivery | ACTION=UserSettings\&config=StatementsDelivery\&SID=\<> | | | Stock Yield Enhancement Program | ACTION=AccountSettings\&config=SYEP\&SID=\<> | | | Support | ACTION=Support\&SID=\<> | | | Tax Reports | ACTION=RM_FIFO_COST_BASIS\&SID=\<> | | | Tax Reports | ACTION=RM_TAX_FORMS\&SID=\<> | | | Third-Party Services | ACTION=AccountSettings\&config=ThirdPartyServices\&SID=\<> | | | Tools page under support | ACTION=IB_TOOLS\&SID=\<> | | | Trade Cancellation Request | ACTION=CS_TRADE_CANCEL\&SID=\<> | | | Trade Execution Notification | ACTION=UserSettings\&config=ActivityNotification\&SID=\<> | | | Trade In Fractions | ACTION=TRADE_IN_FRACTIONS\&SID=\<> | | | Trade in Fractions | ACTION=AccountSettings\&config=tradeInFrACTIONs\&SID=\<> | | | Trader Referral | ACTION=AccountSettings\&config=TraderReferral\&SID=\<> | | | Trading Permissions | ACTION=AccountSettings\&config=TradingPermissions\&SID=\<> | | | Trading Restrictions | ACTION=AccountSettings\&config=TradingRestrictions\&SID=\<> | | | Trusted Contact Person | ACTION=AccountSettings\&config=TrustedContact\&SID=\<> | | | VAT | ACTION=AccountSettings\&config=SalesTax\&SID=\<> | | | Virtual FX Tracking | ACTION=AccountSettings\&config=VirtualFxPortfolioTracking\&SID=\<> | | | White Branding | ACTION=AccountSettings\&config=WhiteBranding\&SID=\<> | | | Why is it moving | ACTION=ACCT_MGMT_MAIN\&loginType=1\&clt=0\&RL=1#/markets\&SID=\<> | |