API ReferencePre Trade Compliance Restrictions

Verify PTC CSV

View as MarkdownOpen in Claude
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`

Headers

AuthorizationstringRequired

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

Request

JSON body containing userName, requestId, and Base64-encoded CSV payload. Do not include masterAcctId.

userNamestringRequired>=1 character
IBKR username.
requestIdlongRequired
Unique request identifier.
payloadstringRequiredformat: "byte"

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

isEmpTrackstringOptional

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
Indicates whether the operation succeeded.
requestIdlong

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

messagestring or map from strings to any

OK on success. On failure, either a plain string describing the error or a JSON object for structured bridge validation errors.