Verify OTP
OTP
Verify OTP
Validate an OTP sent via Generate OTP (email-based).
POST
Verify OTP
Validates the OTP entered by the member against the one dispatched via Generate OTP. The
OtpType must match what was used in the generate call. A successful response confirms the member’s identity for the specified action (login, password reset, etc.).
OTPs are time-limited and single-use. The expiry duration and maximum incorrect attempt limit are both configurable at the program level — confirm these values with your Xoxoday implementation contact so your UI timer and lockout handling match. A failed response means the code has expired, already been used, or the attempt limit has been reached.
Responses
200 — Success
200 — Success
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | true |
results.ErrorCode | string | 000 |
results.ExceptionMessage | string | Success |
results.ReturnObject | boolean | true on successful verification |
400 — Invalid or Expired OTP
400 — Invalid or Expired OTP
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | false |
results.ErrorCode | string | Error code from the platform |
results.ExceptionMessage | string | Human-readable reason — check this field for details |
Authorizations
JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.
Body
application/json
The member's email address
Example:
"jane.doe@example.com"
The OTP entered by the member
Example:
123456
IP address of the client device
Example:
"192.168.1.1"
Available options:
Web, Mobile Example:
"Web"
Purpose of the OTP. Must match between Generate and Verify calls.
Available options:
ACTIVATION, LOGIN, FORGOTPWD, CHANGEPASSWORD, RESETPASSWORD, FORGOTUSERNAME, TwoFA, UNBLOCKMEMBER, NONE, CASHBACKCONFIRM, POINTTRANSFERCONFIRM, FAMILYPOOLINGMERGE, FAMILYPOOLINGUNMERGE, AIRREVIEWNCONFIRM, DOMESTICFLIGHTREVIEWNCONFIRM, HOTELREVIEWNCONFIRM, CARREVIEWNCONFIRM, GIFTCARDREVIEWNCONFIRM, PACKAGEREVIEWNCONFIRM, SHOPREVIEWNCONFIRM, SHOPDIGITALREVIEWNCONFIRM, MERCHANTREVIEWNCONFIRM, ISPREVIEWNCONFIRM, INSURANCEREVIEWNCONFIRM Example:
"LOGIN"
Example:
19
Use 4 for customers
Example:
4
Response
OTP verified