Skip to main content
POST
Claim a sandbox into your account
Folds a provisional sandbox into the authenticated account. This is what the claim_url from the mint response leads to: a human signs in, and the agent’s sandbox becomes part of their Zinc account. Claiming is always a merge — signing in creates the account if it didn’t exist, so by the time this endpoint runs there is always a real account to merge into.

What moves

The response reports the counts (orders_moved, keys_moved) plus a human-readable message.
Not revoking the key is the whole point of claiming rather than starting over. An agent that has been running against a sandbox for a week doesn’t need redeployment to keep going.

Errors

The claim token is returned once, in the claim_url at mint time — only its hash is stored, so the URL cannot be regenerated. If it’s lost, mint a new sandbox.

After claiming

A claimed key still only reaches the sandbox. To place real orders, the account owner mints a zn_live_ key in the dashboard and funds a wallet. The agent can confirm the claim landed with GET /sandbox/status.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Body

application/json

The raw claim token from a claim URL.

token
string
required
Required string length: 1 - 128

Response

Successful Response

What a completed claim moved onto the account.

claimed
boolean
required
orders_moved
integer
required
keys_moved
integer
required
message
string
required