> ## 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). # Webhooks > How Securitize sends webhooks to your partner account: one endpoint for every API, signed deliveries, retries, and what your handler must do. Securitize notifies your partner account with webhooks: one `POST` per event to the HTTPS endpoint your Securitize contact registered for your account. The same endpoint receives the events of every API your account uses, so branch on `eventType`. Webhooks go to your systems, never to your investors. | API | Events | What to do with them | | - | - | - | | [SecId API](https://developers.securitize.io/secid-api/kyc-webhooks.md) | `investor.kyc.updated` | [KYC webhooks](https://developers.securitize.io/secid-api/kyc-webhooks.md) | | [SecId API](https://developers.securitize.io/secid-api/suitability-webhooks.md) | `investor.suitability.updated`, `investor.dlt_test.updated` | [Suitability webhooks](https://developers.securitize.io/secid-api/suitability-webhooks.md) | | [Corporate Actions API](https://developers.securitize.io/corporate-actions-api/events.md) | `ca.action.*`, `ca.restriction.*`, `ca.token.updated` | [Receive corporate action webhooks](https://developers.securitize.io/corporate-actions-api/receive-webhooks.md) | Every API sends the same body shape, the event envelope: ``` POST https://your.endpoint.invalid/securitize/webhooks content-type: application/json svix-id: msg_3KvohJaoccOAHQCSFLAdB7Fch6m svix-timestamp: 1792439424 svix-signature: v1,g0hM9SsE+OTPJTGt/tmIKtSyZlE3uFJELVlNIOLJ1OE= { "schemaVersion": "1.0", "sourceEventId": "...", "eventType": "...", "occurredAt": "...", "data": { ... } } ``` `sourceEventId` identifies the event, `eventType` says what happened and `data` carries it; each API adds its own fields, described on its page. ## Headers | Header | What it is | | - | - | | `svix-id` | The message id of the delivery, `msg_…`, the same on every retry of it. It is not the event id: deduplicate on `sourceEventId` in the body | | `svix-timestamp` | When the delivery was signed, Unix seconds | | `svix-signature` | One or more signatures, space-separated, each `v1,` followed by base64 | > [!NOTE] > > The headers follow the [Standard Webhooks](https://www.standardwebhooks.com) specification under the `svix-` prefix. The same headers under the `webhook-` prefix are planned; your code can read either name today, and the change will be announced in each API's changelog before it happens. ## Verify the signature Every delivery is signed with your endpoint's secret, a `whsec_` string your Securitize contact handed you once. Verify before you parse anything else. ``` signature = base64( HMAC-SHA256( secret, svix-id + "." + svix-timestamp + "." + raw body ) ) ``` * **Sign the raw bytes of the body**, exactly as received, before any JSON parsing or re-serialisation. * **Compare in constant time** against each signature in `svix-signature`: during a secret rotation the header carries two, one per secret, for 24 hours, and any one matching is enough. * **Reject a timestamp more than 5 minutes from your clock**, to stop a captured delivery being replayed later. * **The secret is base64 after the `whsec_` prefix**; decode it before using it as the HMAC key. The [Standard Webhooks libraries](https://github.com/standard-webhooks/standard-webhooks/tree/main/libraries) do all of this; they accept the `svix-` headers. By hand: ```javascript JavaScript theme={null} import { createHmac, timingSafeEqual } from 'node:crypto'; const SECRET = Buffer.from(process.env.WEBHOOK_SECRET.replace(/^whsec_/, ''), 'base64'); const TOLERANCE_SECONDS = 5 * 60; // `rawBody` is the request body as bytes: read it before any JSON middleware runs. export function verify(headers, rawBody) { const id = headers['svix-id'] ?? headers['webhook-id']; const timestamp = headers['svix-timestamp'] ?? headers['webhook-timestamp']; const signatures = headers['svix-signature'] ?? headers['webhook-signature']; if (!id || !timestamp || !signatures) return false; if (Math.abs(Date.now() / 1000 - Number(timestamp)) > TOLERANCE_SECONDS) return false; const expected = createHmac('sha256', SECRET) .update(`${id}.${timestamp}.`) .update(rawBody) .digest(); return signatures.split(' ').some((entry) => { const [version, value] = entry.split(','); if (version !== 'v1' || !value) return false; const given = Buffer.from(value, 'base64'); return given.length === expected.length && timingSafeEqual(given, expected); }); } ``` ```python Python theme={null} import base64, hmac, hashlib, os, time SECRET = base64.b64decode(os.environ["WEBHOOK_SECRET"].removeprefix("whsec_")) TOLERANCE_SECONDS = 5 * 60 def verify(headers: dict, raw_body: bytes) -> bool: """`raw_body` is the request body as received, before any JSON parsing.""" h = {k.lower(): v for k, v in headers.items()} msg_id = h.get("svix-id") or h.get("webhook-id") timestamp = h.get("svix-timestamp") or h.get("webhook-timestamp") signatures = h.get("svix-signature") or h.get("webhook-signature") if not (msg_id and timestamp and signatures): return False if abs(time.time() - int(timestamp)) > TOLERANCE_SECONDS: return False expected = hmac.new(SECRET, f"{msg_id}.{timestamp}.".encode() + raw_body, hashlib.sha256).digest() for entry in signatures.split(" "): version, _, value = entry.partition(",") if version == "v1" and value and hmac.compare_digest(base64.b64decode(value), expected): return True return False ``` A delivery that fails verification: answer `401`, log the `svix-id`, and do nothing with the body. The `svix-id` is only an input to the signature and a reference for support. Everything you key on, starting with `sourceEventId`, is in the body. ## Acknowledge within 10 seconds Any `2xx` within 10 seconds acknowledges the delivery. Anything else, or no answer, is retried with exponential backoff for up to 72 hours; after that the delivery is marked failed. Acknowledge as soon as the event is durably stored, and do the work afterwards. A handler that calls your own systems before answering is the usual cause of timeouts, and every timeout is a retry you then have to deduplicate. ## Deliveries are at least once and unordered Retries repeat an event, and deliveries run in parallel, so a later event can arrive before an earlier one. Every handler needs: * **Deduplication on `sourceEventId`.** A retry carries the same id. Store the ids you have applied and skip a repeat. * **A rule for late events.** What decides which event is newer depends on the API; its page says which field to use. ## Read back and resend Every webhook sent to your endpoint stays readable for 90 days, of every API at once, and the deliveries that failed can be resent: `GET /events`, `GET /events/{eventId}` and `POST /events/recover` at `https://partners-api.sandbox.securitize.io/webhooks/v1`, with the bearer token of your client credentials. See [Replay and recover](https://developers.securitize.io/webhook-events.md). ## Your endpoint * **HTTPS, publicly reachable**, with a certificate a public CA issued. * **Idempotent**: a retry repeats a delivery, so applying the same event twice must change nothing. * **One endpoint per environment**: sandbox and production have different secrets and different events. * **One endpoint for every Securitize webhook.** The events of every API your account uses arrive at the same endpoint; branch on `eventType`. Your Securitize contact can limit the endpoint to some event types. * **Monitoring.** An endpoint that keeps failing is disabled after days of failures. Alert on your own `5xx` rate. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.