Consume a tap intent

curl --request POST \
  --url https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": {
    "type": "listing.confirm",
    "reference": "listing_8271"
  }
}
'

import requests

url = "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume"

payload = { "action": {
        "type": "listing.confirm",
        "reference": "listing_8271"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: {type: 'listing.confirm', reference: 'listing_8271'}})
};

fetch('https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => [
        'type' => 'listing.confirm',
        'reference' => 'listing_8271'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume"

	payload := strings.NewReader("{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "tapi_3f9c1b7a2d4e4f60a1b2c3d4e5f60718",
  "status": "consumed",
  "rule": "own",
  "unit_id": "6f1d2c3b-4a59-4e68-9f70-8a1b2c3d4e5f",
  "action": {
    "type": "listing.confirm",
    "reference": "listing_8271"
  },
  "redirect_url": "https://app.example.com/listings/8271/confirm",
  "display": {
    "title": "Confirm your listing"
  },
  "code_required": true,
  "scan": {
    "id": "0b8e6a54-93c2-4d17-8f5e-2a1b3c4d5e6f",
    "scanned_at": "2026-11-10T17:03:40.000Z"
  },
  "created_at": "2026-11-10T17:02:11.000Z",
  "expires_at": "2026-11-10T17:07:11.000Z",
  "approved_at": "2026-11-10T17:04:02.000Z",
  "use_by": "2026-11-10T17:09:02.000Z",
  "consumed_at": "2026-11-10T17:04:05.000Z",
  "canceled_at": null
}

Tap intents

Consume a tap intent

Uses an approved tap intent, once, and sends tap_intent.consumed. Call it from your server before you perform the action the person approved, with the action you are about to perform: it must equal the action the tap intent was opened with. It succeeds for one request, until use_by. Send an Idempotency-Key you have stored: a retry with the same key and the same secret key returns the consumed tap intent again with Idempotent-Replayed: true, also after use_by. Any other request gets tap_intent.already_consumed, with details.consumed_at, and must not act.

POST

tap-intents

{tap_intent_id}

consume

Consume a tap intent

curl --request POST \
  --url https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": {
    "type": "listing.confirm",
    "reference": "listing_8271"
  }
}
'

import requests

url = "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume"

payload = { "action": {
        "type": "listing.confirm",
        "reference": "listing_8271"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: {type: 'listing.confirm', reference: 'listing_8271'}})
};

fetch('https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => [
        'type' => 'listing.confirm',
        'reference' => 'listing_8271'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume"

	payload := strings.NewReader("{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/tap-intents/{tap_intent_id}/consume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": {\n    \"type\": \"listing.confirm\",\n    \"reference\": \"listing_8271\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "tapi_3f9c1b7a2d4e4f60a1b2c3d4e5f60718",
  "status": "consumed",
  "rule": "own",
  "unit_id": "6f1d2c3b-4a59-4e68-9f70-8a1b2c3d4e5f",
  "action": {
    "type": "listing.confirm",
    "reference": "listing_8271"
  },
  "redirect_url": "https://app.example.com/listings/8271/confirm",
  "display": {
    "title": "Confirm your listing"
  },
  "code_required": true,
  "scan": {
    "id": "0b8e6a54-93c2-4d17-8f5e-2a1b3c4d5e6f",
    "scanned_at": "2026-11-10T17:03:40.000Z"
  },
  "created_at": "2026-11-10T17:02:11.000Z",
  "expires_at": "2026-11-10T17:07:11.000Z",
  "approved_at": "2026-11-10T17:04:02.000Z",
  "use_by": "2026-11-10T17:09:02.000Z",
  "consumed_at": "2026-11-10T17:04:05.000Z",
  "canceled_at": null
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Unique key that makes this request safe to retry. Replaying the key with the same body returns the original response with Idempotent-Replayed: true; replaying it with a different body returns 409 idempotency.key_conflict.

Required string length: 1 - 255

Example:

"a1b2c3d4-0000-4000-8000-000000000000"

Path Parameters

tap_intent_id

string

required

Pattern: ^tapi_[0-9a-f]{32}$

Example:

"tapi_3f9c1b7a2d4e4f60a1b2c3d4e5f60718"

Body

application/json

action

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.

Show child attributes

Response

The consumed tap intent.

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

Show child attributes

redirect_url

string | null

required

display

object

required

Show child attributes

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.

Show child attributes

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

Overview

Endpoints

Consume a tap intent

Authorizations

Headers

Path Parameters

Body

Response