> ## 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). # Suitability and the DLT test > Send the investor's suitability profile and, in the European Economic Area, their DLT knowledge test. Before an investor can hold security tokens, Securitize needs two things on top of the verification: * the **suitability**: the investor's profile — experience, finances, risk profile, experience per asset class — and your attestation that the investor reviewed Securitize's documents. Every investor needs it. * the **DLT test**: a knowledge test about distributed ledger technology. Only investors whose address is in the European Economic Area take it. Both are required to [whitelist a wallet](https://developers.securitize.io/secid-api/whitelist-a-wallet.md). Neither depends on the verification: you can send them in any investor status, for individuals and entities alike, and for an investor you have [limited access](https://developers.securitize.io/secid-api/identifiers.md#when-the-investor-already-exists) to. ``` POST /investors/{investorId}/suitability send the suitability, complete, in one call GET /investors/{investorId}/suitability its status and verdict POST /investors/{investorId}/suitability/compact an individual's compact suitability, in one call GET /investors/{investorId}/suitability/compact its status and verdict POST /investors/{investorId}/dlt-test one attempt at the DLT test GET /investors/{investorId}/dlt-test whether it applies, attempts, verdict ``` ## The suitability Collect the answers from the investor in your own flow, then send them in one call. Every field, its values and their meaning are in the [API reference](https://developers.securitize.io/api-reference/suitability-and-dlt-test/send-the-investors-suitability.md). ```bash theme={null} curl -X POST "$BASE/investors/$INVESTOR_ID/suitability" -H "Authorization: Bearer $ACCESS_TOKEN" -H "content-type: application/json" -d @suitability.json ``` ```json theme={null} { "status": "completed", "verificationStatus": "verified" } ``` **Read `verificationStatus`.** `status` only says the questionnaire is `completed`; `verificationStatus` is Securitize's verdict, the one whitelisting requires. Treat any value other than `verified` as "not verified". **It is sent once and cannot be changed.** The first complete suitability is final, whether you, another partner or the investor on Securitize sent it. A later call stores nothing and answers `200` with the current state. An invalid body answers `400` listing every field to fix, and stores nothing. ### The verdict For an individual, the answers decide the verdict in the same response, with the full suitability and the [compact one](#the-compact-suitability) alike: | `verificationStatus` | When | What to do | | - | - | - | | `verified` | The investment approach is aggressive growth, the investor could bear a loss of more than 30%, accepts that the securities may be illiquid, and is neither a licensed securities professional nor affiliated with a securities firm | Nothing more. Once the investor's own `status` is `verified`, their Securitize Markets brokerage account is approved too | | `rejected` | The investment approach is not aggressive growth, the investor could bear a loss of up to 30% only, or does not accept that the securities may be illiquid, whatever the other answers | Tell the investor: "Based on your answers, a Securitize Markets brokerage account is not available to you at this time." | | `processing` | The answers above qualify, but the investor is a licensed securities professional or affiliated with a securities firm | Wait. Securitize's compliance team reviews the account and may contact the investor; the [suitability webhook](https://developers.securitize.io/secid-api/suitability-webhooks.md) announces its decision | Securitize can change which answers lead to each verdict: act on the `verificationStatus` you receive, not on the answers you sent. An entity's suitability reads `verified` at once. ```json theme={null} { "status": "completed", "verificationStatus": "rejected" } ``` **A verdict under review or not approved.** While the full suitability is not complete and the investor's verdict is `processing` or `rejected` — from a compact suitability, or set by Securitize's compliance team — the call answers `422` with `details.reason: suitability_under_review` or `suitability_not_approved`, and stores nothing. There is nothing to resend; the webhook announces the next decision. ### The declarations The three `declarations` must be `true`. Sending them is your attestation that the investor: * was given, and reviewed, the current Securitize Markets, LLC **Subscriber Agreement**, as Securitize supplied it to you; * was given, and reviewed, the current Securitize Markets, LLC **Form CRS** (Customer Relationship Summary), as Securitize supplied it to you; * confirmed the four affirmations listed on `affirmationsConfirmed` in the API reference. Securitize supplies these documents to you under your agreement; they are not served by this API. Show them in your flow before you send the suitability. `GET …/suitability` returns your answers too, when you sent them. ## The compact suitability A shorter suitability for individuals: the part of the investor profile that a Securitize Markets brokerage account for stocks and '40 Act funds requires. Its fields are a subset of the full suitability's, with the same names and values — the risk profile, the industry questions, income, occupation, equities experience and the same `declarations` — and fields outside that set are ignored. `isPoliticallyExposedPerson` is optional here, unlike in the full suitability. Every field is in the [API reference](https://developers.securitize.io/api-reference/suitability-and-dlt-test/send-the-investors-compact-suitability.md). ```bash theme={null} curl -X POST "$BASE/investors/$INVESTOR_ID/suitability/compact" -H "Authorization: Bearer $ACCESS_TOKEN" -H "content-type: application/json" -d @compact-suitability.json ``` ```json theme={null} { "status": "completed", "verificationStatus": "verified" } ``` * **Individuals only.** An entity answers `422` with `details.reason: investor_type_not_supported`: send it the full suitability. The investor's own `status` does not need to be `verified` yet. * **The verdict** is decided as for the full suitability ([The verdict](#the-verdict)), in the same response. * **Decided once.** Once the verdict is `verified`, or the full suitability is complete, a call stores nothing and answers `200` with the current state. While the verdict is `processing` or `rejected`, a call answers `422` with `details.reason: suitability_under_review` or `suitability_not_approved`. * **Toward the full suitability.** While the verdict is `verified`, the investor can complete the full suitability later, through the API or on Securitize. `GET …/suitability/compact` answers the same `verificationStatus` as `GET …/suitability`, with `status: completed` once the investor has a verdict or a complete full suitability (after a compact suitability, `GET …/suitability` still reads `not_started`), and your answers in the compact shape while they are the ones you sent, compact or full: once the investor completes or edits them on Securitize, they are not returned. ## The DLT test Eight multiple-choice questions about distributed ledger technology. The questions and their options are on each field of the [API reference](https://developers.securitize.io/api-reference/suitability-and-dlt-test/send-an-attempt-at-the-dlt-test.md): show them to the investor in that order, and send the letter of the option they chose (`a` to `d`). **Who takes it.** Investors whose address is in the European Economic Area (the EU countries plus Iceland, Liechtenstein and Norway): the residential address of an individual, the registered address of an entity. `GET …/dlt-test` tells you with `required`. For anyone else, an attempt answers `422` and counts nothing. ```bash theme={null} curl -X POST "$BASE/investors/$INVESTOR_ID/dlt-test" -H "Authorization: Bearer $ACCESS_TOKEN" -H "content-type: application/json" -d @dlt-attempt.json ``` ```json theme={null} { "status": "failed", "required": true, "attemptsUsed": 1, "attemptsRemaining": 2, "verificationStatus": "none" } ``` * **All eight answers must be correct** to pass. The response never says which were wrong. * **Three attempts per investor, then locked.** Attempts are shared with every partner and with the investor's own attempts on Securitize. After the third failed attempt the test is locked and cannot be retaken through the API: further attempts answer `422` with `details.reason: dlt_test_locked`. Contact Securitize. * An invalid body (`400`) does not use an attempt. Once passed, further attempts change nothing. `verificationStatus` on the DLT test is the investor's EU suitability: `verified` once the test is passed **and** the suitability is complete, in either order. | `status` | Meaning | | - | - | | `not_started` | No attempt yet | | `failed` | The last attempt failed; `attemptsRemaining` says how many are left | | `passed` | Passed | | `locked` | Three attempts failed. It cannot be retaken through the API | Securitize's compliance team can change either verdict after a review. [Suitability webhooks](https://developers.securitize.io/secid-api/suitability-webhooks.md) tell you every time a `verificationStatus` changes, whoever changed it. ## In sandbox The suitability behaves as in production. For the DLT test you can exercise failed attempts and the lock, on a fresh investor with an address in the EEA each time. To test with an investor that has passed, ask Securitize for one. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.