Verify OTP
This API is used to verify the OTP entered by the user against the one sent through the Send OTP API. It helps confirm the user's identity before allowing sensitive actions like password reset.
🔑Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-Type | string | Specifies request format. | application/json |
| x-api-key | string | API key provided for authentication | x-api-key |
📦 Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| user_id | string | Yes | Unique Client Code (UCC) assigned to the user. | user123456 |
| otp | string | Yes | The OTP received by the user. | 123456 |
| api_key | string | Yes | API key provided by SynapseWave to authenticate the request. | x-api-key |
| source | string | Yes | Platform making the request; WEBAPI for browsers and MOBILEAPI for apps | "WEBAPI" , "MOBILEAPI" |
🟢Success Response- 200 OK
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of the API call. Usually "success" on verification | "success" |
| code | string | Standard Response Code | "s-101" |
| message | string | User-friendly message confirming the result. | "OTP Verified Successfully" |
| data | string | Temporary JWT token (forgot_password_token). Must be passed to the next API in the flow | "eyJhbGciOiJIUzI1NiJ9..." |
What's Next?
The data field in the success response contains the forgot_password_token.
Use this value as the otp parameter in the following APIs:
🔑 Set Password — Reset a forgotten password
🔐 Register TOTP — Begin TOTP registration
📱 Set MPIN— Reset a forgotten MPIN
👆 Set Fingerprint — Reset fingerprint authentication