Request to vault a unit

curl --request POST \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vault_id": "33333333-3333-4333-8333-333333333333",
  "nonce": "0x1111111111111111111111111111111111111111111111111111111111111111",
  "owner_signature": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
'

import requests

url = "https://api2.endstate.io/v1/units/{unit_id}/vault-requests"

payload = {
    "vault_id": "33333333-3333-4333-8333-333333333333",
    "nonce": "0x1111111111111111111111111111111111111111111111111111111111111111",
    "owner_signature": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
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({
    vault_id: '33333333-3333-4333-8333-333333333333',
    nonce: '0x1111111111111111111111111111111111111111111111111111111111111111',
    owner_signature: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
  })
};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-requests', 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/units/{unit_id}/vault-requests",
  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([
    'vault_id' => '33333333-3333-4333-8333-333333333333',
    'nonce' => '0x1111111111111111111111111111111111111111111111111111111111111111',
    'owner_signature' => '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
  ]),
  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/units/{unit_id}/vault-requests"

	payload := strings.NewReader("{\n  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\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/units/{unit_id}/vault-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-requests")

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  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n}"

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

{
  "id": "00000000-0000-4000-8000-000000000000",
  "unit_id": "22222222-2222-4222-8222-222222222222",
  "vault": {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "Alliance Vault",
    "logo_url": "https://vault.example/logo.png",
    "key_mode": "managed"
  },
  "status": "pending",
  "notes": null,
  "rejection_reason": null,
  "decided_at": null,
  "available_at": null,
  "hold": null,
  "ready_to_ship": false,
  "dispatched_at": null,
  "expires_at": "2026-07-15T12:00:00.000Z",
  "created_at": "2026-06-15T12:00:00.000Z"
}

POST

units

{unit_id}

vault-requests

Request to vault a unit

curl --request POST \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vault_id": "33333333-3333-4333-8333-333333333333",
  "nonce": "0x1111111111111111111111111111111111111111111111111111111111111111",
  "owner_signature": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
'

import requests

url = "https://api2.endstate.io/v1/units/{unit_id}/vault-requests"

payload = {
    "vault_id": "33333333-3333-4333-8333-333333333333",
    "nonce": "0x1111111111111111111111111111111111111111111111111111111111111111",
    "owner_signature": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
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({
    vault_id: '33333333-3333-4333-8333-333333333333',
    nonce: '0x1111111111111111111111111111111111111111111111111111111111111111',
    owner_signature: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
  })
};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-requests', 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/units/{unit_id}/vault-requests",
  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([
    'vault_id' => '33333333-3333-4333-8333-333333333333',
    'nonce' => '0x1111111111111111111111111111111111111111111111111111111111111111',
    'owner_signature' => '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
  ]),
  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/units/{unit_id}/vault-requests"

	payload := strings.NewReader("{\n  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\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/units/{unit_id}/vault-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-requests")

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  \"vault_id\": \"33333333-3333-4333-8333-333333333333\",\n  \"nonce\": \"0x1111111111111111111111111111111111111111111111111111111111111111\",\n  \"owner_signature\": \"0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n}"

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

{
  "id": "00000000-0000-4000-8000-000000000000",
  "unit_id": "22222222-2222-4222-8222-222222222222",
  "vault": {
    "id": "33333333-3333-4333-8333-333333333333",
    "name": "Alliance Vault",
    "logo_url": "https://vault.example/logo.png",
    "key_mode": "managed"
  },
  "status": "pending",
  "notes": null,
  "rejection_reason": null,
  "decided_at": null,
  "available_at": null,
  "hold": null,
  "ready_to_ship": false,
  "dispatched_at": null,
  "expires_at": "2026-07-15T12:00:00.000Z",
  "created_at": "2026-06-15T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer end_sess_* for V2 browser session tokens (e.g. end_sess_ZW5kc3RhdGUtZXhhbXBsZS1zZXNzaW9uLXRva2VuAAA).

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

unit_id

string<uuid>

required

Body

application/json

vault_id

string<uuid>

required

The vault to hold the item. It must be the brand's default vault or another vault the brand allows.

nonce

string

required

The 32-byte nonce in the owner's signed approval.

Pattern: ^0x[0-9a-fA-F]{64}$

owner_signature

string

required

The owner's signature over the approval.

Pattern: ^0x(?:[0-9a-fA-F]{2})+$

Response

The pending vault request.

string<uuid>

required

unit_id

string<uuid>

required

vault

object

required

Show child attributes

status

enum<string>

required

Available options:

pending,

submitted,

active,

unvault_waiting,

unvaulting,

unvaulted,

cancelled,

expired,

rejected,

failed

notes

string | null

required

rejection_reason

enum<string> | null

required

Why the request was rejected: the vault's reason, or owner_changed when the unit changed hands after its owner approved.

Available options:

wrong_item,

chip_unreadable,

unacceptable,

owner_changed,

null

decided_at

string<date-time> | null

required

available_at

string<date-time> | null

required

hold

object | null

required

Show child attributes

ready_to_ship

boolean

required

Whether the item is ready to ship: its waiting period has ended and nothing holds it. The vault records dispatch with a tap of the item from then on.

dispatched_at

string<date-time> | null

required

When the vault's tap recorded the item's dispatch. Endstate then completes the unvault; the vault hands the item over once the request reads unvaulted.

expires_at

string<date-time> | null

required

When a pending request expires; null once it has moved on.

created_at

string<date-time>

required

Overview

Endpoints

Request to vault a unit

Authorizations

Headers

Path Parameters

Body

Response