Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Forget Password

Lets you set a new password if the customer has lost or forgot password. This is applicable only for brands for which password is enabled. You need to first generate sessionId and then use it in password/forget. After setting a new password, the customer customer needs to authenticate again -

  1. Generate token,
  2. Generate OTP, and
  3. Validate OTP.
post/auth/v1/web/password/forget

Request body

identifierTypestring required

Identifier used for token generation. Values: MOBILE, EMAIL, USERNAME.

identifierValuestring required

Value of the specified identifierType.

brandstring required

Name of the brand/org for which authentication needs to be verified.

deviceIdstring

Unique ID of the device used for changing password. Applicable only for mobile app.

sessionIdstring required

Unique sessionId generated for the identifierType and deviceId combination.

passwordstring required

New password for the account.

confirmPasswordstring required

Reenter the new password.

Response

200

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "SUCCESS"
  }
}