Skip to content

Check a code​

POST
/counter/check

A scanned QR (qr) or six typed digits (code), at this device's location, or at the location a signed-in team member picked (header X-Counter-Location). Answers with the perk and the tier, never the person. Five wrong codes in a row wait a minute; 30 checks a minute per device (or member and location), then 429 rate_limited with retryAfterSeconds.

Authorizations​

or
BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Header Parameters

X-Counter-Location

A signed-in team member's location for this shift. Not sent by a paired device.

Type
string
Format
"uuid"

Request Body​

application/json
JSON
{
"qr": "FHP1:5b0e8d4c-2f1a-4c39-9d77-0a1b2c3d4e5f:59012345:048213",
"code": "string"
}

Responses​

The answer

application/json
JSON
{
"data": "string"
}

Playground​

Server
Headers
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress