Returns the book’s access settings: the delivery mode, the buyer and seller gates, and how a refused wallet is onboarded. Name a wallet to learn whether it may buy and sell, and how it gets admitted if not. See Access module.The gates are read live from the custody contract for the book’s settlement operator, so the answer is what a settlement would enforce right now. Works on books you own and books you have imported.
Path Parameters
string
required
Order book ID.
Query Parameters
string
Wallet to check. Omit for the settings only.
Response Fields
object
Show child attributes
string
Order book ID.
boolean
Whether the book’s custody contract carries the access module. False on generation 1, where no gates exist. The wallet check still runs there: a buyer must be verified on the security’s identity registry, and a seller is always admitted.
integer
Custody contract generation: 1 or 2.
string
AGENT or TRANSFER, or null when the security is not registered.
string
The security’s own identity registry, or null when it has none.
object
The buyer gate.
Show child attributes
string
The gate saved for the book, or the one on chain when none is saved. null for none.
string
The gate on chain for the settlement operator, or null.
object
Owning instance only. The verification profile behind the gate: key, name, entityType, professionalOnly and requirementsHash, or only key. null when the gate is not a profile register.
object
Owning instance only. The whitelist behind the gate: id, name, purpose, address, ownerWallet and own, or only id. null when the gate is not a whitelist.
object
The seller gate, same shape as buyer.
object
Show child attributes
string
NONE, VERIFICATION_SERVICE, ID_LINK or INTEGRATION.
string
The venue’s own onboarding page in INTEGRATION mode, otherwise null.
boolean
Whether the gates on chain match the ones saved for the book. Always true on generation 1.
boolean
True when the security has no identity registry, so the book needs a buyer gate before anyone can buy.
object
Present only when wallet was supplied.
Show child attributes
string
The wallet, lower-cased.
object
admitted, code and reason. code is 0 when admitted, otherwise the check that refused it, as listed on Submit Order.
object
Same shape, for selling.
object
How the wallet gets admitted, when it is refused by the identity registry or a gate and the book names an onboarding route. Same shape as on Submit Order.