Developers
Institutional-tier API access to the platform: versioned REST under /api/v1, session or sandbox-key authentication (X-Sandbox-Key), idempotency keys on every financial write, and rate limiting. The endpoint list below is generated from this repository's openapi.yaml.
| Method | Path | Description |
|---|---|---|
| POST | /v1/auth/login | Start authentication; returns an MFA challenge |
| POST | /v1/auth/mfa | Complete MFA (sandbox code is 000000) |
| POST | /v1/auth/logout | End the session |
| GET | /v1/customers/me | Current user and customer profile |
| GET | /v1/accounts | List accounts with balances |
| GET | /v1/accounts/{id} | Single account with ledger entries |
| GET | /v1/transactions | Transactions, filterable by account, currency, date, query |
| POST | /v1/transfers | Create and submit a transfer (Idempotency-Key required) |
| GET | /v1/transfers | List transfers |
| GET | /v1/transfers/{id} | Transfer status (lazily advances on provider report) |
| POST | /v1/transfers/{id}/approve | Staff authorization (dual control — two distinct authorizers) |
| GET | /v1/beneficiaries | List beneficiaries |
| POST | /v1/beneficiaries | Create a beneficiary |
| GET | /v1/cards | List cards (last4 + token only) |
| POST | /v1/cards/{id}/freeze | Freeze a card |
| POST | /v1/cards/{id}/unfreeze | Unfreeze a card |
| GET | /v1/statements | Monthly statement list |
| POST | /v1/kyc/documents | Record a document upload (metadata only in sandbox) |
| GET | /v1/notifications | Notifications for the current user |
| POST | /v1/support/tickets | Open a support ticket |
| GET | /v1/fx/quote | FX quote with named reference-rate source |
Sandbox keys are valid only against this demo environment and never against production. API access is enabled per Institutional account after onboarding.