Review a punch whose face wasn't verified
Accepts or rejects a fallback punch (PIN, QR, NFC or supervisor-assisted) after a failed face match: its face_check is
not_verified and its review.status is pending. These punches form the review queue
(GET /attendance/events?review_status=pending) and are counted in the summary until reviewed.
acceptedkeeps the punch.rejectedvoids it: it no longer appears or counts.- A punch that isn't awaiting review returns
invalid_state.
Scope: attendance:manage · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: attendance:manage
clock_id*stringThe attendance event's ID.
^clock_[0-7][0-9a-hjkmnp-tv-z]{25}$"clock_01m4wq6yw0ez5srdzr46tftpah"Idempotency-Key*stringA UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidapplication/json- body
outcome*stringaccepted keeps the punch; rejected voids it.
"accepted""rejected"note?stringlength <= 500The reviewed punch.
application/json- response
One punch: a clock-in or clock-out, or a break punch where break punches are on.
id*AttendanceEventIdAn attendance event ID (TypeID with the clock prefix).
^clock_[0-7][0-9a-hjkmnp-tv-z]{25}$"clock_01m4wq6yw0ez5srdzr46tftpah"person_id*PersonIdA person ID (TypeID with the person prefix).
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"site_id*SiteIdA site ID (TypeID with the site prefix).
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"kind*AttendanceKindclock_in and clock_out; and, where your organisation has break punches on, break_start and break_end: a
break inside a clock-in, which never ends the stretch it sits in.
"clock_in""clock_out""break_start""break_end"break_type?stringOn break punches only: rest (a break, paid or unpaid as your organisation's rules say) or nursing (the paid nursing hour, never deducted).
"rest""nursing"method*AttendanceMethodHow the punch was made: qr (the kiosk scanned a staff QR badge), phone_badge (the kiosk scanned the
staff badge on the person's phone, in the Workspace app), rotating_qr (a phone scanned the kiosk's code,
which changes every 30 seconds), pin, nfc (card or tag), face (face match on a kiosk), geofence
(a phone inside the site's area, or on its Wi-Fi), terminal (your own system, through the API) or
assisted (after a failed face match, a supervisor at the kiosk confirmed who it was; always
face_check: not_verified) or manual (added in the Console by a manager for a punch the person missed, or to
correct a punch's time, always with a reason: see added).
"qr""phone_badge""rotating_qr""pin""nfc""face""geofence""terminal""assisted""manual"occurred_at*stringWhen the punch happened.
date-timerecorded_at*stringWhen Agoo received it.
date-timedevice_id*|The kiosk used, if any.
^dev_[0-7][0-9a-hjkmnp-tv-z]{25}$terminal_reference*|Your terminal's identifier, for terminal punches.
shift_id*|The shift this punch counts towards.
^shift_[0-7][0-9a-hjkmnp-tv-z]{25}$late_minutes*|For a late clock-in, minutes after the shift start. Otherwise null.
0 <= valueoffline*booleantrue if the punch was made offline and synced later.
selfie_file_id?stringThe selfie taken with the punch (a selfie file). Only on punches that have one.
^file_[0-7][0-9a-hjkmnp-tv-z]{25}$location?A phone's location check against the site's geofence. latitude and longitude appear only when your
organisation keeps coordinates, and only until its coordinate retention clears them; the result and accuracy
stay with the punch.
wifi?The Wi-Fi check: whether the phone was on one of the site's networks. ssid and bssid appear only when your organisation keeps them.
face_check?stringmatched on face punches (the kiosk's match). not_verified on a fallback after a failed face match
(PIN, QR, NFC or assisted). Only on those punches. Agoo never receives face images or templates.
"matched""not_verified"review?A supervisor's review of a punch made after a failed face match.
added?Who added the punch in the Console, and why. Only on manual punches.
voided?Why the punch stopped counting. Only in attendance.voided events: lists and other events never include voided punches.
curl -X POST 'https://api.agoohq.com/v1/attendance/events/clock_01m4wq6yw0ez5srdzr46tftpah/review' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \ -H 'Content-Type: application/json' \ -d '{ "outcome": "accepted", "note": "Bandaged hand; confirmed in person."}'{ "id": "clock_01m4xnzdsreh7a3gbm0xtrx108", "person_id": "person_01kjw4mg80efgb5aqbsqnxhtbh", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "kind": "clock_in", "method": "pin", "occurred_at": "2026-10-15T07:56:10Z", "recorded_at": "2026-10-15T07:56:11Z", "device_id": "dev_01kjywram0esxva8np5wzj6fre", "terminal_reference": null, "shift_id": "shift_01kn6pqfm0fmasbh61jnr3syze", "late_minutes": null, "offline": false, "face_check": "not_verified", "review": { "status": "accepted", "reviewed_at": "2026-10-15T09:12:00Z", "reviewed_by": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "note": "Bandaged hand; confirmed in person.", "at_kiosk": false }}List shifts GET
Returns your shift patterns, sorted by name. Shift times are local times in the site's time zone. Agoo uses them, with the grace period, to decide who is late, and a shift's own break (`break_kind` and `break_minutes`) to count worked time; a shift without one follows your organisation's standard day. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Get attendance settings GET
Returns how people may clock in across your organisation, the evidence each punch records, the current notice and basis for each evidence type, and how long selfies and coordinates are kept. - **Methods:** `qr` (the kiosk scans a staff QR badge), `phone_badge` (the kiosk scans the staff badge the Workspace app shows, which changes every 30 seconds), `rotating_qr` (a phone scans the kiosk's code, which changes every 30 seconds), `pin`, `nfc`, `face` (on a kiosk), `geofence` (a phone inside the site's area) and `terminal` (your own terminal, through the API). At least one is on; sites can change them. A method that's off isn't offered, with one exception: after a failed face match the kiosk offers a fallback (PIN, a badge, NFC or a supervisor-assisted punch, method `assisted`), recorded `face_check: not_verified` for review, so nobody is ever locked out. - **Evidence** (face, selfie, location) is off until you switch it on, and each type needs a published notice. Its `basis` is `required` (your organisation requires it under its legal basis; employees acknowledge the notice and capture goes ahead either way) or `consent` (captured only for people who consented). **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.