Docs
API referenceAttendance

Withdraw a consent

Preview· P9
POST/attendance-evidence/{evidence_id}/withdraw

Records that the person withdrew their consent. New capture of that evidence stops straight away, and a method that needs it is no longer offered to them (they use another method, or the kiosk's fallback). For face, every kiosk is told to delete the person's template. Evidence already recorded is kept until its retention date.

Acknowledgements can't be withdrawn (invalid_state): your organisation requires that evidence. A consent already withdrawn is returned as it is.

Scope: attendance:manage · Plan: Pro and Enterprise in live mode; every plan in test mode.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs 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.

In: header

Scope: attendance:manage

Path Parameters

evidence_id*string

The acknowledgement or consent's ID.

Match^evidence_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"evidence_01m3vb29m0f019htcy61ah5x3g"

Header Parameters

Idempotency-Key*string

A 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.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/attendance-evidence/evidence_01m3vb29m0f019htcy61ah5x3g/withdraw" \  -H "Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64" \  -H "Content-Type: application/json" \  -d '{    "method": "app"  }'
{  "id": "evidence_01m3vbbek0e1yrbf7amce213yh",  "person_id": "person_01kjw4mg80efgb5aqbsqnxhtbh",  "evidence": "selfie",  "kind": "consent",  "notice_version": 1,  "method": "app",  "given_at": "2026-10-01T09:05:00Z",  "recorded_by": "person",  "recorded_by_person_id": "person_01kjw4mg80efgb5aqbsqnxhtbh",  "withdrawn_at": "2026-10-20T16:30:00Z",  "withdrawal_method": "app"}

Record an acknowledgement or consent POST

Records that the person acknowledged the current notice (when your organisation requires the evidence) or consented to it (consent mode), for example from a signed paper form or your HR system. Employees usually do this themselves in the app or at the kiosk. - The record's `kind` follows the notice's basis: `acknowledgement` or `consent`. - Recording the same thing again returns the existing record. - With no published notice for the evidence you get `invalid_state`. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

List watchlist entries GET

Returns your watchlist entries, newest first. Expired entries aren't returned. **Scope:** `watchlist:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.