Skip to docs content
Browse and search
On this page

Request an email code

Email a 6-digit code to the person. The response is the same for new and existing accounts. Ask the person for the code; it never reaches the agent any other way.

POST/api/agent/email-code/request

Body

  • emailstringrequireda string that will be trimmed

Response fields

  • challengeIdstringrequireda string matching the pattern ^[0-9a-f]{64}$
  • expiresAtstringrequireda string to be decoded into a Date
  • nextobjectrequired
    • messagestringoptionala string at most 500 character(s) long
    • actionenum<string>required
    • methodenum<string>required
    • urlstringrequireda string matching the pattern ^(https|wss):\/\/[^\s]+$
    • whoenum<string>required
  • resendAtstringrequireda string to be decoded into a Date
  • statusenum<string>required

Responses

  • 202Success
  • 400Invalid request, wrong code, or the Terms were not accepted
  • 403The account is restricted, or the request carried a foreign Origin
  • 429Rate limit or activation budget reached; retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later