Developers

API Documentation

REST API with OpenAPI 3.1 spec. 35+ endpoints across 19 tag groups. JWT authentication. Versioned URIs.

OpenAPI Spec

Machine-readable API specification for code generation and testing.

View openapi.json

Authentication

JWT-based auth with bcrypt password hashing and optional TOTP 2FA.

Authorization: Bearer <token>

Webhooks

Receive real-time notifications for payroll runs, employee changes, and more.

POST /api/v1/webhooks

Endpoint Reference

All endpoints are prefixed with /api/v1

Authentication

3 endpoints
POST /auth/loginPOST /auth/registerPOST /auth/2fa/verify

Employees

4 endpoints
GET /employeesPOST /employeesGET /employees/:idPATCH /employees/:id

Payroll

5 endpoints
POST /payroll/runGET /payroll/payslip/:idGET /payroll/statutory-returns

Salary

4 endpoints
GET /salary-structuresPOST /salary-structuresGET /salary-components

Compliance

4 endpoints
GET /compliance/ptPOST /compliance/ptGET /compliance/lwf

Leave

3 endpoints
GET /leavePOST /leavePATCH /leave/:id

FnF Settlement

3 endpoints
GET /fnfPOST /fnfPATCH /fnf/:id

Global Payroll

2 endpoints
POST /global-payroll/sgPOST /global-payroll/my

ORIS AI

4 endpoints
POST /oris/chatGET /oris/actionsPOST /oris/insight