/sso/create

For sso/create, a static IP is required in order to create the SSO session.

• The URL that is returned from the sso/create is only accessible from the IP which was passed to IBKR in the sso/create request.

• Workflow:

  1. Your team makes call using sso/create, with the user name and IP associated with the user.

     • For the IP, we are expecting only one IP, the actual customer's computer (their IP-REMOTE_ADDR).

1. IBKR returns a response with unique URL to create SSO Session .

   • Each sso/create request will generate a unique URL.

   • The URL returned in the sso/create request is only valid for 60 seconds and can only be accessed from the IP which was included in the sso/create request.

   • If the IPs are different, you will receive an error.

2. Your team invokes the unique URL into the users browser, new window opens and the client is in the IBKR white branded portal (landing page is determined based on the ACTION included in URL. If no ACTION is defined, user will land on Client Portal home page.

• »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.

    • Withdrawal instructions can only be added within the IBKR hosted portal. If saved withdrawal instructions are in place, withdrawal requests can be initiated using DAM (ws/fb/new-request 'withdraw_funds')

• QA Nuances

  In QA, you can test creating an SSO session.

  • Access to IBKR Portal to complete funding functions is not available in QA.

  • Due to limitations with our QA environment, IP which unique URL is accessed from must be whitelisted with IBKR otherwise you will receive ‘Access Denied’. To whitelist additional IPs, please send CSID + IP to dam@ibkr.com.

  Prod

  If password is assigned at account creation, user will be prompted to enter temporary password + set permanent password when accessing the IBKR Portal via SSO for first time.

  • All subsequent SSO sessions, user will be directed to IBKR portal without username/password authentication

  • Users will be required to complete IBKR authentication (enter username and password) when completing the following functions in portal:

    • Adding ACH instructions

    • Initiating a withdrawal request

    • Adding Wire Withdrawal Instructions

»How to obtain username/CREDENTIAL

Option 1: Username is returned by IBKR in the response file during account creation.

Copy

<Users>
<User external_id="IndiaNagyTest" password="aadd343">testusername1</User>
</Users>

Option 2: Use /getAccountDetail to query the username by the Account ID.

Copy

"users":["testusername1"]

JSON Request

Prior to Encryption

{"CREDENTIAL":"<user>","IP":"<REMOTE_ADDR>","CONTEXT":"AM.LOGIN"} 

{"CREDENTIAL":"testusername1","IP":"206.106.137.230","CONTEXT":"AM.LOGIN"}

After Encryption

{
  "CSID":"<client-service-id>",
  "payload":"<encrypted and signed JSON, encoded in base64>"
}

curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/sso/create -d '{"CSID":"testerCSID", 
"payload":" ye0cQWpqaXp5aUnvUXHOGGVIQAJoJS2TeUymc/Xq5a0DMFCUk/EStTuLSHvxMOLoowBBl8BwueD2iyntVf+6iXGOz+/WAM/+Y/KheszZOWfasdfawe235afuD2Li2LT3RzRuxzlpi7CXgIQvqOVzWsSoB6mn/jK6BRRNWEXPhzmNgQB/gVReN"}'

JSON Response

{
 
  "SUCCESS":" {
    "SIGNED_URL":"<encrypted JSON, encoded in base64>
     "RESULT":"<true|false>"
  }
}

Sample

Success

{"SIGNED_URL":"hQIMA6Rd97hN4yPOAQ/9Ec48UXuLd4nI2HqW","RESULT":true}

https://api.ibkr.com/sso/dam/start?SID=043B326E636772657738396B34353B6C3266613B6D6B356C3433716A66305B617566613930666E716B356C3B716A6B6F3B667104624604065806525D01030351475D1B0D0A020957544401

Error

{"ERROR":"Unable to Decrypt","RESULT":false}

• Define landing page when creating an SSO Session.

  • Only applicable for accounts that are OPEN.

  • Pending applications will be directed to the application.

By default, when creating SSO session, users are directed to the Client Portal home page (white branded). Direct user to specific landing page by adding the ACTION to the start call.

• Data for landing page is case and space sensitive

  • ACTION (is always uppercase)

  • SID (start call is always upper case)

Commonly used Landing Pages

https://www.clientam.com/sso/resolver?ACTION=Statement&SID=<asdfsadfsdfsadfsdf>

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=<>
ACH Deposit	ACTION=ACHDeposits&SID=<>
ACH Withdrawal	ACTION=ACHWithdrawals&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=<>
Direct Deposit	ACTION=DIRECT_DEBIT&SID=<>
Direct Deposit	ACTION=DirectDeposit&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=<>
Fund Transfers	ACTION=FUND_TRANSFERS&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=<>
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=<>
Saved Funding Information	ACTION=FUNDING_INSTRUCTIONS&SID=<>
Saved Information	ACTION=FundingInstructions&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=<>
Transaction History	ACTION=TransACTIONHistory&SID=<>
Transfer Funds	ACTION=TransferFunds&SID=<>   The following parameters can be set IF action = TransferFunds:type: DEPOSIT or WITHDRAWALmethod: ACH, WIRE, EDDA, EFT currency: CAD, USD, HKD, CNH, etc. A few examples below: EFT Withdrawal:action=TransferFunds&method=EFT&type=WITHDRAWAL&currency=CADEFT Deposit: action=TransferFunds&method=EFT&type=DEPOSIT&currency=CADACH Deposit:action=TransferFunds&method=ACH&type=DEPOSIT&currency=USDDeposit (Display all saved instructions): action=TransferFundstype=DEPOSIT&currency=USDWithdrawal (Display all saved instructions): action=TransferFundstype=WITHDRAWAL&currency=USD
Transfer Positions	ACTION=POSITION_MGMT&SID=<>
Transfer Positions	ACTION=TransferPositions&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=<>
Wire Withdrawal	ACTION=WireWithdrawals&SID=<>

If additional landing pages are needed, please send an email to dam@ibkr.com with the name of the page and a rep can provide the input parameters.