Record a tap and issue a session token

curl --request POST \
  --url https://api2.endstate.io/v1/taps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chip_id": "ABCDEF0123",
  "e": "C78566198547116F3A715DC1C62AF96F"
}
'

import requests

url = "https://api2.endstate.io/v1/taps"

payload = {
    "chip_id": "ABCDEF0123",
    "e": "C78566198547116F3A715DC1C62AF96F"
}
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({chip_id: 'ABCDEF0123', e: 'C78566198547116F3A715DC1C62AF96F'})
};

fetch('https://api2.endstate.io/v1/taps', 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/taps",
  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([
    'chip_id' => 'ABCDEF0123',
    'e' => 'C78566198547116F3A715DC1C62AF96F'
  ]),
  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/taps"

	payload := strings.NewReader("{\n  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\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/taps")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/taps")

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  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\n}"

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

{
  "id": "12345678-1234-4567-8901-234567890abc",
  "session_token": {
    "token": "end_sess_ZW5kc3RhdGUtZXhhbXBsZS1zZXNzaW9uLXRva2VuAAA",
    "expires_at": "2026-05-12T12:44:56.000Z",
    "scope": {
      "chip_id": "ABCDEF0123",
      "unit_id": "7f8a3c10-1111-4111-8111-111111111111",
      "organization_id": "99887766-aabb-4ccd-8eef-001122334455"
    }
  },
  "chip": {
    "chip_id": "ABCDEF0123",
    "scan_count": 47
  },
  "unit": {
    "id": "7f8a3c10-1111-4111-8111-111111111111",
    "external_id": "unit-001",
    "name": "Example Unit",
    "attributes": {
      "custom_attribute": "value"
    },
    "collection": {
      "id": "8e1a7f50-90ab-4cde-8012-3456789abcde",
      "name": "Example Collection",
      "external_id": "collection-001",
      "contract": {
        "address": "0x1111111111111111111111111111111111111111",
        "chain_id": 84532,
        "status": "active"
      },
      "token": {
        "status": "active",
        "serial": 5
      }
    }
  },
  "redirect_url": "https://brand.example/verify/ABCDEF0123",
  "dry_run": false
}

POST

taps

Record a tap and issue a session token

curl --request POST \
  --url https://api2.endstate.io/v1/taps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chip_id": "ABCDEF0123",
  "e": "C78566198547116F3A715DC1C62AF96F"
}
'

import requests

url = "https://api2.endstate.io/v1/taps"

payload = {
    "chip_id": "ABCDEF0123",
    "e": "C78566198547116F3A715DC1C62AF96F"
}
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({chip_id: 'ABCDEF0123', e: 'C78566198547116F3A715DC1C62AF96F'})
};

fetch('https://api2.endstate.io/v1/taps', 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/taps",
  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([
    'chip_id' => 'ABCDEF0123',
    'e' => 'C78566198547116F3A715DC1C62AF96F'
  ]),
  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/taps"

	payload := strings.NewReader("{\n  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\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/taps")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/taps")

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  \"chip_id\": \"ABCDEF0123\",\n  \"e\": \"C78566198547116F3A715DC1C62AF96F\"\n}"

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

{
  "id": "12345678-1234-4567-8901-234567890abc",
  "session_token": {
    "token": "end_sess_ZW5kc3RhdGUtZXhhbXBsZS1zZXNzaW9uLXRva2VuAAA",
    "expires_at": "2026-05-12T12:44:56.000Z",
    "scope": {
      "chip_id": "ABCDEF0123",
      "unit_id": "7f8a3c10-1111-4111-8111-111111111111",
      "organization_id": "99887766-aabb-4ccd-8eef-001122334455"
    }
  },
  "chip": {
    "chip_id": "ABCDEF0123",
    "scan_count": 47
  },
  "unit": {
    "id": "7f8a3c10-1111-4111-8111-111111111111",
    "external_id": "unit-001",
    "name": "Example Unit",
    "attributes": {
      "custom_attribute": "value"
    },
    "collection": {
      "id": "8e1a7f50-90ab-4cde-8012-3456789abcde",
      "name": "Example Collection",
      "external_id": "collection-001",
      "contract": {
        "address": "0x1111111111111111111111111111111111111111",
        "chain_id": 84532,
        "status": "active"
      },
      "token": {
        "status": "active",
        "serial": 5
      }
    }
  },
  "redirect_url": "https://brand.example/verify/ABCDEF0123",
  "dry_run": false
}

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"

Body

application/json

chip_id

string

required

Chip identifier from the tap URL.

Pattern: ^[0-9A-Fa-f]{10}$

Example:

"ABCDEF0123"

string

required

The single-use value from the tap URL. Each one works exactly once.

Pattern: ^[0-9A-Fa-f]{32}$

Example:

"C78566198547116F3A715DC1C62AF96F"

string

Tap verification code (c) from the tap URL. Include it whenever the tag provides one.

Pattern: ^[0-9A-F]{16}$

Example:

"940E8AA6628759B3"

ttl

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.

Required range: 60 <= x <= 3600

Example:

600

dry_run

boolean

Validate the tap without recording it or issuing a session token. Requires an admin secret key.

Example:

false

Response

The session token, its expiry, and the verified unit.

string<uuid> | null

required

Tap identifier. null when dry_run is true, because no tap is recorded.

Example:

"12345678-1234-4567-8901-234567890abc"

session_token

object | null

required

Opaque session token scoped to this organization, chip, unit, and tap. null on dry_run.

Show child attributes

chip

object

required

Show child attributes

unit

object

required

Show child attributes

redirect_url

string<uri> | null

required

Canonical verify URL on the org's verified domain. null when no verified domain exists.

Example:

"https://brand.example/verify/ABCDEF0123"

dry_run

boolean

required

Overview

Endpoints

Record a tap and issue a session token

Authorizations

Headers

Body

Response