> ## 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). # Create an individual investor > Creates the person you are onboarding. Call it first; every other operation on the investor takes the `investorId` it returns, so **store it** against your own record. The body carries no documents, and nothing here starts a verification. On a `201`, `status` is `none` and stays `none` until you submit the investor with `POST /investors/{investorId}/verification/submit`. Next: upload the person's identity document with `POST /investors/{investorId}/documents`. Branch on the status code, not only on the body: - `201` — the investor was created, or this request repeats its create exactly (see below). Next: upload the identity document. - `200` — `{ investorId, externalInvestorId, status }`: this person is already registered with Securitize and another party leads the verification. Store `investorId`; `status` is the current one and may already be `verified`. You have **limited access**: you can read its `status` and manage its wallets, token whitelisting, suitability and DLT test; corrections, documents, submit and `include` answer `409 investor_not_owned`. **Repeatable with the same body.** Sending the same create again — the same `externalInvestorId`, email and data as last stored (by the create or a later correction) — answers `201` with the same `investorId` and the investor's current `status`. It also finishes a registration that a `502` left incomplete. A different body for the same `externalInvestorId` answers `409 external_investor_id_conflict` with the `investorId` in `details`: use `PUT /investors/individual/{investorId}` to change data. `taxId` with `taxCountry` identifies the person: a create carrying the tax identity of an investor you already created, under another `externalInvestorId`, answers `409 external_investor_id_conflict` with that investor's `investorId`. Submit as soon as the documents are complete. ## OpenAPI ````yaml /secid-api/openapi.yaml post /investors/individual openapi: 3.1.0 info: title: SecId API version: 1.0.0 description: > Onboard investors you have already KYC'd. Securitize accepts your identity verification instead of repeating it, and runs sanctions and PEP screening on top; a screening flag is reviewed by Securitize compliance, not rejected automatically. Both journeys follow the same steps: create the investor (an individual, or a company with the people and companies it is verified through, its key parties), upload their documents, submit, and poll for the verdict. Every path that names an investor takes the `investorId` Securitize returns, not your own id; `GET /investors?externalInvestorId=…` finds it by yours. The guides on the developer portal explain the flow, the states and the error handling in depth. servers: - url: >- https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance description: Sandbox security: - OAuth2: [] tags: - name: Authentication description: > Exchange your client id and secret for the bearer token every other operation takes. - name: Individuals description: > Create and correct a natural person you are onboarding. Nothing is under review until you submit the investor. - name: Entities description: > Create and correct the company being onboarded. A company is never screened on its own: it is verified through its key parties once you submit it. - name: Key parties description: > The natural persons (beneficial owners, shareholders, signers) and the companies (corporate shareholders) an entity is verified through. People are screened; companies are recorded and reviewed by Securitize compliance. - name: Documents description: > Identity documents for an individual investor or a person key party; company documents for a company key party or for the entity itself. One document per call, base64 inside JSON. Documents never start a verification. - name: Verification description: >- Hand an investor to verification. For an entity, with all of its key parties in one call. - name: Lookup description: > Read an investor's status and data back, and recover an `investorId` you no longer have. - name: Wallets description: > Register the blockchain addresses an investor holds, and list the ones you registered. You vouch that the investor controls each address; registering alone does not let a wallet receive tokens. - name: Suitability and DLT test description: > Send the investor's suitability profile and, for investors in the European Economic Area, their attempts at the DLT knowledge test. A verified suitability is what token whitelisting requires. An individual can send the compact suitability instead: the part that a Securitize Markets brokerage account for stocks and '40 Act funds requires. - name: Token whitelisting description: > Whitelist an investor's EVM wallet on a token enabled for your account, so it can receive and hold that token, and follow its status. - name: Tax forms description: > Send an investor's tax form, at any point of the verification, so it is on file for the withholding on the investor's distributions: the W-9, W-8BEN or W-8BEN-E the investor signed, as a PDF in `multipart/form-data`, or the fields of a W-9 as JSON. - name: Webhooks description: > What Securitize POSTs to the endpoint your Securitize contact registered for you: one event per request, signed with your endpoint's secret. Available in sandbox. paths: /investors/individual: post: tags: - Individuals summary: Create an individual investor description: > Creates the person you are onboarding. Call it first; every other operation on the investor takes the `investorId` it returns, so **store it** against your own record. The body carries no documents, and nothing here starts a verification. On a `201`, `status` is `none` and stays `none` until you submit the investor with `POST /investors/{investorId}/verification/submit`. Next: upload the person's identity document with `POST /investors/{investorId}/documents`. Branch on the status code, not only on the body: - `201` — the investor was created, or this request repeats its create exactly (see below). Next: upload the identity document. - `200` — `{ investorId, externalInvestorId, status }`: this person is already registered with Securitize and another party leads the verification. Store `investorId`; `status` is the current one and may already be `verified`. You have **limited access**: you can read its `status` and manage its wallets, token whitelisting, suitability and DLT test; corrections, documents, submit and `include` answer `409 investor_not_owned`. **Repeatable with the same body.** Sending the same create again — the same `externalInvestorId`, email and data as last stored (by the create or a later correction) — answers `201` with the same `investorId` and the investor's current `status`. It also finishes a registration that a `502` left incomplete. A different body for the same `externalInvestorId` answers `409 external_investor_id_conflict` with the `investorId` in `details`: use `PUT /investors/individual/{investorId}` to change data. `taxId` with `taxCountry` identifies the person: a create carrying the tax identity of an investor you already created, under another `externalInvestorId`, answers `409 external_investor_id_conflict` with that investor's `investorId`. Submit as soon as the documents are complete. operationId: createIndividualInvestor requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IndividualInvestorRequest' examples: individual: summary: A person, required fields and a middle name value: externalInvestorId: ind-test-0001 investorType: individual email: kyc.sandbox+ind0001@test.invalid firstName: Test_Jane middleName: Sample lastName: Investor dateOfBirth: '1990-04-12' birthCountry: US taxId: 123-45-6780 taxCountry: US phone: code: '1' number: '5550100001' address: street: Test Street houseNumber: '1' city: New York state: NY countryCode: US postalCode: '10001' responses: '200': description: > The person is already registered with Securitize and another party leads the verification. Store `investorId`; `status` is the current one. You can read its `status` and manage its wallets, token whitelisting, suitability and DLT test; every other operation on it answers `409 investor_not_owned`. content: application/json: schema: $ref: '#/components/schemas/LimitedInvestor' examples: alreadyRegistered: summary: Already registered with Securitize (limited access) value: investorId: 6ace6a01b2d94ceccd1999e4 externalInvestorId: ind-test-0001 status: verified '201': description: >- Created, or the same create repeated. `status` is `none` on a new investor. Upload the identity document next. content: application/json: schema: $ref: '#/components/schemas/IndividualInvestor' examples: created: summary: Individual created value: investorId: 6ace745fab21fd6924a19beb externalInvestorId: ind-test-0001 email: kyc.sandbox+ind0001@test.invalid status: none riskLevel: low createdAt: '2026-10-13T18:11:43.278Z' details: firstName: Test_Jane middleName: Sample lastName: Investor dateOfBirth: '1990-04-12T00:00:00.000Z' birthCountry: US taxId: 123-45-6780 taxCountry: US phone: code: '1' number: '5550100001' address: street: Test Street houseNumber: '1' city: New York state: NY countryCode: US postalCode: '10001' '400': description: > `validation_error` — the body is malformed. `details` names every offending field at once (`[{ field, message }]`), so fix them together. A placeholder `taxId` such as `000000000`, `123456789`, `TEST` or `N/A` is refused here too: send the real tax identifier. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - validation_error examples: placeholderTaxId: summary: Placeholder taxId value: statusCode: 400 code: validation_error message: Validation failed details: - field: taxId message: >- taxId is not a valid identifier: placeholder values such as 000000000, 123456789 or TEST are not accepted correlationId: partners-api-4c30d520-dd6a-5fdb-ba5a-4cca5739bb5d '401': $ref: '#/components/responses/GatewayUnauthorized' '403': $ref: '#/components/responses/GatewayForbidden' '409': $ref: '#/components/responses/InvestorCreateConflict' '413': $ref: '#/components/responses/PayloadTooLarge' '415': $ref: '#/components/responses/ContentTypeNotJson' '422': description: > `business_rule_violation` — `investorType` is `entity` on the individual route. Create a company with `POST /investors/entity`. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - business_rule_violation examples: wrongInvestorType: summary: Entity payload on the individual route value: statusCode: 422 code: business_rule_violation message: >- investorType "entity" is not accepted on this endpoint. An entity is created with POST /investors/entity and corrected with PUT /investors/entity/{investorId}. correlationId: partners-api-6b1e0c1a-2f7d-4c55-9a0e-3d8b7f1c2e44 '500': $ref: '#/components/responses/InternalError' '502': $ref: '#/components/responses/RegistrationIncomplete' components: schemas: IndividualInvestorRequest: type: object description: > The person being onboarded. The same body creates the investor and, on `PUT`, replaces it in full: an optional field you omit on `PUT` is cleared. required: - externalInvestorId - investorType - email - firstName - lastName - dateOfBirth - birthCountry - taxId - taxCountry - phone - address properties: externalInvestorId: $ref: '#/components/schemas/ExternalId' description: > Your own id for this person, unique within your partner account. Fixed at create: on `PUT` send the same value. investorType: type: string enum: - individual description: Always `individual` on this route. email: type: string format: email description: > The person's email. ASCII local part only; stored in lower case. Unique across Securitize: an address that belongs to another investor answers `409 email_conflict`. Fixed at create: on `PUT` send the same value. firstName: type: string minLength: 1 maxLength: 128 description: First name. This is what sanctions and PEP screening run against. middleName: type: string maxLength: 128 description: Middle name. lastName: type: string minLength: 1 maxLength: 128 description: Last name. gender: type: string enum: - male - female description: Gender. dateOfBirth: $ref: '#/components/schemas/InputDate' description: >- Date of birth, `YYYY-MM-DD`, not later than today (UTC); a later date answers `400 validation_error`. Returned as a timestamp. birthCountry: $ref: '#/components/schemas/CountryCode' description: Country of birth. taxId: type: string minLength: 1 maxLength: 50 description: > Tax identifier. With `taxCountry` it identifies the person. Stored trimmed and upper-cased. Placeholder values (`000000000`, `123456789`, `TEST`, `N/A`, one repeated character, fewer than 4 characters) are refused with `400 validation_error`, with or without separators (spaces, dots, dashes, slashes). For a US person (US `address` and `taxCountry` `US`) it is the Social Security number, and verification checks that it matches the name and residential address; a mismatch can send the investor to `manual-review`. Sandbox does not run that check. examples: - 123-45-6780 taxCountry: $ref: '#/components/schemas/CountryCode' description: Country that issued the tax identifier. phone: $ref: '#/components/schemas/Phone' description: The person's phone. address: $ref: '#/components/schemas/Address' description: >- Residential address. Its country, with `taxCountry`, feeds the risk level. LimitedInvestor: type: object additionalProperties: false description: > An investor already registered with Securitize whose verification another party leads. You have limited access: you can read its `status` and manage its wallets, token whitelisting, suitability and DLT test; every other operation on it answers `409 investor_not_owned`. required: - investorId - externalInvestorId - status properties: investorId: $ref: '#/components/schemas/SecuritizeId' description: Securitize's id for this investor in your partner account. Store it. externalInvestorId: $ref: '#/components/schemas/ExternalId' description: Your own id, as sent at create. status: $ref: '#/components/schemas/InvestorStatus' IndividualInvestor: type: object description: >- The individual investor as stored, returned by create (`201`) and correction. required: - investorId - externalInvestorId - email - status - riskLevel - createdAt - details properties: investorId: $ref: '#/components/schemas/SecuritizeId' description: >- Securitize's id for this investor. Every path that names an investor takes it. externalInvestorId: $ref: '#/components/schemas/ExternalId' description: Your own id, as sent at create. email: type: string format: email description: The email sent at create, in lower case. status: $ref: '#/components/schemas/InvestorStatus' riskLevel: $ref: '#/components/schemas/RiskLevel' createdAt: type: string format: date-time description: When the investor was created. details: $ref: '#/components/schemas/IndividualDetails' ApiError: type: object description: > The error envelope of the API. Branch on `code`; `message` is for humans and not contractual. Quote `correlationId` to Securitize support. required: - statusCode - code - message - correlationId properties: statusCode: type: integer description: The HTTP status, repeated. code: type: string description: > Stable error code. Each response lists the codes it can carry and what to do about each. message: type: string description: Human-readable explanation. Not a stable contract. details: description: > Present on some errors. Its shape depends on the error: - body validation — an array of `{ field, message }`; - path or query validation — an array of strings; - `external_investor_id_conflict` — `{ investorId }`; - `external_key_party_id_conflict` — `{ keyPartyId }`; - submit refusal — `{ investor, keyParties }`, the per-subject accounting; - document refused, or not accepted while under review — `{ code, message }`; - document outcome unknown — `{ code }`, possibly empty; - `suitability_not_verified` — `{ notVerified }`; - `tax_form_type_not_allowed` — `{ allowed }`; - `tax_form_already_active` — `{ activeTaxForm }`; - DLT test locked, suitability under review or not approved, compact suitability for an entity, or a W-9 subject to backup withholding sent as data — `{ reason }`. anyOf: - $ref: '#/components/schemas/FieldErrors' - $ref: '#/components/schemas/MessageErrors' - $ref: '#/components/schemas/InvestorConflictDetails' - $ref: '#/components/schemas/KeyPartyConflictDetails' - $ref: '#/components/schemas/SubmitRefusalDetails' - $ref: '#/components/schemas/RefusalDetails' - $ref: '#/components/schemas/OutcomeUnknownDetails' - $ref: '#/components/schemas/SuitabilityGateDetails' - $ref: '#/components/schemas/AllowedTaxFormsDetails' - $ref: '#/components/schemas/ActiveTaxFormDetails' - $ref: '#/components/schemas/ReasonDetails' correlationId: type: string description: Identifier of this request. Quote it to Securitize support. examples: - partners-api-d3dcfc7c-a3d0-459e-98a5-9d6f23dcb998 ExternalId: type: string pattern: ^[A-Za-z0-9._-]{1,128}$ description: >- Your own identifier. Letters, digits, `.`, `_` and `-`; 1 to 128 characters. examples: - ent-test-0001 InputDate: type: string format: date description: '`YYYY-MM-DD`. A full ISO 8601 timestamp is also accepted.' examples: - '2015-06-30' CountryCode: type: string pattern: ^[A-Za-z]{2}$ description: > ISO 3166-1 alpha-2 country code. Case-insensitive in, upper case out, and checked against the real list (`XX` is refused). examples: - US Phone: type: object description: >- A phone number split into country code and number. Digits only — no `+`, spaces or dashes. required: - code - number properties: code: type: string pattern: ^\d+$ maxLength: 6 description: Country calling code, digits only, without `+`. examples: - '1' number: type: string pattern: ^\d+$ maxLength: 32 description: Subscriber number, digits only. examples: - '5550000001' Address: type: object description: A postal address. required: - street - city - countryCode - postalCode properties: street: type: string maxLength: 255 description: Street name. houseNumber: type: string maxLength: 32 description: Building or house number. city: type: string maxLength: 128 description: City. state: type: string maxLength: 2 description: >- For a US address only: the 2-letter code of the state, such as `NY` or `DC`. Case-insensitive; stored in upper case. Omit it when `countryCode` is not `US`, also for a province or region abroad; `null` and an empty string read as omitted. A US territory such as Puerto Rico is its own `countryCode` (`PR`) and takes no `state`, and the military codes `AA`, `AE` and `AP` are not accepted. Any other value answers `400 validation_error` on `address.state`. A key party's address follows its own `countryCode`, not the investor's. countryCode: $ref: '#/components/schemas/CountryCode' description: Country, ISO 3166-1 alpha-2. postalCode: type: string maxLength: 32 description: Postal or ZIP code. SecuritizeId: type: string minLength: 1 description: > Identifier assigned by Securitize, opaque and specific to your partner account. Store it as an opaque string. examples: - 6aca84e5dc49fe8369dd1da4 InvestorStatus: type: string enum: - none - processing - verified - manual-review - updates-required - expired - rejected description: > The investor's verification state. - `none` — created, nothing under review. An investor stays here until you submit it. - `processing` — under review. - `verified` — verified. - `manual-review` — a Securitize operator is reviewing it. Not a rejection. - `updates-required` — Securitize needs updated information; contact Securitize support. - `expired` — the verification lapsed; contact Securitize support. - `rejected` — final. When `status` becomes `verified` — at submit, or after Securitize's screening and compliance review — depends on your agreement with Securitize. Treat any value you do not recognise as "not verified" rather than failing. RiskLevel: type: string enum: - none - low - medium - high description: Risk level computed by Securitize from the investor's countries. IndividualDetails: type: object description: > The person data Securitize holds for an individual investor — what was stored, not what was sent, so a field a `PUT` cleared is absent. required: - firstName - lastName - dateOfBirth - birthCountry - phone - address properties: firstName: type: string description: First name. lastName: type: string description: Last name. middleName: type: string description: Middle name. gender: type: string enum: - male - female description: Gender. dateOfBirth: type: string format: date-time description: Date of birth, as a UTC timestamp at midnight. birthCountry: $ref: '#/components/schemas/CountryCode' description: Country of birth. taxId: type: string description: Tax identifier. taxCountry: $ref: '#/components/schemas/CountryCode' description: Country of the tax identifier. phone: $ref: '#/components/schemas/Phone' description: Phone. address: $ref: '#/components/schemas/Address' description: Residential address. FieldErrors: type: array description: Body validation — one entry per offending field. items: type: object required: - field - message properties: field: type: string description: >- Path of the field, with dots and indexes, e.g. `phone.code` or `files.0.content`. message: type: string description: What is wrong with it. MessageErrors: type: array description: Path or query validation — one message per problem. items: type: string InvestorConflictDetails: type: object description: The investor that already holds the identifiers sent. required: - investorId properties: investorId: $ref: '#/components/schemas/SecuritizeId' description: The existing investor's id. Use it instead of creating another. KeyPartyConflictDetails: type: object description: The key party that already holds the `externalKeyPartyId` sent. required: - keyPartyId properties: keyPartyId: $ref: '#/components/schemas/SecuritizeId' description: The existing key party's id. SubmitRefusalDetails: type: object description: Per-subject accounting of a refused submit. Nothing was submitted. required: - investor - keyParties properties: investor: $ref: '#/components/schemas/SubmissionOutcome' description: The investor itself. keyParties: type: array description: >- Each key party of an entity; the ones not ready read `failed` with a reason. Empty for an individual. items: $ref: '#/components/schemas/SubmissionOutcome' RefusalDetails: type: object description: The verification side's own refusal of a document. required: - code - message properties: code: type: string description: >- Refusal code, for example `corrupted-file`. Not a fixed list; read `message`. message: type: string description: Human-readable explanation. OutcomeUnknownDetails: type: object description: A document whose outcome is unknown. May be empty. properties: code: type: string description: Reason code, when there is one. SuitabilityGateDetails: type: object description: Which suitability is not verified yet. required: - notVerified properties: notVerified: type: array description: '`us` (the suitability) and/or `eu` (the DLT test).' items: type: string enum: - us - eu AllowedTaxFormsDetails: type: object description: The tax forms this investor can receive. required: - allowed properties: allowed: type: array items: $ref: '#/components/schemas/TaxFormType' ActiveTaxFormDetails: type: object description: The tax form the investor has on file. required: - activeTaxForm properties: activeTaxForm: type: object required: - taxFormId properties: taxFormId: type: string description: Securitize's identifier for the form on file. formType: $ref: '#/components/schemas/TaxFormType' ReasonDetails: type: object description: A machine-readable reason. required: - reason properties: reason: type: string description: >- For example `dlt_test_locked`, `suitability_under_review` or `investor_type_not_supported`. Each operation lists the reasons it can answer. TokenError: type: object additionalProperties: false description: > The gateway's answer to a missing, invalid or expired bearer token, in the OAuth 2.0 shape: `error` and `error_description`, no `code` and no `correlationId`. The request never reached the API. required: - error - error_description properties: error: type: string enum: - invalid_request - invalid_token description: > `invalid_request`: no `Authorization: Bearer` header. `invalid_token`: the token is unknown or has expired. error_description: type: string GatewayError: type: object additionalProperties: false description: > The gateway's error shape: only `message`, no `code` and no `correlationId`. It means the request never reached the API — check the account or the path, not the payload. required: - message properties: message: type: string description: > `You cannot consume this service` (`403`: your account is not enabled for this API), `IP address not allowed: ` (`403`: a path or method outside the API). SubmissionOutcome: type: object description: >- What happened to one subject — the entity itself or one of its key parties. required: - subjectId - result properties: subjectId: $ref: '#/components/schemas/SecuritizeId' description: The `investorId` for the investor itself, or a `keyPartyId`. result: type: string enum: - submitted - skipped - failed - not_attempted description: > `submitted` — handed over on this call (a company key party: recorded for compliance review). `skipped` — already handed over, not re-sent; this makes repeats safe. `failed` — attempted and refused; see `reason`. `not_attempted` — never reached; a repeat sends exactly these. reason: $ref: '#/components/schemas/SubmissionReason' TaxFormType: type: string description: > The form in the file. `W-9` for a US person, individual or entity; `W-8BEN` for an individual who is not a US person; `W-8BEN-E` for an entity that is not a US person. enum: - W-9 - W-8BEN - W-8BEN-E SubmissionReason: type: object description: > Why a subject was not submitted. Branch on `code`; `message` is for humans and not contractual. Known values: `already-handed-over` (already with verification, not re-sent), `documents-incomplete` (something is still owed), `provider-rate-limited` and `submission-failed` (the hand-over did not go through; call submit again), `key-parties-not-ready` (an entity waits for its key parties). Treat any other value as "not submitted; read `message`". required: - code - message properties: code: type: string description: Stable reason code. message: type: string description: Human-readable explanation. responses: GatewayUnauthorized: description: > Refused by the gateway: no bearer token, or one that is unknown or has expired. The request never reached the API. Get a new token and send the request again. headers: WWW-Authenticate: description: >- `Bearer realm="service"`, with `error` and `error_description` when a token was sent. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TokenError' examples: missing: summary: No Authorization header value: error_description: The access token is missing error: invalid_request invalid: summary: Unknown or expired token value: error_description: The access token is invalid or has expired error: invalid_token GatewayForbidden: description: > Refused by the gateway: the token is valid but your account is not enabled for this API. The request never reached the API. Contact Securitize to have it enabled. content: application/json: schema: $ref: '#/components/schemas/GatewayError' examples: notEnabled: summary: Account not enabled for this API value: message: You cannot consume this service InvestorCreateConflict: description: > - `external_investor_id_conflict` — the `externalInvestorId` already belongs to an investor you created, with different data; or the identifiers sent (`taxId` + `taxCountry` for a person, `entityIdNumber` + `address.countryCode` for a company) belong to an investor you already created under another id. `details.investorId` holds it: correct it with `PUT`, or repeat the create with the data it holds — do not create another. - `email_conflict` — the email already belongs to another investor at Securitize. Emails are unique across Securitize, not per partner. Use the investor's own address. - `identity_conflict` — the data sent cannot be used to onboard this investor through this API. Do not retry the same data; contact Securitize support with the `correlationId`. - `investor_not_eligible` — this investor cannot be onboarded through this API. Contact Securitize support with the `correlationId`. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - external_investor_id_conflict - email_conflict - identity_conflict - investor_not_eligible examples: differentBody: summary: Same externalInvestorId, different data value: statusCode: 409 code: external_investor_id_conflict message: >- An investor with externalInvestorId "ent-test-0001" already exists for this partner, and this request does not repeat its create. Use the correction endpoint to change its data. details: investorId: 6aca84e5dc49fe8369dd1da4 correlationId: partners-api-7bd417e7-c8a6-4434-8cd0-98d128ba9b33 differentEmail: summary: Same externalInvestorId, different email value: statusCode: 409 code: external_investor_id_conflict message: >- An investor with externalInvestorId "ent-test-0001" already exists for this partner with a different email, and the email cannot be changed. Send the create with the email it was created with to repeat it, or use the correction endpoint for the rest of its data. details: investorId: 6aca84e5dc49fe8369dd1da4 correlationId: partners-api-2e8c4a10-7f3b-4d95-b1a6-0c5e9d7f3b28 sameIdentifiers: summary: Identifiers of an investor you already created value: statusCode: 409 code: external_investor_id_conflict message: >- This partner is already linked to the investor this payload identifies. Use the investorId it was given. details: investorId: 89511eb055ed5583962a0fb2 correlationId: partners-api-ef70421c-73de-5d19-83ef-0224240cdcfc emailConflict: summary: Email belongs to another investor value: statusCode: 409 code: email_conflict message: >- An investor with email "kyc.sandbox+ent0001@test.invalid" already exists correlationId: partners-api-fbefc922-e306-4564-8f86-b2174dc6f9fb identityConflict: summary: identity_conflict value: statusCode: 409 code: identity_conflict message: >- The data provided does not allow onboarding this investor through this API. Contact Securitize support with the correlation id. correlationId: partners-api-97329d22-063d-5952-b3a4-6cec14e76a91 investorNotEligible: summary: investor_not_eligible value: statusCode: 409 code: investor_not_eligible message: >- This investor cannot be onboarded through this API. Contact Securitize support with the correlation id. correlationId: partners-api-844f9aad-968c-52c6-95a7-0d8d20dc2420 PayloadTooLarge: description: > `payload_too_large` — the request body is over about 31 MB. Refused whole; nothing was stored. A body far over the limit can be refused by the gateway first, in the bare `{ message }` shape. content: application/json: schema: oneOf: - allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - payload_too_large - $ref: '#/components/schemas/GatewayError' examples: tooLarge: summary: Body over the limit value: statusCode: 413 code: payload_too_large message: Payload too large correlationId: partners-api-28aaa856-786d-4275-8faf-c94a17f157f2 ContentTypeNotJson: description: > `mime_not_supported` — the request's `Content-Type` is not `application/json`. Send JSON with that header. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - mime_not_supported examples: notJson: summary: Body sent as text value: statusCode: 415 code: mime_not_supported message: 'Content-Type must be application/json (received: "text/plain")' correlationId: partners-api-4d8f2a6c-1b9e-4c37-a05d-8e6f3b2c9a14 InternalError: description: > `internal_error` — an unexpected fault on Securitize's side. The message is always generic. Retry; if it persists, send the `correlationId` to Securitize support. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - internal_error examples: internal: summary: Internal error value: statusCode: 500 code: internal_error message: Internal error correlationId: partners-api-5b0c7a1e-9d3f-4e2a-8c6b-1f4d2e3a9b70 RegistrationIncomplete: description: > `verification_handoff_failed` — the record was stored, but its registration for verification did not complete. Send **the same request again**: a repeat with the same body finishes it and answers `201` with the same id. content: application/json: schema: allOf: - $ref: '#/components/schemas/ApiError' - properties: code: type: string enum: - verification_handoff_failed examples: registrationIncomplete: summary: Registration did not complete value: statusCode: 502 code: verification_handoff_failed message: >- The registration for verification did not complete. Send the same request again to finish it. correlationId: partners-api-6a2d9e14-8c3f-4b70-9e51-2f7c0b8d4a36 securitySchemes: OAuth2: type: oauth2 description: > OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with `grant_type=client_credentials`; the token lasts 2 hours and goes in the `Authorization: Bearer` header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you. flows: clientCredentials: tokenUrl: https://partners-api.sandbox.securitize.io/oauth2/token scopes: {} ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.