Forgot password

Authorize/Identity

• Pre-prod: https://pre-prod-id.idshare.info/ (https://pre-prod-id.idshare.info/swagger/index.html)

• Production: https://id.idshare.info (https://id.idshare.info/swagger/index.html)

Process Flow

Forgot password Flow

API Configuration

HTTP Request

POST /api/v1/user/ForgotPassword

Path Parameters

Name	Type	Description
userName*	String

200: OK

{
    // Response
}

Example Request

{
    userName: "devtest"
}

Functional Specification:

Field name	Format	Required	Description
Forgot password	Button		Link to the password reset screen – enter email
Email/Username	Textbox		User enters email/username to get account back In case the user leaves blank or enters a space, the message “Please enter an email or username.” In case the information is not in the database, the message "The account does not exist"
Back	Button		Redirect to previous page
Send	Button		The user presses the button to send the request, a popup message “We have already sent an OTP code to [email]. Please enter the OTP code in the email into the field below” Send OTP emails to users (email format is added in the appendix)
OTP code	Number		Enter the OTP code sent to your 6-digit email. The code is valid from 5 minutes sent Time to resend OTP code: 60s (counting from receiving the previous OTP code) – when the new code is sent, the old code is no longer valid Show numeric keypad (for app) In case of entering the wrong OTP code, the message “OTP code is incorrect” In case the code expires, the message "OTP has expired" In case of entering the wrong code more than 5 times, the message “You entered the wrong OTP code more than five times. Please get your password back in 15 minutes.” and redirect the screen to the login page.
Resend OTP	Button		Resend the new OTP code to the user's email, invalidating the previously sent code
Confirm	Button		Switch to the password change screen (when the correct OTP code has been entered) Deactivate when you have not entered enough OTP
Password	Textbox		Format: ⦁ At least 8 characters, at most 16 characters ⦁ Password required contains uppercase, lowercase letters, special characters and numbers Can hide/show password when pressing icon show/hide password, display cover password as (•) or (*) – hide password by default If you leave it blank or enter a space, the message “Please enter a valid password” In case of incorrect/missing format, the message "Please enter the correct format: 4 to 16 characters including uppercase, lowercase, special character(s) and numeric character(s)"
Confirm password	Textbox		Can hide/show password when clicking show/hide password icon, show password mask as (•) or (*) – hide password by default If you leave it blank or enter a space, the message “Please re-enter password.” In case of re-entering the password that does not match the password field above, the message "The password doesn't match. Please re-enter the password that matches the one entered above."
Reset password	Button		Press the button to recover the password, display the message "You have successfully recovered your password", return to the login screen Send email notifications about users

API Descriptions

Step	Factor	Description
1	User	Click the forgot password link to go to the forgot password screen
2	Frontend	Content to display the account verification screen (enter email/username)
3	User	Enter your account for verification If the authentication is successful -> Step 4 If the validation fails, the corresponding error message is reported
4	Frontend	Display the screen to enter the OTP verification code
5	Backend	Send an email containing the OTP code to the user's selected email address
6	User	Enter the OTP code in the box to verify If entered correctly -> Step 7 If wrong, report the corresponding error
7	Frontend	Display the input frame, there are 2 required fields: • A new password • Confirm new password
8	User	Enter information in the 2 password fields in the correct format Select the button Recover Password
9	Frontend	Show reset password successfully
10	Backend	Send recovery email successfully