API ReferencePre Trade Compliance Restrictions

Get Restriction IDs For A User

View as MarkdownOpen in Claude
Returns all restriction IDs for the given username. The username must be the master user, a sub-user, or a user with trading access under the master account. Returns 403 for both unauthorized and non-existent users to prevent ID enumeration.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`

Headers

AuthorizationstringRequired

RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an accountId claim identifying the master account. A missing or invalid token returns HTTP 401.

Query parameters

masterUserNamestringRequired<=64 characters
IBKR master username of the authenticated caller. Max 64 characters.
userNamestringRequired<=64 characters
Username to query. Max 64 characters.
isEmpTrackstringOptional

Set to T for employer-track authorization.

Response

Restriction IDs for the user.
statusstring

Always ok on success.

userNamestring

Echoed from the request. If the supplied userName was an alias, the alias is returned as-is.

restrictionIdslist of longs
Restriction IDs for the user. Empty array when none.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error