Skip to Content
API GuidesAPI Guides

API Guides

These guides cover API work beyond the Development Guide: registering existing cap tables, confirming writes, supporting records, and corporate actions. Every route and field is listed in the API Reference.

The examples use $API and $ISSUER_ID from Create an Issuer. Routes that write onchain sign with the server key, which needs a role on the cap table; see Server-signed routes.

Find a task

TaskRouteWrites toGuide
Register a cap table deployed elsewherePOST /issuer/registerMongoDBRegister Issuer
Confirm a write landedGET /historical-transactions/issuer-id/:issuerIdRead onlyRead History
Add stock legends or stakeholder walletsPOST /stock-legend/create, POST /stakeholder/add-walletMongoDB (legends), chain (wallets)Supporting Records
Record that a holder accepted stockPOST /transactions/accept/stockChain and historyAccept Stock
See who holds whatGET /cap-table/holdings/stockRead onlyView Cap Table
Transfer, cancel, retract, reissue, or repurchase stockPOST /transactions/<action>/stockChain and historyTransfer, Cancel, and Reissue Stock
Change authorized sharesPOST /transactions/adjust/issuer/authorized-shares, POST /transactions/adjust/stock-class/authorized-sharesChain and history, ADMIN key onlyAdjust authorized shares
Record options, RSUs, SAFEs, or convertible notesPOST /transactions/issuance/equity-compensation, POST /transactions/issuance/convertibleMongoDBEquity Compensation and Convertibles
Record a 409A valuation, vesting terms, or a stock planPOST /valuation/create, POST /vesting-terms/create, POST /stock-plan/createMongoDBValuations and Terms
Last updated on