Verify email OTP

Verify the email OTP previously sent for a forgot-password / change-password / signup flow. On success for forgot_password it returns a short-lived Passport access token used to complete the password reset.

Auth: Both — public, no authentication required. Sits in the 10 requests/min per-IP throttle group with no authentication. The endpoint scopes the target by email + type: it looks up the latest User (for change_password/forgot_password) or latest SignupActivation (for rs_signup) by email, then matches the newest unexpired, unverified Otp row of that category. No company/role scoping — any caller who knows the email and a valid OTP can verify. Role only differs in that the returned token is only included for the forgot_password type.

Rate limit: 10 requests/min per IP.

Request

  • Body:
FieldTypeRequiredNotes
typestringyesOne of change_password, forgot_password, rs_signup.
emailstringyesemail:rfc,dns. Must belong to a registered User (change/forgot) or SignupActivation (rs_signup), else 400 "Email address is not registered".
otpstringyesThe code emailed to the user. Compared with hash_equals; 3 failed attempts invalidates the OTP.

Response{ data. } envelope.

  • status (string) — always success on a verified OTP.
  • response (string) — The one time password has been verified successfully.
  • token (string) — Passport personal access token; present ONLY when type=forgot_password (used to authorize the subsequent users/reset/password call). Absent for change_password and rs_signup.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json