Skip to main content
POST
Poll for the key (returns it exactly once)
Poll this with the device_code from POST /device/code every interval seconds. On approval it returns the live key — once. Persist it immediately.

Polling states

What arrives with the key

  • wallet_balance_cents — spendable balance of the account the key belongs to.
  • sandbox — what the sandbox claim moved, when a zn_test_ key was attached.
  • starter_credit — credit granted alongside the key, if the account earned one, with a few orderable picks it covers.
key and api_key are returned on this response only. Nothing stores the plaintext afterwards, so write it to your credential store before doing anything else.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Body

application/json
device_code
string
required
Required string length: 16 - 128

Response

Successful Response

The issued key, plus what the agent needs to act on it right away.

id
string<uuid>
required
key
string
required
name
string | null
required
is_active
boolean
required
is_test
boolean
required
created_at
string<date-time>
required
wallet_balance_cents
integer
required

Spendable wallet balance of the account the key belongs to.

api_key
string
required
read-only
sandbox
SandboxClaimSummary · object | null

What the sandbox claim moved, when sandbox_key was sent.

starter_credit
StarterCredit · object | null

Wallet credit granted alongside this key, if the account earned one, with a few items it is known to cover.