Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

preTradeComplianceRestrictions

Verify PTC CSV

Validates CSV content without applying changes. Must be called before /csv/v2/apply with the same requestId.

The master account identity is resolved from the accountId claim in the Authorization header JWT. Do not include masterAcctId in the request body.

A missing or invalid Authorization header does not return HTTP 401. The request proceeds and fails at validation with success: false, message: "Master account not specified and not emp track" unless isEmpTrack: T is set in the body.<br><br>Scope: restrictions.write<br>Security Policy: Signed JWT

post/gw/api/v1/restrictions/verify

Headers

Authorizationstring required

RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an accountId claim identifying the master account.

Request body

userNamestring required

IBKR username.

requestIdinteger required

Unique request identifier.

payloadstring byte required

Base64-encoded CSV content. Supported operations: RESTR_ADD, RESTR_DELETE, RESTR_ASSOC_ADD, RESTR_ASSOC_DELETE.

isEmpTrackstring

Set to T for employer-track authorization.

Response

Always HTTP 200. Inspect the success field to determine the outcome. All failure conditions — authentication, authorization, validation, and internal errors — return success: false.

successboolean required

Indicates whether the operation succeeded.

requestIdinteger

Echoed from the request. Absent only on early apply failures (inactive body token, missing payload) where the requestId has not yet been parsed.