Skip to main content

Request Forgot Password Endpoint

Emails a six-digit password-reset OTP to an active user belonging to the requesting partner.

  • Endpoint: /api/v1/auth/request-forget-password
  • Method: POST
  • Authentication: Partner token.

Payload Parameters

ParameterTypeRequiredDescription
emailStringYesActive user's email address.

Sample Payload

{
"email": "user@example.com"
}

Sample Response

{
"result": 1,
"message": "A verification code has been sent to your email successfully."
}

The OTP is valid for one hour.

Sample Failure Response

{
"result": 0,
"message": "User not found"
}