> ## 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).

# Trade a stock

> Get a real-time price, prepare the order, have the investor sign it, and submit it.

Buying and selling follow the same four steps; only the contract address and the amount field differ. Orders are **fill or kill**: they execute in full at the priced level or better, or not at all.

```
1. GET  /stocks/realtime-price                  → price + signedPrice
2. POST /stocks/{on-ramp|off-ramp}/{contract}…  → transaction to sign
3.      the investor's wallet signs it            no Securitize call
4. POST /stocks/execute-signed-transaction      → transactionHash
```

| | Buy | Sell |
| - | - | - |
| `side` on the price | `on-ramp` | `off-ramp` |
| Prepare path | `/stocks/on-ramp/{buy contract address}/prepare-execute-transaction` | `/stocks/off-ramp/{sell contract address}/prepare-execute-transaction` |
| Amount field | `liquidityAmount`: USDC to spend | `assetAmount`: stock tokens to sell |
| `minOutputAmount` | Fewest stock tokens accepted | Least USDC accepted |

The examples use `$BASE` for the [base URL](https://developers.securitize.io/stocks-api/sandbox-and-auth.md#base-url) and a stock token with 9 decimals. Your Securitize contact gives you each stock's contract addresses, `tokenId` and decimals ([Amounts and assets](https://developers.securitize.io/stocks-api/amounts-and-assets.md)).

## 1. Get a real-time price

```bash theme={null}
curl "$BASE/stocks/realtime-price?investorId=6b31c0e9a4f2d17e85c3b904&symbol=AAPL&side=on-ramp&amount=1000000000" \
  -H "x-api-key: $STOCKS_API_KEY"
```

```json theme={null}
{
  "symbol": "AAPL/USD",
  "bestBid": "231.220000000000000000",
  "bestAsk": "231.250000000000000000",
  "lastPrice": "231.240000000000000000",
  "marketStatus": "OPEN",
  "reason": null,
  "validFrom": "2026-10-16T14:17:40.118Z",
  "validUntil": "2026-10-16T14:17:42.118Z",
  "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl"
}
```

* **Show it on the order ticket and the confirmation screen**, with its venues ([Prices and market data](https://developers.securitize.io/stocks-api/prices-and-market-data.md)).
* **Fetch it on a fixed cadence while the ticket is open**, not on every keystroke: each investor can make one call a second and sixty an hour, and the same again to prepare and to submit.
* **Two expiries, two jobs.** `validUntil` is how long the quote itself is current, about 2 seconds: refresh what you show by then. `signedPrice` is what the order is checked against: it expires about 20 seconds after it is issued, and the order is priced at the quote it signed. Prepare the order within those 20 seconds.
* **`marketStatus` `UNAVAILABLE` means no trading now.** `CLOSED` is pre-market or post-market and can be traded. See [Market status](https://developers.securitize.io/stocks-api/market-status.md).

## 2. Prepare the order

A buy: spend 1,000 USDC at a best offer of 231.25, accepting 0.5% slippage, so at least 4.3027 tokens ([how to work that out](#working-out-minoutputamount)).

```bash theme={null}
curl -X POST "$BASE/stocks/on-ramp/BuyCtr7nQ2vXcR8yLmB3hW9sJdE6aK1uNqG5tYpC2rVx/prepare-execute-transaction" \
  -H "x-api-key: $STOCKS_API_KEY" -H "content-type: application/json" -d '{
  "investorId": "6b31c0e9a4f2d17e85c3b904",
  "signedPrice": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzeW1ib2wiOiJBQVBML1VTRCJ9.c2lnbmF0dXJl",
  "slippageBps": "50",
  "liquidityAmount": "1000000000",
  "minOutputAmount": "4302702702"
}'
```

A sell sends `assetAmount` instead of `liquidityAmount`, to the stock's sell contract address.

```json theme={null}
{
  "unsignedTransaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA…",
  "additionalData": { "anchorPrice": "231250000000000000000", "operator": "Gp3ratorRoutr9sXcR8yLmB3hW9sJdE6aK1uNqG5tYpC" }
}
```

The transaction is built for the investor's linked wallet, with the signed price and the swap already in it, and Securitize's signature on it. Securitize pays its network fee. If this is the investor's first trade in the stock, it also whitelists their wallet for it.

Things that commonly go wrong:

* **`EXPIRED_PRICE`**: the signed price expired, or the market moved since the quote. Fetch a new price, show it, and prepare again.
* **`minOutputAmount` is the investor's protection**, and the bound enforced on chain: below it, the trade reverts and nothing moves. See [below](#working-out-minoutputamount).
* **`INVALID_AMOUNT`**: an amount is not positive, has more decimals than the token allows, or the order's value is outside the per-order limits.
* **`MAX_POSITION`**: a buy would take the investor's position in the stock over its limit.
* **Use the right contract address.** A stock has one for buying and one for selling; the wrong one answers `SYMBOL_NOT_FOUND`.

### Working out `minOutputAmount`

Work it out in whole units from the quote the investor accepted and their slippage, then convert to base units, rounding down. USDC has 6 decimals; the stock token's come from your Securitize contact.

| Order | `minOutputAmount` in whole units | Then, to base units |
| - | - | - |
| Buy | `liquidityAmount ÷ 10^6 ÷ bestAsk × (1 − slippageBps ÷ 10,000)` stock tokens | × `10^tokenDecimals` |
| Sell | `assetAmount ÷ 10^tokenDecimals × bestBid × (1 − slippageBps ÷ 10,000)` USDC | × `10^6` |

| Example | Whole units | `minOutputAmount` |
| - | - | - |
| Buy 1,000 USDC at a best offer of 231.25, 50 bps | 1,000 ÷ 231.25 × 0.995 = 4.302702… tokens | `"4302702702"` (9 decimals) |
| Sell 2 tokens at a best bid of 231.22, 50 bps | 2 × 231.22 × 0.995 = 460.1278 USDC | `"460127800"` |

Skipping the conversion leaves a buy's floor 10^(tokenDecimals − 6) times too low (a thousand times for a 9-decimal token), and the slippage protection goes with it. Use decimal arithmetic, never floating point. `slippageBps` itself is recorded with the order.

## 3. The investor signs

Relay `unsignedTransaction` to your frontend and have the investor's wallet **sign** it, **unchanged**. With a Solana wallet, for example:

```javascript theme={null}
import { VersionedTransaction } from '@solana/web3.js';

const tx = VersionedTransaction.deserialize(Buffer.from(unsignedTransaction, 'base64'));
const signed = await wallet.signTransaction(tx);           // sign only: never send it from the wallet
const signedTransaction = Buffer.from(signed.serialize()).toString('base64');
```

* **Never modify it.** It carries a signed price and a validated swap instruction; any change invalidates it on chain and the trade reverts.
* **Sign, do not send.** Securitize broadcasts the transaction: that is what makes it an order executed by Securitize Markets. Use the wallet's sign-only call, never sign-and-send.
* **This signature is the order.** It is the investor's acceptance at the price and terms on your confirmation screen, which is why that screen carries the price, the amounts and the best execution acknowledgement.

## 4. Submit it

Within 120 seconds of the prepare:

```bash theme={null}
curl -X POST "$BASE/stocks/execute-signed-transaction" -H "x-api-key: $STOCKS_API_KEY" -H "content-type: application/json" -d '{
  "investorId": "6b31c0e9a4f2d17e85c3b904",
  "signedTransaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA…",
  "tokenId": "3f7b2c1e-9d4a-4e6b-8a1f-5c2d0e9b7a46"
}'
```

```json theme={null}
{ "transactionHash": "4ZkPfQ7nT2vXcR8yLmB3hW9sJdE6aK1uNqG5tYpC2rVxF8bH7jS3mD9wL6eA1zQ4oU5iT2nR8yK3cX7vB1mP" }
```

The order is firm and broadcast. Follow the transaction on chain by its hash: confirmed means executed and settled; reverted means nothing moved, and the investor places a new order.

* **Submit each prepared transaction once.** A second submission of the same one answers `409 TRADE_IN_PROGRESS`, or `400 UNAVAILABLE_MARKET` once the first has been taken. Never resubmit to find out what happened: read the chain.
* **After 120 seconds**, the transaction can no longer be submitted (`UNAVAILABLE_MARKET`). Prepare it again, with a new price.
* **`tokenId` must be the stock the order was prepared for.**

## What happens on chain

The Securitize router program checks Securitize's signature and the investor's, that the price has not expired and is still acceptable, and that the fill meets `minOutputAmount`. It then fills the order against the market maker and moves both assets, in the same transaction. There is no separate clearing or settlement cycle: delivery versus payment, atomically, the same day. If any check fails, the transaction reverts and nothing moves.

Three moments, each with its own record:

| Moment | What it is |
| - | - |
| The investor signs | Acceptance of the order, against a price with a hard expiry |
| Securitize broadcasts | The order becomes firm and routed |
| The swap confirms on chain | The execution, which drives trade reporting |


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