Verify Login OTP Api
Verify Login OTP
Description :
This API endpoint is used for otp verification of user like mobile verification, email verification, and login verification
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| username | string | Yes | The user's username or mobile number | |||
| password | string | Yes | The user's password | |||
| latitude | float | Yes | The latitude of the user's location | |||
| longitude | float | Yes | The longitude of the user's location | |||
| req_mode | string | Yes | mode of request web,app | |||
| verify_type | string | Yes | type of verification mobile_verify, login_verify, email_verify | |||
| otp1 | integer | Yes | 1st digit of otp | |||
| otp2 | integer | Yes | 2nd digit of otp | |||
| otp3 | integer | Yes | 3rd digit of otp | |||
| otp4 | integer | Yes | 4th digit of otp | |||
| otp5 | integer | Yes | 5th digit of otp | |||
| otp6 | integer | Yes | 6th digit of otp |
Request Example
Responses (JSON)
- Status Code 1: Login Success
- Description: Successful login with valid credentials.
- 'status_code' (integer): 1
- 'message' (string): "Login Successful"
- 'url' (string): The URL to redirect the user to after successful login (e.g., 'admin-dashboard' or 'dashboard').
{"status_code": 2, "message": "req_mode is required"}
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "Invalid otp entered"}
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "Invalid otp entered."
{"status_code": 3, "message": "Login Verification Required"}
- Status Code 3: Login Verification Required
- Description: Additional login verification is required (e.g., two-factor authentication). redirect user to otp enter screen.
- 'status_code' (integer): 3
- 'message' (string): "Login Verification Required."
{"status_code": 4, "message": "Mobile Verified, Email Verification Required", "email": "test@gmail.com"}
- Status Code 4: Mobile Verified, Email Verification Required
- Description: The user's email address requires verification, redirect user to otp enter screen.
- 'status_code' (integer): 4
- 'message' (string): "Mobile Verified, Email Verification Required"
- 'email' (string): The user's email address.
{"status_code": 5, "message": "Email Verified, Mobile Verification Required"}
- Status Code 5: Email Verified, Mobile Verification Required
- Description: The user's mobile no requires verification, redirect user to otp enter screen.
- 'status_code' (integer): 5
- 'message' (string): "Email Verified, mobile Verification Required"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.