generated: '2026-09-01' method: derived source: openapi/tzero-issuance-secondary-markets-openapi.json, openapi/tzero-institutional-openapi.json note: 'Derived from OpenAPI components.schemas $ref links and Id reference fields. Entries marked inferred: true come from an id-shaped field name whose target schema is not itself declared in the contract (tZERO inlines many nested objects), so the target entity is named but not defined.' entity_count: 83 relationship_count: 90 entities: - entity: CustodyTransfer surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 11 description: A transfer of assets out of a custody vault. id_field: id - entity: CustodyVault surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 6 description: A Fireblocks-backed custody vault owned by the issuer. id_field: id - entity: CustodyWallet surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 5 description: An asset wallet inside a custody vault. id_field: id - entity: Deployment surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 10 description: An on-chain instance of a token configuration on a specific chain/network. id_field: id - entity: Document surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 13 description: null id_field: id - entity: ErrorResponse surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 2 description: null - entity: Investor surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 18 description: null id_field: id - entity: InvestorHolding surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 7 description: null - entity: IssuanceRequest surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 17 description: null id_field: id - entity: Operation surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 7 description: A logged on-chain operation against a deployment (MINT, BURN, TRANSFER, …). id_field: id - entity: PaginationMeta surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 4 description: null - entity: Security surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 18 description: null id_field: id - entity: SecurityHolder surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 7 description: null - entity: TokenConfig surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 22 description: A token configuration (the blueprint). Deployments are its on-chain instances. id_field: id - entity: TransferRequest surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 8 description: null id_field: id - entity: WebhookSubscription surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 6 description: null id_field: id - entity: WhitelistedAddress surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 9 description: An external address approved to receive transfers from custody. id_field: id - entity: WhitelistedAddressAsset surface: institutional source: openapi/tzero-institutional-openapi.json field_count: 4 description: null id_field: id - entity: AccountBalanceResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 1 description: null - entity: AccountResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 8 description: null id_field: id - entity: AccountTrustedContact surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: null - entity: AddressRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 10 description: null - entity: AddressResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 13 description: null id_field: id - entity: AgreementDTO surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 14 description: null id_field: id - entity: Asset surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 14 description: Asset details. - entity: AssetsResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 1 description: null - entity: BalanceDetails surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: BankAccountDetails surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: null - entity: CancelInvestmentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null - entity: CancelOrderResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null id_field: id - entity: CodeLabelDescription surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: CostBasis surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: null - entity: CreateBankAccountRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 8 description: Request body for linking a new bank account. - entity: CreateBankTransferRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: Request body for initiating a bank transfer account. - entity: CreateBankTransferResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: Response object for bank transfer transaction. - entity: CreateIndividualAccountRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 5 description: null - entity: CreateInvestmentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 5 description: null - entity: CreateOrderRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 9 description: null - entity: CreateOrderResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 15 description: null id_field: id - entity: CreatePaymentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: Request body for updating payment details on an investment. Only WIRE and ACH payment types are supported. - entity: EmploymentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: EmploymentResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: ErrorItem surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: null - entity: ErrorResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 1 description: Error response body for validation and business-rule failures. Contains a list of errors; each item has code, message, and optional field (JSON path). - entity: FeeResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: FiatBalance surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 5 description: null - entity: FinancialInfoResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 5 description: null - entity: GovernmentIdentifierRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: GovernmentIdentifierResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: null id_field: id - entity: InvestmentDetails surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 11 description: null - entity: InvestmentProfile surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null - entity: InvestmentSignatureRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: null - entity: InvestorRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 13 description: null - entity: InvestorResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 13 description: null id_field: id - entity: InvestorUpdateRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 11 description: 'Investor update payload. Notes: - Email cannot be changed after account creation (if provided it may be rejected). - dateOfBirth is optional; when provided (YYYY-MM-DD), validated for format, not future, not older than 120y, min age 18. - firstName/lastName when provided must not be blank. - phoneNumbers uses replace semantics when provided (full desired set). - governmentIdentifiers supports replace semantics when provided. - Country/residence is derived from physicalAddress.country only. ' - entity: InvestorUpdateResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: Updated investor. - entity: KycResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 7 description: null id_field: id - entity: MarketSchedule surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: Pre-market, market, and post-market hours for a single trading day. - entity: Message surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: OrderExecution surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 12 description: null - entity: OrderResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 23 description: null id_field: id - entity: OrdersListResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 1 description: null - entity: PatchFinancialInfoRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: All fields optional except transactionId; only provided fields are updated. - entity: PhoneNumberRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 5 description: null - entity: PhoneNumberResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 8 description: null id_field: id - entity: PositionBalance surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 4 description: null - entity: PostKycResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: PriceHistory surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 7 description: Represents Price History data for a symbol. - entity: ScheduleError surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: Error item returned by the schedule endpoints. - entity: ScheduleResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: Wrapper response for market schedule queries. Contains either a list of schedules in `dto` or a list of `errors`. - entity: SubSchedule surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: A portion of a single day defining open and close times for a trading session. - entity: SubmitInvestmentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null - entity: SymbolData surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 17 description: Represents market data for a symbol. - entity: TermsAcceptRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: TokenRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null - entity: TokenResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 3 description: null - entity: TriggerKycRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 1 description: null - entity: TrustedContactAddress surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 6 description: null - entity: TrustedContactDetails surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 7 description: Trusted contact. id_field: id - entity: TrustedContactRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 7 description: null - entity: TrustedContactResponse surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null - entity: UpdateInvestmentRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 9 description: Request body for updating an investment (amount, payment details). - entity: UpdateInvestorRequest surface: issuance-secondary-markets source: openapi/tzero-issuance-secondary-markets-openapi.json field_count: 2 description: null relationships: - from: CustodyTransfer to: Asset type: belongs_to via: assetId surface: institutional inferred: true - from: CustodyTransfer to: Vault type: belongs_to via: vaultId surface: institutional inferred: true - from: CustodyWallet to: Asset type: belongs_to via: assetId surface: institutional inferred: true - from: Document to: Investor type: belongs_to via: investorId surface: institutional inferred: true - from: Investor to: Tax type: belongs_to via: taxId surface: institutional inferred: true - from: InvestorHolding to: Security type: belongs_to via: securityId surface: institutional inferred: true - from: IssuanceRequest to: Investor type: belongs_to via: investorId surface: institutional inferred: true - from: IssuanceRequest to: Security type: belongs_to via: securityId surface: institutional inferred: true - from: IssuanceRequest to: Webhook type: belongs_to via: webhookId surface: institutional inferred: true - from: SecurityHolder to: Investor type: belongs_to via: investorId surface: institutional inferred: true - from: WhitelistedAddressAsset to: Asset type: belongs_to via: assetId surface: institutional inferred: true - from: AccountBalanceResponse to: BalanceDetails type: has_one via: accountBalances surface: issuance-secondary-markets - from: AccountResponse to: InvestorResponse type: has_many via: investors surface: issuance-secondary-markets - from: AccountResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: AccountTrustedContact to: TrustedContactAddress type: has_one via: physicalAddress surface: issuance-secondary-markets - from: AgreementDTO to: Asset type: belongs_to via: assetId surface: issuance-secondary-markets inferred: true - from: AgreementDTO to: Document type: belongs_to via: documentId surface: issuance-secondary-markets inferred: true - from: AgreementDTO to: User type: belongs_to via: userId surface: issuance-secondary-markets inferred: true - from: Asset to: Asset type: belongs_to via: assetId surface: issuance-secondary-markets inferred: true - from: Asset to: CodeLabelDescription type: has_one via: assetType surface: issuance-secondary-markets - from: Asset to: CodeLabelDescription type: has_one via: offering surface: issuance-secondary-markets - from: Asset to: CodeLabelDescription type: has_many via: paymentTypes surface: issuance-secondary-markets - from: AssetsResponse to: Asset type: has_many via: assets surface: issuance-secondary-markets - from: BalanceDetails to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: BalanceDetails to: FiatBalance type: has_many via: fiat surface: issuance-secondary-markets - from: BalanceDetails to: PositionBalance type: has_many via: positions surface: issuance-secondary-markets - from: BankAccountDetails to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CancelInvestmentRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: CancelInvestmentRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CancelOrderResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateBankAccountRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateBankTransferRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateBankTransferResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateBankTransferResponse to: Transfer type: belongs_to via: transferId surface: issuance-secondary-markets inferred: true - from: CreateIndividualAccountRequest to: InvestorRequest type: has_one via: investor surface: issuance-secondary-markets - from: CreateIndividualAccountRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateInvestmentRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: CreateInvestmentRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateOrderRequest to: Asset type: belongs_to via: assetId surface: issuance-secondary-markets inferred: true - from: CreateOrderRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreateOrderResponse to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: CreateOrderResponse to: Asset type: belongs_to via: assetId surface: issuance-secondary-markets inferred: true - from: CreateOrderResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: CreatePaymentRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: CreatePaymentRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: ErrorResponse to: ErrorItem type: has_many via: errors surface: issuance-secondary-markets - from: FinancialInfoResponse to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: FinancialInfoResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: InvestmentDetails to: Asset type: belongs_to via: assetId surface: issuance-secondary-markets inferred: true - from: InvestmentDetails to: Investment type: belongs_to via: investmentId surface: issuance-secondary-markets inferred: true - from: InvestmentDetails to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: InvestmentSignatureRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: InvestmentSignatureRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: InvestorRequest to: TermsAcceptRequest type: has_one via: agreement surface: issuance-secondary-markets - from: InvestorRequest to: EmploymentRequest type: has_one via: employment surface: issuance-secondary-markets - from: InvestorRequest to: GovernmentIdentifierRequest type: has_many via: governmentIdentifiers surface: issuance-secondary-markets - from: InvestorRequest to: PhoneNumberRequest type: has_many via: phoneNumbers surface: issuance-secondary-markets - from: InvestorRequest to: AddressRequest type: has_one via: physicalAddress surface: issuance-secondary-markets - from: InvestorResponse to: GovernmentIdentifierResponse type: has_many via: governmentIdentifiers surface: issuance-secondary-markets - from: InvestorResponse to: PhoneNumberResponse type: has_many via: phoneNumbers surface: issuance-secondary-markets - from: InvestorUpdateRequest to: EmploymentRequest type: has_one via: employment surface: issuance-secondary-markets - from: InvestorUpdateRequest to: GovernmentIdentifierRequest type: has_many via: governmentIdentifiers surface: issuance-secondary-markets - from: InvestorUpdateRequest to: PhoneNumberRequest type: has_many via: phoneNumbers surface: issuance-secondary-markets - from: InvestorUpdateResponse to: InvestorResponse type: has_one via: investor surface: issuance-secondary-markets - from: InvestorUpdateResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: MarketSchedule to: Zone type: belongs_to via: zoneId surface: issuance-secondary-markets inferred: true - from: OrderResponse to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: OrderResponse to: OrderExecution type: has_many via: executionHistory surface: issuance-secondary-markets - from: OrdersListResponse to: OrderResponse type: has_many via: orders surface: issuance-secondary-markets - from: PatchFinancialInfoRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: PositionBalance to: CostBasis type: has_one via: costBasis surface: issuance-secondary-markets - from: PostKycResponse to: KycResponse type: has_one via: kycResult surface: issuance-secondary-markets - from: PostKycResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: PostKycResponse to: User type: belongs_to via: userId surface: issuance-secondary-markets inferred: true - from: ScheduleResponse to: MarketSchedule type: has_many via: dto surface: issuance-secondary-markets - from: ScheduleResponse to: ScheduleError type: has_many via: errors surface: issuance-secondary-markets - from: SubmitInvestmentRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: SubmitInvestmentRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: TokenRequest to: Client type: belongs_to via: clientId surface: issuance-secondary-markets inferred: true - from: TriggerKycRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: TrustedContactRequest to: TrustedContactAddress type: has_one via: physicalAddress surface: issuance-secondary-markets - from: TrustedContactRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: TrustedContactResponse to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: TrustedContactResponse to: TrustedContactDetails type: has_one via: trustedContact surface: issuance-secondary-markets - from: UpdateInvestmentRequest to: Account type: belongs_to via: accountId surface: issuance-secondary-markets inferred: true - from: UpdateInvestmentRequest to: Investment type: belongs_to via: investmentId surface: issuance-secondary-markets inferred: true - from: UpdateInvestmentRequest to: Payment type: belongs_to via: paymentId surface: issuance-secondary-markets inferred: true - from: UpdateInvestmentRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true - from: UpdateInvestorRequest to: InvestorUpdateRequest type: has_one via: investor surface: issuance-secondary-markets - from: UpdateInvestorRequest to: Transaction type: belongs_to via: transactionId surface: issuance-secondary-markets inferred: true domains: - domain: onboarding entities: - Investor - Account - User - KYC - TrustedContact surface: issuance-secondary-markets - domain: primary-market entities: - Asset - Investment - InvestmentPayment - Agreement - WireInstructions surface: issuance-secondary-markets - domain: banking entities: - BankAccount - Transfer - Balance surface: issuance-secondary-markets - domain: secondary-market entities: - Order - Fee - MarketSchedule - PriceHistory - Snapshot surface: issuance-secondary-markets - domain: transfer-agent entities: - Investor - InvestorHolding - Security - SecurityHolder - TransferRequest - IssuanceRequest - Document surface: institutional - domain: corporate-events entities: - Dividend - CorporateAction - Proposal surface: institutional - domain: tokenization entities: - TokenConfig - Deployment - Operation surface: institutional - domain: custody entities: - CustodyVault - CustodyWallet - CustodyTransfer - WhitelistedAddress - WhitelistedAddressAsset surface: institutional - domain: settlement entities: - SettlementInstruction - SettlementConfig - InvestorAccount surface: institutional