Sign in
email-verification

Check verification status by email

Same response as GET /email-verification/status/:userId, for callers that only know the email. Includes the dismiss counter and mustVerify. An email with no user row yet returns 200 with tracked: false and zero dismissals; nothing is created by this call.

get/email-verification/status

Query parameters

emailstring required
Example:user@example.com

Response

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

Changed in 2 of the 4 revisions of this API.12

  • 1f6f3b4ce14b11See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      added the required property to the response with the status

      response-required-property-added

  • f7cc9325b5b71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog