Skip to main content
GET
Retrieve a tap intent

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Path Parameters

tap_intent_id
string
required
Pattern: ^tapi_[0-9a-f]{32}$
Example:

"tapi_3f9c1b7a2d4e4f60a1b2c3d4e5f60718"

Response

The tap intent.

id
string
required
status
enum<string>
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.

Available options:
pending,
approved,
consumed,
canceled,
expired
rule
enum<string>
required
Available options:
own
unit_id
string<uuid>
required
action
object
required
redirect_url
string | null
required
display
object
required
code_required
boolean
required

Whether the person must enter the code to confirm.

scan
object | null
required

The tap the intent was approved with. Null until it is approved.

created_at
string<date-time>
required
expires_at
string<date-time>
required

A tap must arrive by this time. The person can confirm for 10 minutes after their tap.

approved_at
string<date-time> | null
required

When the person approved. Kept on an approval that expired unused.

use_by
string<date-time> | null
required

The approval can be consumed until this time: approved_at plus the use_within set at create. Null until approved.

consumed_at
string<date-time> | null
required

When you consumed the approval. Null until then.

canceled_at
string<date-time> | null
required