Skip to main content
Allowlist rules are the deny-by-default constraints the policy decision point evaluates before any share is released. You manage them over the admin API at /v1/admin/allowlist-rules. Rules are org-bound, so a key only ever sees and changes its own organization’s rules.
Admin API availability is per-environment. Confirm the endpoint is exposed for your environment before you wire it into an onboarding flow.

How rules gate signing

Creating the first active rule flips the org to deny-by-default; deactivating the last flips it back to allowlist-passes. See Policy Gates. Every operation is typed into one operation type, and a rule targets exactly one. See Policy Gates → Typed Operations for the full list and selectors.

Rule anatomy

See Policy Gates → Rule Anatomy for field semantics. Admin-API specifics: chain synonyms are canonicalized (a rule written as bsc matches intents that resolve to smartchain); amountCap is a decimal string in base units; expiresAt is a required RFC 3339 timestamp in the future. Native-transfer rules must omit contractAddress and methodSelector; every other operation type must carry both, or the create is rejected as a structured 400.

Create a rule

POST /v1/admin/allowlist-rules. The example below admits ERC-20 transfers of a specific token, to a pinned destination, capped at 1,000,000,000 base units (1000 USDC at 6 decimals), expiring at a fixed time.
A native-transfer rule omits the contract fields.
Match fields are trimmed and lowercased before storage — see Policy Gates → Rule Anatomy.

List rules

GET /v1/admin/allowlist-rules. Returns the org’s rules.

Deactivate a rule

DELETE /v1/admin/allowlist-rules/{id}. Deactivation is org-bound. Another org’s rule id, or an already-inactive one, uniformly reads as not found, so the endpoint never leaks whether a rule exists in another organization.

Every change is audited

Each create and each deactivation writes a full snapshot of the rule to the audit log, traceable to the key that made the change. The snapshot is written on deactivation too, so the record of what stopped being enforceable survives even after the rule is gone. Rule changes decide what the cosigner will sign, so they are recorded to be traceable and alertable. See Policy Decisions for how the decisions those rules drive are recorded.

Policy Decisions

How each evaluated intent is stamped and recorded, including denials.

Policy Gates

The deny-by-default rule model these rules feed.

Signing Intents

How a cleared decision unlocks one signature.

Structured Errors

The error a rejected rule or a denied intent returns.