How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

tZERO Institutional API

REST/JSON API giving institutional issuers and partners programmatic access to tZERO transfer-agent, tokenization and custody operations: investors and holdings, securities and cap tables, book-entry transfers, issuance requests, documents, dividends, corporate actions, voting proposals, settlement instructions, omnibus investor accounts, token deployments, custody vaults/whitelists, and HMAC-signed webhooks. Authenticated with an X-API-Key header carrying scoped permissions.

tZERO Institutional API is one of 3 APIs that tZERO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transfer Agent, Tokenization, Custody, Corporate Actions, and Webhooks. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 102 operations across 86 paths, organized into 19 resource areas, and defines 36 schemas. It is described by OpenAPI 3.0.3, at version 1.1.0.

Requests are made against a single base URL, https://api.t0direct.com.

102 operations 86 paths 36 schemas 3 DELETE57 GET3 PATCH36 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1.0
Base URL
https://api.t0direct.com/api/v1
Authentication
API Key
Resource Areas
19

Authentication & Security 1

tZERO Institutional API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated at app.t0kenizer.com/ta/api-keys

Paths & Operations 102

Across 86 paths, the API surfaces 102 operations — 3 DELETE, 57 GET, 3 PATCH, 36 POST, 3 PUT. They span 19 resource areas, including Investors, Securities, Transfers, Issuances, Documents, Webhooks, Settlements, InvestorAccounts, and 11 more. Each is listed below with its method, path, parameters, and response codes.

Investors 5

Investor KYC, accreditation, and holdings management

GET
/api/v1/investors/
List investors
6 params → 200401403
POST
/api/v1/investors/
Create investor
body → 201400401403500
GET
/api/v1/investors/{id}
Get investor
1 param → 200401403404
PATCH
/api/v1/investors/{id}
Update investor
1 param body → 200400401403404
GET
/api/v1/investors/{id}/holdings
Get investor holdings
1 param → 200401403404
Securities 4

Security and instrument definitions

GET
/api/v1/securities/
List securities
4 params → 200401403
GET
/api/v1/securities/{id}
Get security
1 param → 200401403404
GET
/api/v1/securities/{id}/captable
Get cap table
4 params → 200401403404
GET
/api/v1/securities/{id}/holders
List security holders
4 params → 200401403404
Transfers 5

Book-entry transfer requests (secondary)

GET
/api/v1/transfers/
List transfer requests
6 params → 200401
POST
/api/v1/transfers/
Submit transfer request
body → 201400401
GET
/api/v1/transfers/{id}
Get transfer request
1 param → 200401404
POST
/api/v1/transfers/batch
Batch submit transfer requests
body → 201400401
PATCH
/api/v1/transfers/{id}/status
Approve or reject transfer
1 param body → 200400401404
Issuances 5

Primary share issuance requests

GET
/api/v1/issuances/
List issuance requests
5 params → 200401
POST
/api/v1/issuances/
Submit issuance request
body → 201400401
GET
/api/v1/issuances/{id}
Get issuance request
1 param → 200401404
POST
/api/v1/issuances/{id}/approve
Approve issuance request
1 param body → 200401404
POST
/api/v1/issuances/{id}/reject
Reject issuance request
1 param body → 200401404
Documents 6

Investor document upload and retrieval

GET
/api/v1/documents/
List documents
4 params → 200
GET
/api/v1/documents/{id}
Get document
1 param → 200404
DELETE
/api/v1/documents/{id}
Delete document
1 param → 204404
GET
/api/v1/documents/{id}/download
Get short-lived download URL
1 param → 200
POST
/api/v1/documents/upload-url
Request document upload URL
body → 201400503
PUT
/api/v1/documents/upload/{uploadToken}
Confirm document upload
1 param → 200400410
Webhooks 6

Webhook subscription management and event delivery

