API Reference
Versioned REST API with OpenAPI 3.0 documentation.
The OrvexCore REST API exposes every platform operation — from student enrollment to fee collection and event subscriptions. All endpoints are versioned, authenticated via JWT, and documented with request/response examples.
What's covered
Authentication
JWT Bearer token authentication with short-lived access tokens and refresh token rotation.
Fees & Invoices
Endpoints for invoice generation, payment recording, reconciliation, and outstanding balance queries.
Students & Enrollment
Full student lifecycle API — registration, class assignment, guardian linking, and record updates.
Payments
Payment recording, receipt generation, refund processing, and payment attempt history.
Academics
Academic year and term management, class levels, subject assignments, and attendance records.
Notifications
Trigger targeted notifications and bulk communications via the notifications API.