Registration tools

Register and renew domains, read the org balance, and poll pending confirmations.

These tools spend money. Every state-changing call routes through the agent confirmation pipeline — when the action exceeds the user’s threshold or registers ≥5 domains in one call, the response is status: "pending_confirmation" with a token and approve_url.

The user must approve out-of-band. Call again with the same request_id after approval to execute.

register_domains

Register one or more domains for the org.

Required scope: domains:write.

org_oid string path required
domains string[] path required
List of domain names.
years integer path default: 1
1–10.
request_id string path
Client idempotency key. Same id replays the original ActionLog row instead of registering twice.
intent string path
Free-text rationale; logged as a hash for audit.
funding string path default: balance
balance debits the prepaid org balance (auto-tops-up if configured); card charges the saved default card directly.
status string
completed, pending_confirmation, duplicate, failed, requires_action (3DS).
confirmation object
Present when pending_confirmation: oid, token, expires_at, amount_cents, approve_url.
result object
Per-domain outcome on success.
error string
Present on failed.

renew_domain

Renew one domain.

Required scope: domains:write.

org_oid string path required
domain string path required
years integer path default: 1
1–10.
request_id string path
intent string path

Same response shape as register_domains. Only balance funding is supported.

get_balance

Required scope: orgs:read.

org_oid string path required
balance_cents integer
balance_aud number
auto_topup_enabled boolean
auto_topup_threshold_cents integer
auto_topup_amount_cents integer
default_payment_method_id string

list_my_confirmations

The caller’s pending confirmations. Use after a pending_confirmation response to poll for status, or to surface a list of “things waiting on you” to the user.

Required scope: orgs:read.

oid string
token string
action string
amount_cents integer
expires_at string
approve_url string
Last updated Edit this page
↑↓ navigate open esc close