Verify POS statistics reveal password (v1)
Method & Path
POST /v1/workspace/:workspaceId/pos/stats-reveal/verify
Description
Checks the dedicated POS statistics reveal password (set via setup). On success the client may show the statistics strip (typically after storing a short-lived flag in sessionStorage).
Authentication
Required: Workspace JWT.
Persona: Workspace Owner (no X-Staff-Id) or Staff with permission store.orders.manage.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <workspace_token> |
Content-Type | Yes | application/json |
X-Staff-Id | If staff | Staff member ID when acting as Staff |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace ID |
Request body
{
"password": "your-secret-pos-stats"
}
| Field | Type | Required | Description |
|---|---|---|---|
password | string | Yes | 1–128 characters (trimmed) |
Response 200 OK
{ "ok": true }
Common errors
- 400 Bad Request: Password not configured yet, or invalid body.
- 401 Unauthorized: Missing/invalid token, or wrong password.
- 403 Forbidden: Missing
store.orders.manage. - 404 Not Found: Workspace not found.