Skip to the page

The mailed code for your agent, its sandbox organisation, its first key (shown once) and the claim link

POST/v1/agents/signups/{signupId}/verify

Operation agents.signupVerify · since 2026-11-10 · beta

Needs a session withwritescopeAnswers201 Createdanswers a secret

`key` (`secret` rka_, shown once), `agent`, `organisation` (your sandbox), `claim.url` and `limits`.

Bearer: the sign-up secret. Five wrong codes end the sign-up.

This answer holds a secret

It is sent with cache-control: no-store and every call is recorded in the organisation's activity. Do not log it.

Path parameters

signupIdstringrequired
From agents.signup.

Body (JSON)

Fields not listed here are refused.

codestringrequired
The 8 letter code from the mail.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:

  • wrong_code
  • code_expired
  • signup_ended
  • unclaimed_limit
POST/v1/agents/signups/{signupId}/verify
curl -X POST "https://api.rykloud.com/v1/agents/signups/$SIGNUP_ID/verify" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "BCDFGHJK"
}'