> ## 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). # Track, cancel and reconcile orders > Follow orders on the stream, recover after a disconnect, settle an UNKNOWN, cancel, and read executions and trades. Four pushes say what happens to your orders and their CETs, and one read says where an order stands whatever the pushes delivered. | Message | What it is | When | | - | - | - | | `order_updated` | The order as it stands: a snapshot, not a delta | Pushed once per change: accepted, partially filled, filled, cancelled, expired | | `trade_updated` | One execution, as a ledger row with amounts and settlement date | Pushed once per execution | | `mint_updated`, `burn_updated` | A mint or a burn, with the shape `get_mints` and `get_burns` return | Pushed once the CETs are on chain, or gone. A mint is usually pushed up to three times, its `txHash` arriving in a later push; a burn again only when the executions behind it complete later. Apply each by overwriting the one with the same `traceId` | | `get_order` | The order as it stands now, with its mints and burns, and its executions on request | When you ask | ## The stream is not a record **Updates are delivered at most once, and nothing is queued for a socket that is not open.** There is no backlog and no replay on reconnect: an update sent while you were disconnected is gone. `get_order` is what tells you where an order stands. A push carries no `requestId`: that is how you tell it from a reply. Two `order_updated` frames for one order can arrive close together; `occurredAt`, the broker's time for the change, orders them. `order_updated` leaves out `orderType`, `timeInForce`, `limitPrice`, `fills`, `mints`, `burns`, `fees` and `feeTotal`; `get_order` returns them. ## After a disconnect 1. Reconnect with backoff and open a new session. 2. For every order you hold as not finished, send `get_order` by `orderId`. 3. Update your state from `status` and `leavesQuantity`. 4. For orders that filled while you were away, read their CETs: each `get_order` answer carries `mints` and `burns`, or ask `get_mints` and `get_burns` by `regulatoryId`. ```json theme={null} { "type": "get_order", "requestId": "e4404b2d7c9a4e158f3b1a6d0c5e9b72", "payload": { "orderId": "3396877" } } ``` ## When an order is UNKNOWN An `ack` with `status: UNKNOWN` means the broker never acknowledged the order. Before answering, the service already looked for it by your reference for a few seconds, and answers `ACCEPTED` if it turns up. What reaches you as `UNKNOWN` either does not exist or took longer to appear. You have no `orderId`, so look it up by `externalRef`: ```json theme={null} { "type": "get_order", "requestId": "e4417d3e1b8f4a269c045e2a7f6b3d81", "payload": { "externalRef": "ref-2026-09-01-0001" } } ``` | Answer | Meaning | What to do | | - | - | - | | `ack` with the order | The order exists | Carry on with its `orderId`. **Do not resend** | | `error` `ORDER_NOT_FOUND` | The broker has no order under that reference | Resend the identical `place_order`, same `externalRef`. It stays safe even if the read was behind: a reference the broker has seen is refused, never duplicated | Do the same after an `error` with `UPSTREAM_UNAVAILABLE`: the broker could not be reached and the order's fate is unknown. `get_order` takes exactly one of `orderId` or `externalRef`; both, or neither, is refused. An order on another account answers `ORDER_NOT_FOUND`, like one that does not exist. ## Cancel an order `cancel_order` is a request, not a deletion: it can arrive after the order has filled. The `ack` says whether the request was taken; the outcome arrives as `order_updated`. ```json theme={null} { "type": "cancel_order", "requestId": "b19f3a7c6e2d4f81a5b09c4e7d1f2a38", "timestamp": 1787900140, "payload": { "orderId": "3396877" }, "signature": "Lm4x…" } ``` | Answer | Meaning | What to do | | - | - | - | | `ack` `PENDING_CANCEL` | Taken; the venue has not confirmed yet | Wait for `order_updated`: `CANCELLED`, or `FILLED` if the fill came first | | `ack` `REJECTED` | Refused; `message` says so | Read the order | | `ack` `UNKNOWN` | Never acknowledged; the cancellation may or may not be in flight | Read the order with `get_order` instead of asking again | | `error` `ORDER_NOT_CANCELLABLE` | The order's state does not allow it: already filled or cancelled | Read the order | `leavesQuantity` of zero means nothing is left to cancel. In sandbox every order fills at once, so every cancellation answers `ORDER_NOT_CANCELLABLE`. ## Executions `executedQuantity` says how much filled, not in how many pieces, at what prices or when. Ask for the executions with `include`: ```json theme={null} { "type": "get_order", "requestId": "e442c1f08a3d4b579e264f1d7b0c3a89", "payload": { "orderId": "3401509", "include": ["fills"] } } ``` ```json theme={null} "fills": [ { "executionId": "3401509RQDCU2", "sequence": 2, "quantity": "100", "price": "316.85", "amount": "31685.00", "executedAt": "2026-09-02T12:04:38.192Z", "type": "NEW", "effective": true } ] ``` * **Ask only when you need them.** A large order can have a hundred executions. Without `include` the field is absent, which is not the same as an empty list: an empty list means you asked and nothing has executed yet. * **`sequence` starts at 2, not 1.** Nothing is missing: the broker numbers an order's first execution 2, and the number is part of `executionId`. * **A busted execution stays in the list** with `effective: false` and the broker's word in `type`. The effective executions sum to `executedQuantity`; keep the others for the audit trail. Branch on `effective`, not on `type`. * `price` is what one execution filled at; the order's `executedPrice` is the average across all of them. ## Trades `trade_updated` is the same executions seen from the broker's ledger, where fees and settlement live. * **Deduplicate on `tradeId`.** Treat it as an opaque string: it is not a dense sequence, so a gap in it does not mean a missing trade. * **Join to the order** on `orderRegulatoryId` = the order's `regulatoryId`. It is absent on a ledger row that carries no order reference. * **Order by `executedAt`, never by arrival or `occurredAt`.** Executions of one order arrive out of order, and the broker records an order's executions in one batch with the same `occurredAt`. * **`price` is the broker's figure**, not `grossAmount` divided by `quantity`. Amounts carry the ledger's signs, which do not follow the trade's direction: `side` says which way it went. * **A correction is a new frame** with `brokerStatus` `C`, not a change to the first one. * **Settlement is never pushed.** `settled` is `false` on arrival and no frame updates it. Use `settleDate`, and read [cash](https://developers.securitize.io/cet-underlying-api/positions-and-cash.md) on or after that date. ## When the quantities do not add up Every quantity is the broker's arithmetic, passed through unchanged. If `quantity`, `executedQuantity` and `leavesQuantity` do not reconcile (for example, more executed than ordered), do not act on the order: treat it as a fault, stop, and contact Securitize with the `traceId`. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.