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

'own'
required
Who may open the intent. own opens it on a unit in your own environment.
string
required
The unit the person will tap.
object
required
Opaque to Endstate. Stored with surrounding whitespace trimmed, returned on reads and in webhooks, and compared exactly when you consume.
integer
Seconds the intent waits for a tap. A tap after that does not count.
integer
Seconds after the person approves in which you can consume the approval. Fixed here: use_by is approved_at plus this, and no call extends it.
boolean
Whether the person must enter a code to confirm. On by default: the response carries tap_code for you to show them. Pass false only where the person asking is the person holding the item and a wrong approval costs little, because anyone who taps the item can then confirm.
string
Where the person is sent after they confirm. tap_intent=<id> is added to it. Must be on one of the environment’s allowed origins.
object

Returns

201 - CreatedTapIntent.

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.