Skip to main content

Merchant API key

Create a Merchant API key under Business profile → Developers → API Keys. You need the Owner, Admin, or Developer role. The key belongs to the organization, not to the person who created it. For the steps, see Developer Settings.
GET /v1/me returns the key’s orgId, apiKeyId, and permissions. Merchant API keys are server-side credentials.

Permissions

Each Merchant API key has either Full access or Limited access:
  • Full access can call every Merchant API endpoint, including endpoints added later. GET /v1/me shows it as "permissions": []. All existing keys, and keys created from the CLI, have full access. Creating one from the CLI needs a role with every permission.
  • Limited access can call only the endpoints covered by the permissions you choose (table below).
Set the access level when you create or edit a key under Developers → API Keys (how). A change applies from the key’s next request. You can grant only permissions your own role has. To grant Full access, your role needs every permission in the table. In the dashboard, :read permissions are under Can read and :write permissions under Can create and change. A request to an endpoint without its permission returns 403 with the error code INSUFFICIENT_SCOPE. Nothing is created or changed.

Agent Wallet Key

An Agent Wallet Key is a P-256 signing bundle created for one agent wallet:
The CLI signs each Agent Wallet API request. Advanced direct clients send: The signature covers the SHA-256 digest of:
Prefer the CLI unless you specifically need to implement this protocol.

Telemetry key

Agent Traces API keys authorize SDK export to the collector. Store them in environment variables or a secrets manager and redact them from spans.
Never expose any secret in browser code, public source, model prompts, traces, screenshots, or support messages. Rotate a key immediately if its value may have leaked.