GET /v1/units/{unit_id}/vault-eligibility with the active tap session
once per session, and again whenever you call canVault(). A vault() or
cancelVault() reads it again before it resolves, and every useCanVault
shows the newest answer. Use it to word the
prompt, such as “Vault this item with Alliance Vault?”, and pass its
vault.id to useVault.
Example
Returns
VaultEligibility | null
{ vaultable, vault, requestId }. vault is the brand’s default vault,
{ id, name }, or null when the brand has none. vaultable is true when
the item can go there now: false while it has an open vault request or is
vaulted. requestId is the request its owner can still cancel, which a page
passes to useCancelVault after
a reload, or null when there is none."idle" | "loading" | "ready" | "error"
"idle" without a tap session, "loading" while it reads, then "ready" or
"error". A new tap reads as "loading" until its own answer lands.() => Promise<VaultEligibility>
Reads again for the current tap. Throws when there is no active session.
Error | null
The failure that moved
status to "error", such as not_found.resource
when vaulting is not enabled for this environment.