Private preview of the new site. Not live.

agents.claim

auth.md claim. Pass your claim_token and the email of the shop owner who should claim you. You get a 6 digit user_code and a verification_uri: tell the person to open the link, sign in with that email and type the code. Then poll the token endpoint with grant_type urn:workos:agent-auth:grant-type:claim. Calling again with the same claim_token starts a fresh code and cancels the old one.

WhoAgents can call this
RESTPOST /v1/agent/identity/claim
MCP toolagents_claim
Writesyes, send an Idempotency-Key
AreaSign-in and agent access

When to use it

auth.md claim. Pass your claim_token and the email of the shop owner who should claim you.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
claim_tokenstringyes
emailstringyes

Example

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

{
  "claim_token": "...",
  "email": "owner@example.com"
}

Output

FieldTypeAlways there
registration_idstringyes
claim_attempt_idstringyes
statusstring (one of initiated)yes
expires_atstring (date-time)yes
claim_attemptobjectyes
claim_attempt.user_codestringyes
claim_attempt.expires_inintegeryes
claim_attempt.verification_uristringyes
claim_attempt.intervalintegeryes
{
  "registration_id": "00000000-0000-4000-8000-000000000000",
  "claim_attempt_id": "00000000-0000-4000-8000-000000000000",
  "status": "initiated",
  "expires_at": "...",
  "claim_attempt": {
    "user_code": "...",
    "expires_in": 1,
    "verification_uri": "...",
    "interval": 1
  }
}

Errors

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