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
| Task | Route | Writes to | Guide |
|---|---|---|---|
| Register a cap table deployed elsewhere | POST /issuer/register | MongoDB | Register Issuer |
| Confirm a write landed | GET /historical-transactions/issuer-id/:issuerId | Read only | Read History |
| Add stock legends or stakeholder wallets | POST /stock-legend/create, POST /stakeholder/add-wallet | MongoDB (legends), chain (wallets) | Supporting Records |
| Record that a holder accepted stock | POST /transactions/accept/stock | Chain and history | Accept Stock |
| See who holds what | GET /cap-table/holdings/stock | Read only | View Cap Table |
| Transfer, cancel, retract, reissue, or repurchase stock | POST /transactions/<action>/stock | Chain and history | Transfer, Cancel, and Reissue Stock |
| Change authorized shares | POST /transactions/adjust/issuer/authorized-shares, POST /transactions/adjust/stock-class/authorized-shares | Chain and history, ADMIN key only | Adjust authorized shares |
| Record options, RSUs, SAFEs, or convertible notes | POST /transactions/issuance/equity-compensation, POST /transactions/issuance/convertible | MongoDB | Equity Compensation and Convertibles |
| Record a 409A valuation, vesting terms, or a stock plan | POST /valuation/create, POST /vesting-terms/create, POST /stock-plan/create | MongoDB | Valuations and Terms |
Last updated on