Docs Navigation
Current: Endpoints
Open all sections
Overview
Getting Started
Role Guides
Compliance & Trust
Developer Reference
More
Home / Documentation / API Endpoints
Endpoint Catalog
Planned endpoints grouped by resource domain. All endpoints are forward-looking until API launch.
Auth
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/csrf-token | Fetch CSRF token for mutations | Planned |
| POST | /v1/auth/register | Register account | Planned |
| POST | /v1/auth/login | Authenticate user | Planned |
| POST | /v1/auth/logout | Terminate active session | Planned |
| GET | /v1/auth/me | Retrieve authenticated profile | Planned |
Offerings
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/offerings | List public offerings | Planned |
| GET | /v1/offerings/:id | Read offering details | Planned |
Subscriptions
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/subscriptions | List investor subscriptions | Planned |
| POST | /v1/offerings/:id/subscribe | Create subscription | Planned |
Distributions
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/distributions | List distribution history | Planned |
Investor
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/investor/profile | Get investor profile + KYC status | Planned |
| GET | /v1/investors/:id/portfolio | Fetch investor portfolio snapshot | Planned |
Webhooks
| Method | Path | Description | Status |
|---|---|---|---|
| GET | /v1/webhooks/endpoints | List webhook endpoints | Planned |
| POST | /v1/webhooks/endpoints | Register webhook endpoint | Planned |
| DELETE | /v1/webhooks/endpoints/:id | Delete webhook endpoint | Planned |
Example: List Offerings
GET /v1/offerings?status=open&page=1&limit=10
Authorization: Bearer YOUR_API_TOKEN
# Response 200 OK
{
"data": [
{
"id": "off_abc123",
"name": "Rental Yield Notes Series 1",
"status": "open",
"template": "A",
"minimum_investment": "10000.00"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"total_pages": 1
}
}Example: Create Subscription
POST /v1/offerings/off_abc123/subscribe
Authorization: Bearer YOUR_API_TOKEN
X-CSRF-Token: <csrf_token>
Content-Type: application/json
{
"amount": "25000.00",
"wallet_address": "0xAbCd..."
}
# Response 201 Created
{
"subscription_id": "sub_xyz789",
"status": "committed",
"cooling_off_expires_at": "2026-03-15T09:00:00Z"
}