Skip to main content
POST
/
api
/
agents
/
claim
Claim an agent
curl --request POST \
  --url https://app.mandate.md/api/agents/claim \
  --header 'Content-Type: application/json' \
  --cookie laravel_session= \
  --data '
{
  "claimCode": "A1B2C3D4"
}
'
{
  "agentId": "9e5f1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
  "claimed": true,
  "claimedAt": "2026-03-26T12:00:00.000000Z"
}

Authorizations

​
laravel_session
string
cookie
required

Laravel Sanctum cookie-based session authentication. Obtained via GitHub OAuth login on the dashboard.

Body

application/json
​
claimCode
string
required

8-character claim code from the agent's claimUrl.

Response

Agent claimed successfully.

​
agentId
string<uuid>
required
​
claimed
enum<boolean>
required
Available options:
true
​
claimedAt
string<date-time>