Platform Features
JWT Authentication
Secure token-based auth with role-based access control for admins, checkers, contributors, and compliance officers.
Background Checks
Search subjects across multiple categories with sensitivity levels, SLA enforcement, and NDPR compliance.
Wallet & Billing
Credit-based wallet system with transaction history, fund top-ups, and per-category unit pricing.
Report Generation
Tamper-proof PDF-ready reports with hashed integrity verification and shareable public IDs.
Dispute Resolution
Structured dispute workflow with SLA deadlines, resolution tracking, and audit trail per dispute.
Audit Logging
Immutable hash-chained audit logs for every sensitive action โ meets NDPR accountability requirements.
Key Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/health | Health check โ service status |
| POST | /api/v1/auth/register | Register a new account |
| POST | /api/v1/auth/login | Login and receive JWT token |
| POST | /api/v1/auth/refresh | Refresh JWT token AUTH |
| POST | /api/v1/auth/logout | Invalidate current token AUTH |
| GET | /api/v1/categories | List active search categories AUTH |
| POST | /api/v1/searches | Initiate a background check AUTH |
| GET | /api/v1/reports/{id} | Retrieve a generated report AUTH |
| POST | /api/v1/disputes | Raise a dispute on a record AUTH |
| GET | /api/v1/wallet | Get wallet balance & transactions AUTH |
Environment
PHP
8.4.19
Laravel
13.2.0
Environment
production
Debug
off
Timezone
UTC