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

# List your investors

> Lists the investors you created, **newest first**, in pages. Use it to recover an `investorId` you no longer have: filter by the `externalInvestorId` you chose.

Repeat a filter for several values: `?externalInvestorId=a&externalInvestorId=b`. Unknown values simply do not appear; that is not an error. Rows have the same projection as `GET /investors/{investorId}` without `include` (the three-field shape for an investor you have limited access to). There is no `include` here.

The response is wrapped: read `data`. `meta.total` is the unpaged count, `meta.length` the rows in this page. Paging reaches the 10 000 most recent investors; use the filters for anything older.




## OpenAPI

````yaml /secid-api/openapi.yaml get /investors
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:
    get:
      tags:
        - Lookup
      summary: List your investors
      description: >
        Lists the investors you created, **newest first**, in pages. Use it to
        recover an `investorId` you no longer have: filter by the
        `externalInvestorId` you chose.


        Repeat a filter for several values:
        `?externalInvestorId=a&externalInvestorId=b`. Unknown values simply do
        not appear; that is not an error. Rows have the same projection as `GET
        /investors/{investorId}` without `include` (the three-field shape for an
        investor you have limited access to). There is no `include` here.


        The response is wrapped: read `data`. `meta.total` is the unpaged count,
        `meta.length` the rows in this page. Paging reaches the 10 000 most
        recent investors; use the filters for anything older.
      operationId: listInvestors
      parameters:
        - name: externalInvestorId
          in: query
          required: false
          description: Exact match on your own id. Repeat for several values.
          style: form
          explode: true
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ExternalId'
        - name: email
          in: query
          required: false
          description: >-
            Exact match on the email sent at create, case-insensitive. Repeat
            for several values.
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              format: email
        - name: limit
          in: query
          required: false
          description: Rows per page, 1 to 20.
          schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 20
        - name: offset
          in: query
          required: false
          description: Rows to skip, 0 to 10 000.
          schema:
            type: integer
            minimum: 0
            maximum: 10000
            default: 0
      responses:
        '200':
          description: A page of investors, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvestorList'
              examples:
                byExternalId:
                  summary: Filtered by externalInvestorId
                  value:
                    meta:
                      total: 1
                      offset: 0
                      limit: 20
                      length: 1
                    data:
                      - investorId: 6aca84e5dc49fe8369dd1da4
                        externalInvestorId: ent-test-0001
                        email: kyc.sandbox+ent0001@test.invalid
                        status: verified
                        riskLevel: low
                        createdAt: '2026-10-10T18:33:09.697Z'
        '400':
          description: >
            `validation_error` — a query parameter is out of range or malformed.
            `details` is an array of strings naming each problem.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiError'
                  - properties:
                      code:
                        type: string
                        enum:
                          - validation_error
              examples:
                limitTooHigh:
                  summary: limit above the maximum
                  value:
                    statusCode: 400
                    code: validation_error
                    message: limit must not be greater than 20
                    details:
                      - limit must not be greater than 20
                    correlationId: partners-api-43f8c427-61f3-46b5-8552-9d43ee9ac5fb
        '401':
          $ref: '#/components/responses/GatewayUnauthorized'
        '403':
          $ref: '#/components/responses/GatewayForbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    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
    InvestorList:
      type: object
      description: A page of investors.
      required:
        - meta
        - data
      properties:
        meta:
          type: object
          description: Paging information.
          required:
            - total
            - offset
            - limit
            - length
          properties:
            total:
              type: integer
              description: Number of matching investors across all pages.
            offset:
              type: integer
              description: Rows skipped.
            limit:
              type: integer
              description: Page size requested.
            length:
              type: integer
              description: Rows in this page.
        data:
          type: array
          description: The investors in this page, newest first.
          items:
            $ref: '#/components/schemas/InvestorListRow'
    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
    InvestorListRow:
      type: object
      description: >-
        One investor in a list, without expansions. `email`, `riskLevel` and
        `createdAt` are absent for an investor you have limited access to.
      required:
        - investorId
        - externalInvestorId
        - status
      properties:
        investorId:
          $ref: '#/components/schemas/SecuritizeId'
          description: Securitize's id for this investor.
        externalInvestorId:
          $ref: '#/components/schemas/ExternalId'
          description: Your own id.
        email:
          type: string
          format: email
          description: The email sent at create.
        status:
          $ref: '#/components/schemas/InvestorStatus'
        riskLevel:
          $ref: '#/components/schemas/RiskLevel'
        createdAt:
          type: string
          format: date-time
          description: When the investor was created.
    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: <ip>` (`403`: a path
            or method outside the API).
    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.
    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
    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
  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.