Skip to main content

SettleMint Docs

Overview
Overview

Guides

Authentication and API keys
Pagination
Conditional reads
Errors
Versioning and deprecation
Upgrade an integration to 3.2
Idempotency and async settlement
Smart wallet user operations
Onboard an investor
Investor custody choice
Embed a Privy wallet
Sale terms and acknowledgement
Corporate actions
Corporate actions catalogue
Governance votes
Statements and confirmations
Issuer shareholder list
Receive webhooks
Accounting feed
Bank rail API
Files
Feeds
Custody gateway API
Custody gateway stages

Webhooks

Overview
Event catalogue
Market and settlement events
Subscriptions
Lifecycle states
Consuming events

TypeScript SDK

Overview
Migrate from SDK 3.1 to 3.2
Install and configure
Calling routes
Mutations and settlement
Streaming routes
TanStack Query
Browser apps with user sessions
Server-side rendering
React Native
Effect

Errors

CLI

CLI install and setup
CLI commands
CLI for AI agents
Hosted MCP server

Docs for AI agents

Get started Platform Concepts Console Deployment API reference Changelog

API reference
API v1 reference

API v1 reference

This reference shows the versioned API specification. To see the live specification for your deployment, open /api/v1/docs on that deployment.

Read the raw OpenAPI JSON

Loading the interactive API reference…

Trust Center
Status
Investor docs
© SettleMint