Forgot password

Generate new password when you forget your password.

This API creates a new password when you forget your current password. Use the session ID generated by the /mfa/token/generate API in the request.

The flow chart below shows the steps involved.

API endpoint example


Resource information

HTTP methodGET
Pagination supported?NA
Rate limitNA
Batch supportNA

Request body parameters

(Parameters marked with * are mandatory)
Data TypeDescription
deviceId*StringUnique ID of the device used for password generation. It should be the same device used to generate the token.
brand*StringName of the brand or organisation that needs verification.
sessionId*StringUnique ID created from /mfa/token/generate API.
password*StringNew password.
confirmPassword*StringRe-enter new password.
identifierType*StringType of identifier to identify the customer. Values: MOBILE, EMAIL, USERNAME, EXTERNALID
identifierValue*StringValue of the identifier.
curl --location '' \
--header 'Content-Type: application/json' \
--header 'Cookie: _cfuvid=dRemgq7Qg.5EBlaabzopnNFgjUrozMPqS0k_jtCO218-1717046418965-' \
--data '{

Response parameters

statusobjectObject containing status information.
- successbooleanBoolean indicating the status of the request.
- codeintegerHTTP status code indicating the result. Example: 200 indicates success.
- messagestringMessage describing the status of the request.
    "status": {
        "success": true,
        "code": 200,
        "message": "SUCCESS"
Click Try It! to start a request and see the response here!