Private preview of the new site. Not live.

agents.approve

Hosted claim page only: the shop owner whose email the claim names types the agent's 6 digit code, picks one of their shops and accepts the agent key terms. Makes a named agent key for that shop. Optional scopes narrow it further than the agent asked.

WhoHosted page only (a person does it in the browser)
RESTPOST /v1/agent/identity/approve
MCP toolNot an MCP tool
Writesyes, send an Idempotency-Key
AreaSign-in and agent access

When to use it

Hosted claim page only: the shop owner whose email the claim names types the agent's 6 digit code, picks one of their shops and accepts the agent key terms. Makes a named agent key for that shop.

What to tell the owner

Send the person the link. They finish this step themselves on the page; you never do it for them.

Input

FieldTypeRequired
claim_attempt_tokenstringyes
user_codestringyes
shop_idstringyes
scopesarrayno
accept_terms_versionstringyes

Example

POST https://doingwork.work/v1/agent/identity/approve
content-type: application/json
Idempotency-Key: 3f1c...

{
  "claim_attempt_token": "...",
  "user_code": "...",
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "accept_terms_version": "..."
}

Output

FieldTypeAlways there
claimedbooleanyes
key_idstringyes
labelstringyes
scopesarrayyes
{
  "claimed": true,
  "key_id": "00000000-0000-4000-8000-000000000000",
  "label": "...",
  "scopes": [
    "..."
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.