Employer Benefits

Access aggregated employee wellness metrics, generate reports for HR teams, and manage benefits configuration. All data is anonymised — no individual PII is exposed through these endpoints.

/api/v1/employer

Endpoints

GET

/api/v1/employer/{org_id}/employeesSoon

List enrolled employees with activation status

GET

/api/v1/employer/{org_id}/wellnessSoon

Get aggregated wellness metrics for the organisation

POST

/api/v1/employer/{org_id}/reportsSoon

Generate a wellness or usage report

GET

/api/v1/employer/{org_id}/reports/{report_id}Soon

Download a generated report

Parameters

Parameter	Type	Required	Description
org_id	string	Required	Employer organisation ID
period_start	string	Optional	ISO 8601 date for report period start
period_end	string	Optional	ISO 8601 date for report period end
format	string	Optional	Report format: pdf, csv, or json (default: json)

Example

Request

http

GET /api/v1/employer/org_acme_001/wellness HTTP/1.1
Host: api.tpay365.com
Authorization: Bearer sk_live_employer_key

Response

json

{
  "org_id": "org_acme_001",
  "total_enrolled": 247,
  "active_users": 231,
  "wellness_metrics": {
    "avg_safe_to_spend_ratio": "0.62",
    "on_time_payment_rate": "0.95",
    "vault_utilisation_rate": "0.87",
    "avg_reliability_score": 82
  },
  "period": "2026-01-01 to 2026-02-10",
  "generated_at": "2026-02-10T14:30:00Z"
}