Skip to main content

API Keys

Partner API keys authenticate server-to-server requests for wallet provisioning and token deploys. Keys are scoped to your organization and passed via the X-Partner-Key header.

Key Format​

bk_ptr_<keyId>_<secret>
  • keyId — 8-character identifier
  • secret — 32-character secret (hashed at rest, never stored in plaintext)

The full key is only returned once at creation time. Store it securely.

Managing Keys​

Owners and admins generate, rotate, and revoke partner keys from the Partner Keys tab in your partner dashboard. You can create up to 5 active keys per organization.

When generating a key:

  • Name — 3–64 characters, for your own reference
  • IP allowlist — optionally restrict the key to specific IP addresses
Save your secret

The full key is only shown once after creation. Copy and store it securely — you cannot retrieve it later.

Revoked keys stop working immediately. This cannot be undone — generate a new key if needed. Rotate Key (in the key's settings) replaces a key in one step: the new secret keeps the name and IP allowlist and is shown once, and the old key stops working immediately.


Using a Partner Key​

Include the key in the X-Partner-Key header on every server-to-server request:

curl -X POST https://api.bankr.bot/partner/wallets \
-H "Content-Type: application/json" \
-H "X-Partner-Key: bk_ptr_AbC12345_xYzSecretKeyValue1234567890ab" \
-d '{ ... }'

Errors​

StatusErrorCause
401Partner API key requiredMissing X-Partner-Key header
401The provided partner API key is invalid or inactiveKey not found, revoked, or wrong secret
403IP address not allowed for this partner API keyRequest IP not in allowedIps
403The partner organization associated with this key is inactiveOrg deactivated

IP Allowlisting​

When an IP allowlist is set on a key, only requests from those IPs are accepted. Supports individual IPs and CIDR ranges (e.g., 10.0.0.0/24). IPv6-mapped IPv4 addresses (e.g., ::ffff:192.168.1.1) are automatically normalized.

Minimum CIDR prefix lengths are enforced: /8 for IPv4, /16 for IPv6. Overly broad ranges (e.g., 0.0.0.0/0) are rejected.

Update a partner key's allowlist from the key's settings in the partner dashboard (owner or admin).


Wallet API Keys​

Provisioned wallets carry their own keys (bk_usr_{keyId}_{secret}), separate from partner keys. Each one authenticates a single wallet's traffic to the Wallet API, Agent API, token launches, and LLM Gateway. A wallet can hold up to 20 active keys, and you list, create, update, rotate, and revoke them with your partner key — see Wallet Provisioning.