> ## 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=<stock token id>&partnerUrl=<return URL> (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).

# Reads over HTTP

> Read orders, mints, burns, cash, crypto funding and your redemption balance with a signed GET, without opening a session.

The reads below are also served as `GET` requests, for when you want to ask once or poll instead of holding a socket open: checking your redemption balance after a transfer, or reading back an order. Each one answers what the matching message answers on the socket, from the same data.

Everything else stays on the socket: placing and cancelling orders, `submit_crypto_funding`, the pushes, `get_symbols` and `get_redemption_address`.

## Endpoint

| Environment | Base URL |
| - | - |
| Sandbox | `https://partners-rt-gw.sandbox.securitize.io` |

## Routes

| Request | Same as | Query parameters |
| - | - | - |
| `GET /v1/market-maker/redemption-balance` | [`get_redemption_balance`](https://developers.securitize.io/cet-underlying-api/reference/orders) | `symbol`, `chainId` |
| `GET /v1/market-maker/redemption-balances` | [`get_redemption_balances`](https://developers.securitize.io/cet-underlying-api/reference/orders) | `symbol`, `chainId`, both optional |
| `GET /v1/market-maker/order` | [`get_order`](https://developers.securitize.io/cet-underlying-api/reference/orders) | `orderId` or `externalRef`; `include` |
| `GET /v1/market-maker/mints` | [`get_mints`](https://developers.securitize.io/cet-underlying-api/reference/mints-and-burns) | `memo`, `traceId`, `txHash`, `regulatoryId`, `symbol`, `limit` |
| `GET /v1/market-maker/burns` | [`get_burns`](https://developers.securitize.io/cet-underlying-api/reference/mints-and-burns) | `memo`, `traceId`, `txHash`, `regulatoryId`, `symbol`, `limit` |
| `GET /v1/market-maker/cash-balance` | [`get_cash_balance_v2`](https://developers.securitize.io/cet-underlying-api/reference/positions-and-cash) | None |
| `GET /v1/market-maker/cash-movements` | [`get_cash_movements`](https://developers.securitize.io/cet-underlying-api/reference/positions-and-cash) | `limit`, `before` |
| `GET /v1/market-maker/crypto-funding` | [`get_crypto_funding`](https://developers.securitize.io/cet-underlying-api/reference/positions-and-cash) | None |

* **The query parameters are the message's payload fields**, with the same names, rules and defaults. A parameter that is not one of them is ignored.
* **`include` takes several values** repeated (`include=fills&include=mints`) or comma-separated (`include=fills,mints`).
* **The body of a `200` is the `payload` of the matching `ack`**, with nothing around it:

```bash theme={null}
GET /v1/market-maker/redemption-balance?symbol=AAPL&chainId=196
```

```json theme={null}
{ "symbol": "AAPL", "chainId": 196, "deposited": "25", "burned": "10", "reserved": "5", "available": "10" }
```

## Signing

There is no session, so every request is signed, with the same key you sign `hello` with. A read-only key is enough. Three headers carry it:

| Header | Value |
| - | - |
| `x-public-key` | Your public key, base58 |
| `x-timestamp` | Unix seconds, within 30 seconds of the server clock |
| `x-signature` | The signature below, base58 |

```
signature = base58( Ed25519-Sign( privateKey,
                                  timestamp + "." + method + "." + target ) )
```

* **`target` is the path and query exactly as you send them**, starting with `/`: `/v1/market-maker/cash-movements?limit=20`. Encode the query first, then sign the encoded string and send that same string. A client library that re-encodes the URL after you sign it, or a value with a space, a `+` or a `&` left unencoded, makes the signature fail. This is the most common way a signed request fails.
* **`method` is `GET`**, in capitals.
* The query is part of what is signed, so a signature cannot be reused with other parameters. Anyone holding a signed request can repeat it for 30 seconds, though: don't log or share signed requests.

```javascript JavaScript theme={null}
// npm install @noble/ed25519 bs58   (Node 18 or later, for fetch)
import * as ed from '@noble/ed25519';
import bs58 from 'bs58';

const BASE_URL = 'https://partners-rt-gw.sandbox.securitize.io';
const privateKey = bs58.decode(process.env.CET_SIGNING_KEY).slice(0, 32);
const publicKey = bs58.encode(await ed.getPublicKeyAsync(privateKey));

async function signedGet(path, params = {}) {
  // Encoded once: the same string is signed and sent.
  const query = new URLSearchParams(params).toString();
  const target = query ? `${path}?${query}` : path;
  const timestamp = Math.floor(Date.now() / 1000);
  const signed = new TextEncoder().encode(`${timestamp}.GET.${target}`);
  const signature = bs58.encode(await ed.signAsync(signed, privateKey));

  const response = await fetch(BASE_URL + target, {
    headers: { 'x-public-key': publicKey, 'x-timestamp': String(timestamp), 'x-signature': signature },
  });
  return { status: response.status, body: await response.json() };
}

console.log(await signedGet('/v1/market-maker/redemption-balance', { symbol: 'AAPL', chainId: 196 }));
```

```python Python theme={null}
# pip install requests pynacl base58
import os, time
from urllib.parse import urlencode

import base58
import requests
from nacl.signing import SigningKey

BASE_URL = "https://partners-rt-gw.sandbox.securitize.io"
signing_key = SigningKey(base58.b58decode(os.environ["CET_SIGNING_KEY"])[:32])
public_key = base58.b58encode(bytes(signing_key.verify_key)).decode()


def signed_get(path, params=None):
    query = urlencode(params or {})  # encoded once: the same string is signed and sent
    target = f"{path}?{query}" if query else path
    timestamp = int(time.time())
    signature = base58.b58encode(signing_key.sign(f"{timestamp}.GET.{target}".encode()).signature).decode()
    response = requests.get(
        BASE_URL + target,
        headers={"x-public-key": public_key, "x-timestamp": str(timestamp), "x-signature": signature},
    )
    return response.status_code, response.json()


print(signed_get("/v1/market-maker/redemption-balance", {"symbol": "AAPL", "chainId": 196}))
```

## Errors

A request that fails answers the same `code` and `message` the socket would, and a `traceId` to quote when you contact Securitize. It also comes in the `x-correlation-id` header:

```json theme={null}
{
  "code": "INVALID_SYMBOL",
  "message": "TSLA is not tradable on chain 196 for this customer — get_symbols lists what is",
  "traceId": "partners-rt-gw-4d81e0a7-2c6f-4b19-9e3a-8f5d1c7b0a62"
}
```

| Status | `code` | Meaning |
| - | - | - |
| `400` | `MALFORMED`, `INVALID_SYMBOL` | A query parameter breaks its rule, or the symbol and chain are not ones you can trade |
| `401` | `MALFORMED` | A header is missing, or `x-timestamp` is not whole Unix seconds |
| `401` | `SIGNATURE_INVALID` | The signature does not verify, or the key is not registered or no longer active. The two are not distinguished: check that you sign the exact target you send |
| `401` | `TIMESTAMP_OUT_OF_WINDOW` | Your clock is more than 30 seconds off. Fix NTP |
| `404` | `ORDER_NOT_FOUND` | No such order on your account |
| `429` | `RATE_LIMITED` | Too many requests from your address. Retry after a pause |
| `503` | `UPSTREAM_UNAVAILABLE` | The key or the data could not be read at that moment. Retry with backoff |
| `500` | `INTERNAL` | A fault on Securitize's side. Retry with backoff; if it persists, contact Securitize with the `traceId` |

Branch on `code`, as on the socket; [Errors](https://developers.securitize.io/cet-underlying-api/errors.md) says what to do about each one.

## Limits

Requests are limited per source address, across every route together. Poll at the pace you need the answer, not faster: a balance checked every few seconds after a transfer stays well inside the limit. Past it, requests answer `429` until the count resets, a second or a minute later.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.