TOtonewow
email-verification

Check verification status

Changed on

Check if a user email address is verified. Also returns how many times the user dismissed the verify-email prompt and mustVerify, which is true once the dismissal limit is reached.

get/email-verification/status/{userId}

Request

  • Base URL
    https://api.tonewow.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.tonewow.com/email-verification/status/{userId}
  • Auth
    none declared

Path parameters

userIdnumber required
Example:1

User ID to check verification status

Response

Verification status retrieved

successboolean required
userIdnumber nullable required

null when the email has no user row yet (tracked=false)

emailstring required
verifiedboolean required
verifiedAtstring date-time nullable
dismissCountnumber required

Times the user closed the verify-email prompt without verifying

maxDismissalsnumber required

Dismissals allowed before the prompt becomes non-dismissable

remainingDismissalsnumber required

Dismissals the user still has left (0 once verified)

mustVerifyboolean required

True when the email is unverified and the limit is reached: the app must keep the prompt open

lastDismissedAtstring date-time nullable
trackedboolean required

false when the email has no user row yet; counting starts on the first POST /dismiss

messagestring

Example response

{
  "success": true,
  "userId": 123,
  "email": "user@example.com",
  "dismissCount": 2,
  "maxDismissals": 5,
  "remainingDismissals": 3,
  "tracked": true,
  "message": "Dismissal recorded"
}

Changes

  • 1f6f3b4ce14bRevision changes
    • breaking

      the response property became nullable for the status

    • info

      added the required property to the response with the status

  • f7cc9325b5b7Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status