Carries an idempotency key. Retried on network failure, timeout,
429, and 409 idempotency.in_progress - never on a 5xx.
Example
Parameters
string
required
Chip identifier from the tap URL.
string
required
The single-use value from the tap URL. Each one works exactly once.
string
Tap verification code (
c) from the tap URL. Include it whenever the tag provides one.integer | null
Session-token TTL override in seconds, between 60 and 3600 inclusive. Secret key only: a publishable-key caller does not choose how long its own credential lives.
boolean
Validate the tap without recording it or issuing a session token. Requires an admin secret key.
Returns
201 - TapResponse.
string | null
required
Tap identifier. null when dry_run is true, because no tap is recorded.
object | null
required
Opaque session token scoped to this organization, chip, unit, and tap. null on dry_run.
object
required
object
required
string | null
required
Canonical verify URL on the org’s verified domain. null when no verified domain exists.
boolean
required
Errors
Branch onerror.code, never on the HTTP status - several codes share one.
See Errors and retries for the error types and how to narrow them.