API Reference

130+ endpoints across 3 microservices. All entity IDs are UUID v7. Protected endpoints require JWT (HttpOnly cookie or Bearer header).

Authentication

JWT in HttpOnly cookies (preferred) or Authorization: Bearer header

Error Format

{ "error": "type:message" }

Pagination

?page=1&per_page=20

Base URLhttp://localhost:8081/api/v1Core API — auth, users, KYC, business, tokens, wallet, admin, PDPL compliance

Authentication

6 endpoints

JWT tokens via HttpOnly cookies. Login returns access_token + refresh_token.

User Profile (/me)

6 endpoints

All endpoints require authentication.

Subscriptions (/me/subscriptions)

3 endpoints

Dividend Payments

1 endpoints

Notifications (/me/notifications)

4 endpoints

Privacy & PDPL (/me)

8 endpoints

PDPL compliance endpoints for data subjects.

Data Rooms

14 endpoints

Document management for issuer due diligence.

KYC

2 endpoints

Business

3 endpoints

Tokens

6 endpoints

Wallet

5 endpoints

Dividends

3 endpoints

Admin — Dashboard

1 endpoints

Admin — Users

9 endpoints

User management, suspension, blocking, onboarding.

Admin — Permissions

3 endpoints

Admin — Sessions & Allocations

4 endpoints

Admin — Trading Limits

3 endpoints

Admin — KYC Review

4 endpoints

Admin — Tokens

9 endpoints

Admin — Wallets & Withdrawals

8 endpoints

Admin — Team

4 endpoints

Admin — Finance

15 endpoints

Admin — Dividends

6 endpoints

Admin — Data Rooms & Businesses

4 endpoints

Admin — Subscriptions & Events

4 endpoints

Admin — Audit & Notifications

3 endpoints

Admin — PDPL Compliance

17 endpoints

Breach management, consent audit, data requests, retention.

Analytics

5 endpoints

Executive dashboard metrics. Requires platform.analytics permission.

Admin — Corporate Actions

8 endpoints

Lifecycle management for stock splits, reverse splits, bonus issues, rights issues, and consolidations.

Admin — Offering Rounds

6 endpoints

Multi-round primary offering management (strategic, institutional, retail).

Admin — NAV Management

3 endpoints

Net Asset Value tracking per token.

Admin — Trading Windows

3 endpoints

Blackout and restricted trading period management.

Admin — Vesting Schedules

3 endpoints

Token vesting schedule management for founders, team, and early investors.

Admin — Referrals

4 endpoints

Referral program management.

User Referrals (/me/referral)

3 endpoints

User-facing referral code management.

Admin — Token Lifecycle

4 endpoints

Token delist, maturity, and batch operations.

Admin — User Accreditation & FATCA

2 endpoints

Regulatory status management for investor qualification.

Admin — Multi-Currency Balances

2 endpoints

Multi-currency wallet balance management (USD, AED, USDC).

Admin — Finance Extended

18 endpoints

Issuer fee configuration, invoices, and reconciliation.

History Tracking

1 endpoints

Status change audit trails for wallet transactions.

Health Check

1 endpoints