Validate SSO Web API Session

GET

/sso/validate

GET

/sso/validate

$ curl https://api.ibkr.com/sso/validate

1 {
2   "success": {
3     "value": {
4       "AUTH_TIME": 1702580846836,
5       "CREDENTIAL": "user1234",
6       "EXPIRES": 415890,
7       "IP": "12.345.678.901",
8       "IS_FREE_TRIAL": false,
9       "IS_MASTER": false,
10       "LANDING_APP": "UNIVERSAL",
11       "LOGIN_TYPE": 2,
12       "PAPER_USER_NAME": "user1234",
13       "QUALIFIED_FOR_MOBILE_AUTH": null,
14       "RESULT": true,
15       "SF_ENABLED": false,
16       "USER_ID": 123456789,
17       "USER_NAME": "user1234",
18       "features": {
19         "bond": true,
20         "calendar": true,
21         "env": "PROD",
22         "newMf": true,
23         "optionChains": true,
24         "realtime": true,
25         "wlms": true
26       },
27       "lastAccessed": 1702581069652,
28       "region": "NJ"
29     }
30   }
31 }

Validates the current session for the SSO user.

Response

An array of objects detailing contract information.

USER_IDlong

Internal user identifier.

USER_NAMEstring

current username logged in for the session.

RESULTboolean

Confirms if validation was successful. True if session was validated; false if not.

AUTH_TIMElong

Returns the time of authentication in epoch time.

SF_ENABLEDboolean

(Internal use only)

IS_FREE_TRIALboolean

Returns if the account is a trial account or a funded account.

CREDENTIALstring

Returns the underlying username of the account.

IPstring

Internal use only. Does not reflect the IP address of the user.

EXPIRESlong

Returns the time until SSO session expiration in milliseconds.

QUALIFIED_FOR_MOBILE_AUTHboolean

Returns if the customer requires two factor authentication.

LANDING_APPstring

Used for Client Portal (Internal use only)

IS_MASTERboolean

Returns whether the account is a master account (true) or subaccount (false).

lastAccessedlong

Returns the last time the user was accessed in epoch time.

loginTypelong

Returns the login type. 1 for Live, 2 for Paper

PAPER_USER_NAMEstring

Returns the paper username for the account.

featuresobject

Returns supported features such as bonds and option trading.

regionstring

Returns the region connected to internally.

Errors

401

Unauthorized Error