GET
/api/v1/webhooks/events
List available webhook events
→ 200
GET
/api/v1/webhooks/
List webhook subscriptions
2 params → 200500
POST
/api/v1/webhooks/
Create webhook subscription
body → 201400
PATCH
/api/v1/webhooks/{id}
Update webhook subscription
1 param body → 200404
DELETE
/api/v1/webhooks/{id}
Delete webhook subscription
1 param → 204404
POST
/api/v1/webhooks/{id}/test
Send test webhook event
1 param → 200404
Settlements 10
GET
/api/v1/settlements/
List settlement instructions
→ 200
POST
/api/v1/settlements/
Submit settlement instruction
→ 200
GET
/api/v1/settlements/{id}
Get settlement instruction
1 param → 200
POST
/api/v1/settlements/{id}/approve
Approve settlement instruction
1 param → 200
POST
/api/v1/settlements/{id}/reject
Reject settlement instruction
1 param → 200
POST
/api/v1/settlements/{id}/cancel
Cancel settlement instruction
1 param → 200
POST
/api/v1/settlements/{id}/execute
Manually execute approved settlement
1 param → 200
POST
/api/v1/settlements/{id}/reverse
Create reversal of an executed settlement
1 param → 200
GET
/api/v1/settlements/configs
List settlement configs (issuer + per-security)
→ 200
PUT
/api/v1/settlements/configs
Upsert settlement config (issuer default or per-security override)
→ 200
InvestorAccounts 3
GET
/api/v1/investor-accounts/
List investor accounts
→ 200
POST
/api/v1/investor-accounts/
Create investor account (omnibus parent or sub-account)
→ 200
POST
/api/v1/investor-accounts/{id}/reconcile
Run omnibus reconciliation snapshot (parent vs Σ(children))
1 param → 200
Dividends 7

Dividend declarations (cash & stock) — review-gated; on-chain execution via the dividend claim contract

GET
/api/v1/dividends/
List dividends
→ 200
POST
/api/v1/dividends/
Declare a dividend (enters tZERO review)
→ 200
GET
/api/v1/dividends/{id}
Get a dividend with payment rollups
1 param → 200
GET
/api/v1/dividends/{id}/funding
Get USDC funding deposit instructions for a CASH dividend
1 param → 200
GET
/api/v1/dividends/{id}/reconciliation
Reconcile a dividend: declared vs distributed
1 param → 200
GET
/api/v1/dividends/payment-tokens
List approved payment tokens for a security
→ 200
POST
/api/v1/dividends/{id}/cancel
Cancel a dividend
1 param → 200
Corporate Actions 4

Splits, mergers and other corporate actions — review-gated; on-chain splits broadcast via Fireblocks

GET
/api/v1/corporate-actions/
List corporate actions
→ 200
POST
/api/v1/corporate-actions/
Declare a corporate action (enters tZERO review)
→ 200
GET
/api/v1/corporate-actions/{id}
Get a corporate action
1 param → 200
POST
/api/v1/corporate-actions/{id}/cancel
Cancel a corporate action
1 param → 200
Proposals 5

Shareholder voting — proposal creation and results; off-chain or on-chain (anchored) voting modes

GET
/api/v1/proposals/
List proposals
→ 200
POST
/api/v1/proposals/
Create a voting proposal (enters tZERO review)
→ 200
GET
/api/v1/proposals/{id}
Get a proposal with running tallies
1 param → 200
GET
/api/v1/proposals/{id}/results
Get final results with on-chain anchors
1 param → 200
POST
/api/v1/proposals/{id}/cancel
Cancel a proposal
1 param → 200
Operations 20
POST
/api/v1/iso/fund-orders/subscriptions
→ 200
POST
/api/v1/iso/fund-orders/redemptions
→ 200
POST
/api/v1/iso/fund-orders/subscriptions/cancel
→ 200
POST
/api/v1/iso/fund-orders/redemptions/cancel
→ 200
GET
/api/v1/custody-accounts/accounts
→ 200
GET
/api/v1/custody-accounts/accounts/{accountId}
1 param → 200
GET
/api/v1/custody-accounts/accounts/{accountId}/positions
1 param → 200
GET
/api/v1/custody-accounts/accounts/{accountId}/deposit-addresses
1 param → 200
GET
/api/v1/custody-accounts/accounts/{accountId}/transfers
1 param → 200
POST
/api/v1/custody-accounts/accounts/{accountId}/transfers
1 param → 200
GET
/api/v1/custody-accounts/transfers/{transferId}
1 param → 200
POST
/api/v1/custody-accounts/transfers/{transferId}/approvals
1 param → 200
GET
/api/v1/custody-accounts/accounts/{accountId}/whitelist
1 param → 200
GET
/api/v1/custody-accounts/webhooks
→ 200
POST
/api/v1/custody-accounts/webhooks
→ 200
DELETE
/api/v1/custody-accounts/webhooks/{id}
1 param → 200
GET
/api/v1/custody-accounts/events
→ 200
POST
/api/v1/custody-accounts/events/{id}/replay
1 param → 200
GET
/api/v1/subred/embed/securities/{securityId}/election
1 param → 200
PUT
/api/v1/subred/embed/securities/{securityId}/election
1 param → 200
Tokens 2

Token configurations — the issuer's token blueprints

