OpenAPI 3.0 Specificationv1.0 Launch Ready

CoreFlow API Documentation

Production-grade RESTful API reference for multi-sig payroll escrows, Ed25519 auth, and Soroban integration.

← Dashboard

Raw OpenAPI JSON Endpoint

Import directly into Postman, Insomnia, or Swagger UI

View OpenAPI JSON

Core Endpoints Overview

POST/api/auth/challenge

Generates a 5-minute single-use Ed25519 signing challenge for Freighter wallet verification (SEP-53).

POST/api/auth/verify

Verifies Freighter SEP-53 challenge signature, upserts user record, and sets secure HttpOnly cookie.

GET/api/escrowsCursor Paginated

Fetches paginated escrow records using ?limit=10&cursor=ID. EMPLOYEES see only their own escrows; ADMINS see all.

POST/api/admin/invitationsAdmin Only

Creates a time-limited invitation token for employee onboarding and records an AuditLog.

POST/api/admin/contract/pauseCircuit Breaker

Toggles the Soroban smart contract emergency stop circuit breaker.