Skip to docs content
Browse and search
On this page

Verify an email code

Verify the code. Send acceptTerms true only after the person has read and agreed to https://tweetstream.io/terms. Returns the account's API key, shown once, and a setup proof that lasts 30 minutes.

POST/api/agent/email-code/verify

Body

  • acceptTermsbooleanoptional
  • challengeIdstringrequireda string matching the pattern ^[0-9a-f]{64}$
  • codestringrequireda string matching the pattern ^\d{6}$
  • familyenum<string>optional

Response fields

  • checkoutIdstringoptionala string matching the pattern ^pl_[a-z0-9]{1,64}$
  • familyenum<string>required
  • 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
  • offerobjectoptional
    • amountDueNowobjectrequired
      • currencyenum<string>required
      • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
    • modeenum<string>required
    • planNamestringrequired
    • renewalobjectrequired
      • amountobjectrequired
        • currencyenum<string>required
        • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
      • atstringrequireda string to be decoded into a Date
      • billingCycleenum<string>required
      • thenAmountobjectrequired
        • currencyenum<string>required
        • minorstringrequireda string matching the pattern ^(0|[1-9][0-9]*)$
  • paymentUrlstringoptionala string matching the pattern ^(https|wss):\/\/[^\s]+$
  • reasonenum<string>required
  • statusenum<string>required
  • apiKeystringrequired
  • setupProofstringrequired

Responses

  • 200Success
  • 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