GET
/api/v1/tokens/
List tokens
3 params → 200401403
GET
/api/v1/tokens/{id}
Get token
1 param → 200401403404
Deployments 3

On-chain instances of tokens and their operation history

GET
/api/v1/deployments/
List deployments
3 params → 200401403
GET
/api/v1/deployments/{id}
Get deployment
1 param → 200401403404
GET
/api/v1/deployments/{id}/operations
List deployment operations
3 params → 200401403404
Vaults 3

Custody vaults and their asset wallets

GET
/api/v1/custody/vaults
List custody vaults
2 params → 200401403
GET
/api/v1/custody/vaults/{id}
Get custody vault
1 param → 200401403404
GET
/api/v1/custody/vaults/{id}/balances
Get live vault balances
1 param → 200401403404503
Custody Transfers 1

Transfers of assets out of custody vaults

GET
/api/v1/custody/transfers
List custody transfers
3 params → 200401403
Whitelist 2

Approved external addresses for custody transfers

GET
/api/v1/custody/whitelist
List whitelisted addresses
2 params → 200401403
GET
/api/v1/custody/whitelist/{id}
Get whitelisted address
1 param → 200401403404
Custody Assets 3

Supported assets, address validation, and fee estimation (live)

GET
/api/v1/custody/supported-assets
List supported assets
→ 200401403503
POST
/api/v1/custody/validate-address
Validate an address
body → 200400401403503
GET
/api/v1/custody/estimate-fee/{assetId}
Estimate network fee
1 param → 200401403503
SubRed Embed 8
POST
/api/v1/subred/sessions
Mint an embed-session token
→ 200
GET
/api/v1/subred/embed/me
Resolve the current embed session
→ 200
GET
/api/v1/subred/embed/securities
List eligible securities
→ 200
GET
/api/v1/subred/embed/wallet
Get investor wallet + buying power
→ 200
POST
/api/v1/subred/embed/subscriptions
Subscribe (buy) with USDC
→ 200
POST
/api/v1/subred/embed/subscriptions/{instructionId}/pay-from-balance
Pay a subscription from custody balance
1 param → 200
GET
/api/v1/subred/embed/orders/{instructionId}/status
Order status
1 param → 200
POST
/api/v1/subred/embed/redemptions
Redeem for USDC
→ 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are def-2 (22 properties), TokenConfig (22 properties), Investor (18 properties), def-10 (18 properties). Each schema is shown below with its type and property counts.

PaginationMeta
object
4 properties
ErrorResponse
object
2 properties
TokenConfig
object
A token configuration (the blueprint). Deployments are its on-chain instances.
22 properties
Deployment
object
An on-chain instance of a token configuration on a specific chain/network.
10 properties
Operation
object
A logged on-chain operation against a deployment (MINT, BURN, TRANSFER, …).
7 properties
CustodyWallet
object
An asset wallet inside a custody vault.
5 properties
CustodyVault
object
A Fireblocks-backed custody vault owned by the issuer.
6 properties
CustodyTransfer
object
A transfer of assets out of a custody vault.
11 properties
WhitelistedAddressAsset
object
4 properties
WhitelistedAddress
object
An external address approved to receive transfers from custody.
9 properties
Investor
object
18 properties
InvestorHolding
object
7 properties
Security
object
18 properties
SecurityHolder
object
7 properties
TransferRequest
object
8 properties
IssuanceRequest
object
17 properties
Document
object
13 properties
WebhookSubscription
object
6 properties
def-0
object
4 properties
def-1
object
2 properties
def-2
object
A token configuration (the blueprint). Deployments are its on-chain instances.
22 properties
def-3
object
An on-chain instance of a token configuration on a specific chain/network.
10 properties
def-4
object
A logged on-chain operation against a deployment (MINT, BURN, TRANSFER, …).
7 properties
def-5
object
An asset wallet inside a custody vault.
5 properties
def-6
object
A Fireblocks-backed custody vault owned by the issuer.
6 properties
def-7
object
A transfer of assets out of a custody vault.
11 properties
def-8
object
4 properties
def-9
object
An external address approved to receive transfers from custody.
9 properties
def-10
object
18 properties
def-11
object
7 properties
def-12
object
18 properties
def-13
object
7 properties
def-14
object
8 properties
def-15
object
17 properties
def-16
object
13 properties
def-17
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tzero-institutional-openapi.json Raw ↑

Other APIs tZERO publishes across the network.

tZERO Issuance & Secondary Markets API
tZERO FIX API
Where this information came from

This is an independent, third-party profile of tZERO Institutional API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.