API ReferencePre Trade Compliance Restrictions

Apply PTC CSV

View as MarkdownOpen in Claude
Applies previously verified CSV changes. Requires two tokens: **Authorization header** — RS256-signed JWT containing an `accountId` claim, used to identify the master account. A missing or invalid token does not return HTTP 401; the request proceeds and fails at validation with `success: false`. **Request body** — a separate RS256-signed JWT (validity: 1 minute) whose payload contains the request claims (`userName`, `requestId`, `payload`, and optionally `isEmpTrack`). The `requestId` must match a prior successful `/csv/v2/verify` call. Failures that occur before the body JWT payload is parsed (inactive token, missing payload) return `success: false` without a `requestId` field.<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. Separate from and additional to the JWT in the request body.

Request

RS256-signed JWT (validity: 1 minute) whose payload contains userName, requestId, payload (Base64-encoded CSV), and optionally isEmpTrack. The requestId must match a prior successful /csv/v2/verify call. Distinct from the Authorization header JWT.

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.