Skip to main content
Carries an idempotency key. Retried on network failure, timeout, 429, and 409 idempotency.in_progress - never on a 5xx.

Example

Parameters

string
required
object
required
The action you are about to perform, from your own state. It must equal the action the tap intent was opened with: after the same trimming as at create, type and reference are compared byte for byte.

Returns

200 - TapIntent.
string
required
'pending' | 'approved' | 'consumed' | 'canceled' | 'expired'
required
pending until the person confirms. approved once they have: consume it by use_by. consumed once you have used the approval; it is used once. canceled ended without an approval. expired means nobody approved in time, or the approval was not consumed by use_by. consumed and canceled are final. Approving, canceling and consuming each send a webhook; expiring sends none.
'own'
required
string
required
object
required
string | null
required
object
required
boolean
required
Whether the person must enter the code to confirm.
object | null
required
The tap the intent was approved with. Null until it is approved.
string
required
string
required
A tap must arrive by this time. The person can confirm for 10 minutes after their tap.
string | null
required
When the person approved. Kept on an approval that expired unused.

Errors

Branch on error.code, never on the HTTP status - several codes share one. See Errors and retries for the error types and how to narrow them.