API Reference
Complete REST API for the Kimber digital securities platform. Manage investors, offerings, investment lifecycle, token holdings, and compliance — all through a unified API.
Authentication
All endpoints require authentication. Two methods are supported:
Session Cookie
Browser-based authentication via NextAuth. Sign in through the dashboard and session cookies are sent automatically.
API Key
For programmatic access, include the API key in the Authorization header:
Authorization: apiKey {keyId}:{keySecret}Base URL
http://localhost:3000https://api.kimberds.comResponse Format
All responses are JSON. Paginated endpoints return a standard envelope:
{
"totalItems": 142,
"page": 0,
"limit": 50,
"data": [...]
}Error responses follow a consistent format:
{
"error": "Description of what went wrong"
}Auth & Config
Platform configuration and current user profile. Authentication via NextAuth session cookies or API key header.
Investor Onboarding
Register, list, and manage investor records. Supports individual and entity investor types with full profile fields.
KYC / Accreditation / Qualification
Manage verification statuses for investors. KYC handles identity verification, accreditation validates investor qualifications, and qualification checks regulatory eligibility per offering.
Investor Notifications
Send verification and accreditation emails to investors. Trigger identity verification flows and accreditation check requests.
Investment Lifecycle
Full investment flow: pledging, subscription agreements, funding addresses, transactions, and funded amounts. All endpoints require tokenId and roundId context.
Offerings & Token Management
Manage token offerings, fundraise rounds, holders, on-chain transactions, and investor notifications.
Documents & Holdings
Access investor documents (agreements, tax forms, reports) and token holdings across offerings.
Wallet Management
Link and unlink Ethereum-compatible wallets to user accounts.
Issuances
Create and manage token issuances to investor wallets or treasury. Track issuance status and blockchain settlement.
Token Wallets
Manage investor blockchain wallet addresses for token custody. Each investor can have multiple wallets with one designated as primary.
Investor Labels
Tag investors with custom labels for categorization, segmentation, and filtering.
Transfer By Entry (TBE)
Execute internal book-entry transfers of tokens between investors without on-chain settlement.
Token Documents
Manage documents associated with token offerings — prospectuses, term sheets, legal agreements, and regulatory filings.
Blockchain Operations
Advanced blockchain transaction operations including internal transfers, transaction data retrieval, and signing.
Custodians
Manage third-party custodian integrations for institutional asset custody.
Webhooks
Subscribe to platform events via webhooks. Manage event subscriptions and delivery endpoints.
Snapshots
Create point-in-time snapshots of token holder distributions. Used for airdrops, dividends, and governance snapshots.
Opportunities
Manage investment opportunities displayed to investors. Each opportunity can have multiple content sections.
Travel Rule Compliance
Manage investor identification data for cryptocurrency travel rule compliance (FATF recommendations).
Omnibus Wallets
Manage omnibus wallet distributions — allocate tokens held in omnibus custody accounts to individual investors.
Currencies
List available currencies for investment transactions.
Health
Platform health check endpoint. No authentication required.
Kimber API v1 — Built on Plume Network (Chain ID: 98865)