Retried on network failure, timeout,
429, and 5xx.
Example
Parameters
string
required
Unit id.
Returns
200 - VaultEligibility.
boolean
required
Whether the owner can vault the item into
vault now: the unit is issued, its collection is active, it is not vaulted and has no open vault request, and the vault takes new items. Ownership is checked when the owner approves.object | null
required
The brand’s default vault, where a vaulted item goes. Null when the brand has none that takes new items.
string | null
required
The item’s vault request while its owner can still cancel it, so a page finds it again after a reload. Null when there is none, including once the item is vaulted.
Errors
Branch onerror.code, never on the HTTP status - several codes share one.
See Errors and retries for the error types and how to narrow them.