> ## Documentation Index > Fetch the complete documentation index at: https://developers.securitize.io/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > SecId API: use the sandbox base URL https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance unless the user explicitly provides production access. Authenticate with OAuth 2.0 client credentials: POST https://partners-api.sandbox.securitize.io/oauth2/token (form fields grant_type=client_credentials, client_id, client_secret, read from environment variables), cache the bearer token for its expires_in (7200 s) and send it as Authorization: Bearer on every call; never print or log the secret or the token. > Nothing is verified until POST /investors/{investorId}/verification/submit. An individual: create, upload one identity document, submit. A company: create, add its people as key parties (at least one with isBeneficialOwner: true), upload their documents, submit. > Branch on the HTTP status and the error `code`, never on `message`. A body without `code` comes from the gateway: on a 401 get a new token and send the request again; a 403 means the account is not enabled for this API. > SecId API addresses: send address.state only when that address's countryCode is US, as the 2-letter state code (NY); omit it for any other country, also when the user has a province or region. Otherwise the call answers 400 validation_error on address.state. > SecId API individuals in the US: taxId is the person's Social Security number, and it is checked against the name and residential address sent; send them as registered. A mismatch can move the investor to manual-review instead of verified. Sandbox does not run the check. > Creates are safe to repeat with the same body: after a timeout or a 502, send the identical create again. Document uploads are not: each call stores a new document, so only re-send a document after a 502. > Poll GET /investors/{investorId} about every 30 seconds, then back off; treat any status you do not recognise as not verified. In sandbox, the webhook investor.kyc.updated also announces every status change, and investor.suitability.updated / investor.dlt_test.updated every change of the suitability and DLT test verificationStatus: verify the signature, deduplicate on sourceEventId and confirm with the matching GET before acting. Token whitelisting is asynchronous too: poll GET /investors/{investorId}/wallets/whitelist until the status leaves processing. > SecId API tax forms: POST /investors/{investorId}/tax-forms takes multipart/form-data (parts file, formType, signatureDate); never base64 or JSON. Let the HTTP client set content-type with the boundary. At any point of the verification, before or after the investor is verified, only for investors you created (201), one PDF up to 10 MB per call; each upload replaces the form on file, so after a 502 send the same request again. A W-9 can instead go as JSON fields to POST /investors/{investorId}/tax-forms/w9 (TIN as 9 digits, SSN or EIN): it does not replace a form on file (409 tax_form_already_active, details.activeTaxForm), and it requires a certification object (certifiedAt, signatureName, subjectToBackupWithholding false, isUSPerson true, certificationTextVersion w9-sm-2026-10): the investor certifies in your flow on the text published at /secid-api/tax-forms#the-certification, shown without changes; subjectToBackupWithholding true answers 422 business_rule_violation (details.reason backup_withholding_not_supported). Unlike creates, a repeat after success answers 409 tax_form_already_active, not 201: when details.activeTaxForm.formType is W-9, treat it as on file. > Use synthetic test data in sandbox (@test.invalid emails, fresh ids each run). Never send more than one DLT test attempt per test investor unless the user asks: three failed attempts lock the test permanently. > The complete contract, with every field, response and error, is the OpenAPI file of the API reference; the Errors page says what to do for each code. > CET Underlying API: a WebSocket at wss://partners-rt-gw.sandbox.securitize.io/v1/market-maker/stream (TLS only; ws:// hangs with no answer). Sign hello, place_order, cancel_order and submit_crypto_funding with the user's Ed25519 key, read from an environment variable or secrets store; never print or log it. Sign timestamp + "." + type + "." + the exact payload string you send: serialise the payload once and embed that same string in the frame. > CET Underlying API: send a unique requestId of at most 32 characters (a UUID without hyphens) on every message and match replies on it; frames without a requestId are pushes. Every amount is a decimal string, never a JSON number; compare amounts as decimals. Branch on the error code, never on message. > CET Underlying API: an ack to place_order means taken, not filled. externalRef is the idempotency key; after an ack with status UNKNOWN or an UPSTREAM_UNAVAILABLE error, call get_order by externalRef before resending. Updates are delivered at most once: after any reconnect, read working orders back with get_order. Every order is placed by quantity. A buy must be a LIMIT order: quantity × limitPrice plus fees is held against your own available cash (get_cash_balance_v2), and a buy it does not cover, a MARKET buy or a notional order is refused (INVALID_ORDER). A sell must be placed by quantity, after its CETs reach the redemption wallet, or it is refused. mint_updated and burn_updated push mints and burns once they are on chain; after a gap, read them with get_mints and get_burns. The complete contract is the AsyncAPI file of the API reference. > Stocks API (Beta): documented ahead of its release through the partner gateway; paths, fields and errors can change. Base URL https://partners-api.sandbox.securitize.io/stocks/v1. Send x-api-key on every call and investorId on every call about an investor. Read the key from an environment variable; never print or log it, and never call the API from frontend code. > Stocks API: an investor can trade only once the SecId API shows them verified, with verified suitability (and a passed DLT test in the EEA), and once their wallet on the stock's chain is linked with their signature of the agreement message, signed verbatim. There is no whitelisting call: the first trade whitelists the wallet. > Stocks API: orders are fill or kill. GET /stocks/realtime-price, prepare within about 20 seconds (signedPrice), have the investor's wallet sign the returned transaction unchanged and sign-only (never send it), then submit it once with POST /stocks/execute-signed-transaction within 120 seconds. Amounts are raw base units as strings; USDC has 6 decimals. The outcome is on chain: follow transactionHash. > Stocks API: production access requires a UI audit by Securitize Compliance of the live screens: the disclosures and the market data shown, the NBBO included. > Corporate Actions API (Beta, 0.x): in development and subject to change; paths, fields, enumerations and event names can change before 1.0.0. Base URL https://partners-api.sandbox.securitize.io/corporate-actions/v1. Get a bearer token with OAuth 2.0 client credentials at POST https://partners-api.sandbox.securitize.io/oauth2/token (no scope, 2 hours), cache it, and send Authorization: Bearer on every call. Read the client id, secret and the webhook signing secret from environment variables; never print or log them, and never call the API from frontend code. > Corporate Actions API: webhooks arrive signed with the Standard Webhooks scheme under the svix-id, svix-timestamp and svix-signature headers (HMAC-SHA256 over id.timestamp.raw body, base64, v1 prefix; the secret is base64 after whsec_). Verify before parsing, reject a timestamp more than 5 minutes off, answer 2xx within 10 seconds. Delivery is at least once and can be out of order: deduplicate on sourceEventId, keep the highest version per object (objectId), order by sequence per stream.id, and replace the object with data (never merge). > Corporate Actions API: treat an unknown caType, reasonCode, eventType or enum value as informational, never as an error. A restriction ends only with ca.restriction.removed; expectedEnd is informational. marketStatus UNAVAILABLE means do not trade; the reason field carries a restriction reasonCode or a market reason such as PRE_MARKET. GET /tokens?status= filters by marketStatus (OPEN, CLOSED, UNAVAILABLE), not by the token's ACTIVE status. > Corporate Actions API: the event routes are at https://partners-api.sandbox.securitize.io/webhooks/v1 (not under /corporate-actions/v1) and cover every webhook family sent to the partner; filter with eventTypes=ca.* for corporate actions only. After an outage call POST /events/recover with since at the start of the outage (resends failed deliveries only), or page GET /events?since= (newest first, iterator paging, 90 days), then read state with GET /tokens/{tokenId}/status and GET /corporate-actions/{sourceCaId}. In sandbox, POST /sandbox/events with a scenario and one of your tokenIds publishes a scripted sequence at once; order the events by sequence, not by arrival. > Investor Activity API: base URL https://partners-api.sandbox.securitize.io/v1. Authentication is OAuth 2.0 client credentials only (no API key): POST https://partners-api.sandbox.securitize.io/oauth2/token (no scope, 2 hours), cache the token, and send Authorization: Bearer on every call. The token identifies the investor account; there is no investor id to pass. Read the client id, secret and the webhook signing secret from environment variables; never print or log them, and never call the API from frontend code. > Investor Activity API: every amount is an integer string in base units with a sibling decimals (human = amount / 10^decimals); parse with BigInt or a decimal type, never a float. Cash amounts (deposits, confirmations, payouts) are in the minor units of currencyId (1 = USD, decimals 2); token amounts (transactions, mintings, holdings) in the token's base units. Never add cash to tokens. > Investor Activity API: reconcile a subscription by grouping GET /deposits?tokenId= on tokenIssuanceId and matching the transaction in GET /transactions?tokenId= with the same tokenIssuanceId (null on a deposit means not issued yet; null on a transaction means not an issuance). Each issuance has a deposit movement (cash in) and a liquidation movement (that cash applied to the tokens) for the same amount: count the cash once, by direction=deposit, never by adding every movement. Page with offset and limit (max 100) until offset + meta.length reaches meta.total; there is no tokenIssuanceId filter. Reconcile a redemption by txHash (transfer, investor.redemption.pending, payout sourceTransaction) and by the redemption's data.id across pending, confirmed, payout.initiated and payout.completed. > Investor Activity API: webhooks arrive signed with the Standard Webhooks scheme under the svix-id, svix-timestamp and svix-signature headers (HMAC-SHA256 over id.timestamp.raw body, base64, v1 prefix; the secret is base64 after whsec_). Verify before parsing, reject a timestamp more than 5 minutes off, answer 2xx within 15 seconds. The body is {eventType, eventId, timestamp, data}: deduplicate on eventId (not svix-id), upsert by data.id, never move a record back to an earlier step, and treat an unknown eventType, processType or paymentMethod as informational. In webhooks a field with no value is absent; in endpoint answers it is null. After an outage page GET /webhook-events (newest first, iterator paging, optional eventType) back to the start of the outage. > SecId hosted onboarding: instead of the API, a partner can send an investor to https://stocks.securitize.io/partners?tokenId=&partnerUrl= (tokenAddress may replace tokenId; partnerUrl must be an absolute https URL, URL-encoded). Securitize runs identity verification, the investment profile and the wallet there. Nothing is appended to partnerUrl on return: check the wallet on chain before trading (Beta on Solana). # Sandbox only > Sandbox only: fund and withdraw your own cash. Not part of the production API. **Sandbox only.** These messages are not part of the production API: in production they answer `MALFORMED`. See [Sandbox funding](https://developers.securitize.io/cet-underlying-api/sandbox-funding.md). ## AsyncAPI ````yaml cet-underlying-api/asyncapi.yaml sandbox id: sandbox title: Sandbox only description: > Sandbox only. Not part of the production API: in production these messages answer `MALFORMED`, `unsupported type`. `sandbox_deposit` and `sandbox_withdraw` move USD into and out of your own cash, so you can fund yourself and test the cash flow end to end. Each is booked about a minute later and pushed as `cash_movement`, and `get_cash_balance_v2` and `get_cash_movements` show it. servers: - id: sandbox protocol: wss host: partners-rt-gw.sandbox.securitize.io bindings: [] variables: [] address: /v1/market-maker/stream parameters: [] bindings: [] operations: - &ref_8 id: sandboxDeposit title: Deposit cash (sandbox only) description: Sandbox only. Moves USD from Securitize into your own cash. type: receive messages: - &ref_11 id: sandbox_deposit payload: - name: sandbox_deposit description: >- Sandbox only. Moves USD from Securitize into your own cash. Signed. type: object properties: - name: type type: string description: sandbox_deposit required: true - name: requestId type: string description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. required: false - name: timestamp type: integer description: >- Unix seconds when you signed the message. Must be within 30 seconds of the server clock. required: true - name: payload type: object description: >- Sandbox only. The payload of `sandbox_deposit` and `sandbox_withdraw`. required: true properties: - name: amount type: string description: USD, greater than zero, with at most 2 decimal places. required: true - name: clientRef type: string description: >- Your own id for the request, and its idempotency key. The same `clientRef` never moves money twice, and the same `clientRef` with another amount is refused. At most 64 characters of letters, digits, `.`, `_`, `:` and `-`. required: true - name: signature type: string description: >- base58( Ed25519-Sign( privateKey, timestamp + "." + type + "." + payloadBytes ) ), over the exact bytes of `payload` as sent. required: true headers: [] jsonPayloadSchema: type: object description: Sandbox only. required: - type - timestamp - payload - signature properties: type: type: string const: sandbox_deposit x-parser-schema-id: requestId: &ref_0 type: string maxLength: 64 description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. x-parser-schema-id: RequestId timestamp: &ref_1 type: integer description: >- Unix seconds when you signed the message. Must be within 30 seconds of the server clock. x-parser-schema-id: Timestamp payload: &ref_2 type: object description: >- Sandbox only. The payload of `sandbox_deposit` and `sandbox_withdraw`. required: - amount - clientRef properties: amount: type: string format: decimal maxLength: 15 pattern: ^(?!0+(\.0+)?$)\d{1,12}(\.\d{1,2})?$ description: USD, greater than zero, with at most 2 decimal places. x-parser-schema-id: clientRef: type: string pattern: ^[A-Za-z0-9._:-]{1,64}$ description: >- Your own id for the request, and its idempotency key. The same `clientRef` never moves money twice, and the same `clientRef` with another amount is refused. At most 64 characters of letters, digits, `.`, `_`, `:` and `-`. x-parser-schema-id: x-parser-schema-id: SandboxCashRequest signature: &ref_3 type: string maxLength: 128 description: >- base58( Ed25519-Sign( privateKey, timestamp + "." + type + "." + payloadBytes ) ), over the exact bytes of `payload` as sent. x-parser-schema-id: Signature x-parser-schema-id: SandboxDepositFrame title: Sandbox_deposit description: Sandbox only. Moves USD from Securitize into your own cash. Signed. example: |- { "type": "sandbox_deposit", "requestId": "4e8b2d7f1a6c4f93b0d5e2a7c9f1b386", "timestamp": 1792998000, "payload": { "amount": "1000.00", "clientRef": "fund-2026-10-26-0001" }, "signature": "5Hd8…" } bindings: [] extensions: - id: x-parser-unique-object-id value: sandbox_deposit bindings: [] extensions: &ref_4 - id: x-parser-unique-object-id value: sandbox - &ref_9 id: sandboxWithdraw title: Withdraw cash (sandbox only) description: Sandbox only. Moves USD out of your own cash, up to your available. type: receive messages: - &ref_12 id: sandbox_withdraw payload: - name: sandbox_withdraw description: Sandbox only. Moves USD out of your own cash. Signed. type: object properties: - name: type type: string description: sandbox_withdraw required: true - name: requestId type: string description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. required: false - name: timestamp type: integer description: >- Unix seconds when you signed the message. Must be within 30 seconds of the server clock. required: true - name: payload type: object description: >- Sandbox only. The payload of `sandbox_deposit` and `sandbox_withdraw`. required: true properties: - name: amount type: string description: USD, greater than zero, with at most 2 decimal places. required: true - name: clientRef type: string description: >- Your own id for the request, and its idempotency key. The same `clientRef` never moves money twice, and the same `clientRef` with another amount is refused. At most 64 characters of letters, digits, `.`, `_`, `:` and `-`. required: true - name: signature type: string description: >- base58( Ed25519-Sign( privateKey, timestamp + "." + type + "." + payloadBytes ) ), over the exact bytes of `payload` as sent. required: true headers: [] jsonPayloadSchema: type: object description: Sandbox only. required: - type - timestamp - payload - signature properties: type: type: string const: sandbox_withdraw x-parser-schema-id: requestId: *ref_0 timestamp: *ref_1 payload: *ref_2 signature: *ref_3 x-parser-schema-id: SandboxWithdrawFrame title: Sandbox_withdraw description: Sandbox only. Moves USD out of your own cash. Signed. example: |- { "type": "sandbox_withdraw", "requestId": "9a1c6e3b7d2f4085a4c8e1b6d3f9a270", "timestamp": 1792998300, "payload": { "amount": "250.00", "clientRef": "withdraw-2026-10-26-0001" }, "signature": "2Wq7…" } bindings: [] extensions: - id: x-parser-unique-object-id value: sandbox_withdraw bindings: [] extensions: *ref_4 - &ref_10 id: sandboxReplies title: Sandbox replies description: >- Sandbox only. What the server answers to sandbox_deposit and sandbox_withdraw. type: send messages: - &ref_13 id: sandbox_deposit_ack payload: - name: ack (sandbox_deposit) description: >- Sandbox only. The deposit was requested, was requested before, was cancelled, or got no answer in time. type: object properties: - name: type type: string description: ack required: true - name: for type: string description: sandbox_deposit required: true - name: requestId type: string description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. required: false - name: traceId type: string description: >- The server's id for this exchange. Opaque; quote it when you contact Securitize. Not the `traceId` on a mint or a burn. required: true - name: sentAt type: string description: >- When the server put the message on the wire. ISO 8601, UTC, milliseconds. Not when anything happened at the broker. required: true - name: payload type: object description: >- Sandbox only. The `ack` payload of `sandbox_deposit` and `sandbox_withdraw`. required: true properties: - name: clientRef type: string description: Your `clientRef`, as you sent it. required: true - name: amount type: string required: true - name: currency type: string description: USD required: true - name: status type: string description: >- `PENDING`: requested; it is booked about a minute later. `ALREADY_REQUESTED`: this `clientRef` was asked for before; nothing new was sent. `CANCELLED`: cancelled before it was booked; nothing moved, so ask again with a new `clientRef`. `UNKNOWN`: no answer in time and it may have been requested; ask again with the same `clientRef`, which never moves money twice. enumValues: - PENDING - ALREADY_REQUESTED - CANCELLED - UNKNOWN required: true headers: [] jsonPayloadSchema: type: object description: Sandbox only. required: - type - for - traceId - sentAt - payload properties: type: type: string const: ack x-parser-schema-id: for: type: string const: sandbox_deposit x-parser-schema-id: requestId: *ref_0 traceId: &ref_5 type: string description: >- The server's id for this exchange. Opaque; quote it when you contact Securitize. Not the `traceId` on a mint or a burn. x-parser-schema-id: TraceId sentAt: &ref_6 type: string format: date-time description: >- When the server put the message on the wire. ISO 8601, UTC, milliseconds. Not when anything happened at the broker. x-parser-schema-id: SentAt payload: &ref_7 type: object description: >- Sandbox only. The `ack` payload of `sandbox_deposit` and `sandbox_withdraw`. required: - clientRef - amount - currency - status properties: clientRef: type: string description: Your `clientRef`, as you sent it. x-parser-schema-id: amount: type: string format: decimal x-parser-schema-id: currency: type: string const: USD x-parser-schema-id: status: type: string enum: - PENDING - ALREADY_REQUESTED - CANCELLED - UNKNOWN description: >- `PENDING`: requested; it is booked about a minute later. `ALREADY_REQUESTED`: this `clientRef` was asked for before; nothing new was sent. `CANCELLED`: cancelled before it was booked; nothing moved, so ask again with a new `clientRef`. `UNKNOWN`: no answer in time and it may have been requested; ask again with the same `clientRef`, which never moves money twice. x-parser-schema-id: x-parser-schema-id: SandboxCashResult x-parser-schema-id: SandboxDepositAckFrame title: ack (sandbox_deposit) description: >- Sandbox only. The deposit was requested, was requested before, was cancelled, or got no answer in time. example: |- { "type": "ack", "for": "sandbox_deposit", "requestId": "4e8b2d7f1a6c4f93b0d5e2a7c9f1b386", "traceId": "partners-rt-gw-8c3e1f6a-2d9b-4a75-b0e4-7f1c5d2a9e63", "sentAt": "2026-10-26T14:20:01.318Z", "payload": { "clientRef": "fund-2026-10-26-0001", "amount": "1000.00", "currency": "USD", "status": "PENDING" } } bindings: [] extensions: - id: x-parser-unique-object-id value: sandbox_deposit_ack - &ref_14 id: sandbox_withdraw_ack payload: - name: ack (sandbox_withdraw) description: >- Sandbox only. The withdrawal was requested, was requested before, was cancelled, or got no answer in time. type: object properties: - name: type type: string description: ack required: true - name: for type: string description: sandbox_withdraw required: true - name: requestId type: string description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. required: false - name: traceId type: string description: >- The server's id for this exchange. Opaque; quote it when you contact Securitize. Not the `traceId` on a mint or a burn. required: true - name: sentAt type: string description: >- When the server put the message on the wire. ISO 8601, UTC, milliseconds. Not when anything happened at the broker. required: true - name: payload type: object description: >- Sandbox only. The `ack` payload of `sandbox_deposit` and `sandbox_withdraw`. required: true properties: - name: clientRef type: string description: Your `clientRef`, as you sent it. required: true - name: amount type: string required: true - name: currency type: string description: USD required: true - name: status type: string description: >- `PENDING`: requested; it is booked about a minute later. `ALREADY_REQUESTED`: this `clientRef` was asked for before; nothing new was sent. `CANCELLED`: cancelled before it was booked; nothing moved, so ask again with a new `clientRef`. `UNKNOWN`: no answer in time and it may have been requested; ask again with the same `clientRef`, which never moves money twice. enumValues: - PENDING - ALREADY_REQUESTED - CANCELLED - UNKNOWN required: true headers: [] jsonPayloadSchema: type: object description: Sandbox only. required: - type - for - traceId - sentAt - payload properties: type: type: string const: ack x-parser-schema-id: for: type: string const: sandbox_withdraw x-parser-schema-id: requestId: *ref_0 traceId: *ref_5 sentAt: *ref_6 payload: *ref_7 x-parser-schema-id: SandboxWithdrawAckFrame title: ack (sandbox_withdraw) description: >- Sandbox only. The withdrawal was requested, was requested before, was cancelled, or got no answer in time. example: |- { "type": "ack", "for": "sandbox_withdraw", "requestId": "9a1c6e3b7d2f4085a4c8e1b6d3f9a270", "traceId": "partners-rt-gw-2f7a4c91-6e3d-4b08-a5c2-9d1e8b7f3a40", "sentAt": "2026-10-26T14:25:00.744Z", "payload": { "clientRef": "withdraw-2026-10-26-0001", "amount": "250.00", "currency": "USD", "status": "PENDING" } } bindings: [] extensions: - id: x-parser-unique-object-id value: sandbox_withdraw_ack - &ref_15 id: error payload: - name: error description: A request was refused. Most errors leave the socket open. type: object properties: - name: type type: string description: error required: true - name: requestId type: string description: >- Your id for this message, echoed on its reply. Never interpreted or checked for uniqueness. Up to 64 characters are accepted, but keep it to 32, since an `error` echoes only the first 32 followed by `…`. A UUID without its hyphens is 32 characters. required: false - name: traceId type: string description: >- The server's id for this exchange. Opaque; quote it when you contact Securitize. Not the `traceId` on a mint or a burn. required: true - name: sentAt type: string description: >- When the server put the message on the wire. ISO 8601, UTC, milliseconds. Not when anything happened at the broker. required: true - name: payload type: object required: true properties: - name: code type: string description: >- One of `SIGNATURE_INVALID`, `TIMESTAMP_OUT_OF_WINDOW`, `UNAUTHENTICATED`, `NOT_PERMITTED`, `RATE_LIMITED`, `MALFORMED`, `INVALID_ORDER`, `INVALID_SYMBOL`, `ORDER_NOT_FOUND`, `ORDER_NOT_CANCELLABLE`, `DEPOSIT_PENDING`, `DEPOSIT_REFUSED`, `UPSTREAM_UNAVAILABLE`, `INTERNAL`. Treat a code you do not recognise as a refusal. required: true - name: message type: string description: For people. Can change; never branch on it. required: true headers: [] jsonPayloadSchema: type: object required: - type - traceId - sentAt - payload properties: type: type: string const: error x-parser-schema-id: requestId: *ref_0 traceId: *ref_5 sentAt: *ref_6 payload: type: object required: - code - message properties: code: type: string description: >- One of `SIGNATURE_INVALID`, `TIMESTAMP_OUT_OF_WINDOW`, `UNAUTHENTICATED`, `NOT_PERMITTED`, `RATE_LIMITED`, `MALFORMED`, `INVALID_ORDER`, `INVALID_SYMBOL`, `ORDER_NOT_FOUND`, `ORDER_NOT_CANCELLABLE`, `DEPOSIT_PENDING`, `DEPOSIT_REFUSED`, `UPSTREAM_UNAVAILABLE`, `INTERNAL`. Treat a code you do not recognise as a refusal. x-parser-schema-id: message: type: string description: For people. Can change; never branch on it. x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: ErrorFrame title: Error description: A request was refused. Most errors leave the socket open. example: |- { "type": "error", "requestId": "7a02c4e158b34f9da0e23c6b1d7f8e45", "traceId": "partners-rt-gw-4d81e0a7-2c6f-4b19-9e3a-8f5d1c7b0a62", "sentAt": "2026-08-28T15:29:47.012Z", "payload": { "code": "INVALID_ORDER", "message": "The reference ref-2026-08-28-0001 already names an order (FILLED): look it up instead of placing it again" } } bindings: [] extensions: - id: x-parser-unique-object-id value: error bindings: [] extensions: *ref_4 sendOperations: - *ref_8 - *ref_9 receiveOperations: - *ref_10 sendMessages: - *ref_11 - *ref_12 receiveMessages: - *ref_13 - *ref_14 - *ref_15 extensions: - id: x-parser-unique-object-id value: sandbox securitySchemes: - id: ed25519Signature name: ed25519Signature type: asymmetricEncryption description: > Each client registers an Ed25519 public key with Securitize beforehand; the private key never leaves the client. `hello`, `place_order`, `cancel_order`, `submit_crypto_funding`, `sandbox_deposit` and `sandbox_withdraw` carry `timestamp` (Unix seconds) and `signature` = base58( Ed25519-Sign( privateKey, timestamp + "." + type + "." + payloadBytes ) ), where `payloadBytes` are the exact bytes of `payload` as sent on the wire. The timestamp must be within 30 seconds of the server clock. Other messages ride on the session `hello` opens. extensions: [] ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.