> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password.md).

# Forgot password

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web, iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/account/forgot-password.md).
{% endhint %}

Ask for a password reset link, or for a one-time code to sign in instead.

* **Where:** web `/auth/forgot-password`; iOS and Android: "Forgot password?" on [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md). The email or phone typed there is filled in here.
* **Who:** signed-out users. The web sends a signed-in browser to `/fix`.
* **Feature:** [Password reset](https://docs.snapfix.com/product/features/account/password-reset.md)

![Forgot password on the web, email field empty](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-017c449f2617ac0bf748cb19a0afde0b6b184906%2Fforgot-password.jpg?alt=media)

## Layout

The same blocks on every platform, top to bottom:

1. A back arrow and "Forgot your password?".
2. "After you send the request, a password reset link will be sent shortly to the email or phone number you selected. Make sure to check your Spam/Junk folder." iOS writes the last sentence as "Make sure to check your " and "Spam/Junk folder.".
3. "Email" and "Phone Number". iOS and Android put "Login Type" above them; the web has no label.
4. The field for the chosen type.
5. "Send Password Reset Link". On the web it shows only once the typed contact is found and verified, so a fresh page shows only the code button.
6. "OR" (iOS and Android: "Or").
7. "If you have already verified your contact info in Snapfix, we can send you a one-time code".
8. "SEND ONE-TIME CODE"; the web shows it as "Send One-time Code".
9. While the contact is not verified: "Email not verified." and "Resend link to verify your profile." on the web; "Email not verified." and "Resend link to access." on iOS; "Email not verified." or "Phone number not verified." and "Resend link to access." on Android.
10. The help line of [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md). The web also shows the photo of that page.

The web shows the not-verified line whenever the contact is not known to be verified: on a fresh visit before anything is typed, for an unknown contact, and for a phone number, where it still says "Email not verified.". iOS also says "Email not verified." for a phone number.

## Inputs

| Field        | Type                            | Required                    | Default                                                                                                                                                           | Rules and messages                                                                                                                                                                                                                                             |
| ------------ | ------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type         | Choice: "Email", "Phone Number" | Yes                         | Web and iOS: the last choice on [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md), or "Email". Android: the type sign-in passed in | Switching clears both fields; on the web and iOS it also clears the verified state. The web stores the choice as the sign-in choice.                                                                                                                           |
| Email        | Text                            | Yes, when the type is email | The address from sign-in, if any                                                                                                                                  | Web: the email pattern, and up to 70 characters. iOS: "Please enter valid email address." under the field when the button is pressed. Android: "Please enter an email address" when empty, "Please enter a valid email address" when invalid, under the field. |
| Phone number | Country code and number         | Yes, when the type is phone | Web: Ireland. iOS and Android: the country from sign-in, or the device; iOS shows "+353" when it has no dial code                                                 | Web: the field's number check. iOS: "Please enter valid phone number." when the dial code and number do not parse. Android: "Please enter valid phone number" when empty or invalid. The apps send the digits, with a leading 0 removed.                       |

**How the web checks the contact.** Half a second after the field changes, and when it is valid, the page checks the username without showing any error ([`POST /validate-username-v2`](https://docs.snapfix.com/engineering-reference/api/auth.md)). The contact counts as verified when the answer has it and `verified` is set. A contact carried over from sign-in is checked after 0.8 seconds (email) or 1 second (phone). Both buttons wait for this check.

**Web messages.** "Please enter an email address", "Please enter a valid email address", "Your input exceeds the maximum allowed length", "Please enter a phone number" and "Invalid phone number" show in an alert. Because both buttons wait for a verified contact, they appear only after "Resend link to verify your profile." is clicked; no request is sent then (checked live). While typing, nothing shows under the field.

## Actions

| Action                                                                        | Who                                                                               | What happens                                                                                                                                                                                                                                                                                                                                                                                                                                     | API                                                                                                                                                                                        |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| "Send Password Reset Link" (web)                                              | Anyone with a verified contact                                                    | Disables the form and sends the contact with `origin` `web`. A phone is sent without its country code. After one second an alert shows "A password reset link has been sent to:" and the contact, and for email "Make sure to check your spam folder". The alert has no close button and no title; confirming it returns to [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md), which fills in the contact.        | [`POST /forgotpassword-v8`](https://docs.snapfix.com/engineering-reference/api/auth.md) on authpy                                                                                          |
| "Send Password Reset Link" (iOS)                                              | Anyone, once the field is not empty                                               | Checks the field, then the connection. Sends the contact with `origin` `ios`, `loginType`, `send_via` `sms` and `channel` `sms`, and for a phone the dial code ("+353" when none). Success shows "Reset Password" and "Password reset link has been sent to :" with the contact and "Make sure to check your Spam/Junk folder.", with "OK", then goes back. A message containing "not verified" shows the not-verified line instead of an alert. | [`POST /forgotpassword-v8`](https://docs.snapfix.com/engineering-reference/api/auth.md)                                                                                                    |
| "Send Password Reset Link" (Android)                                          | Anyone                                                                            | Checks the field, then the connection. Sends `login_type`, the contact, `send_via` (`na` for email, `sms` for a phone), `origin` from the app, and for a phone the country code. Success opens [Password reset successful](#dialogs-and-sheets).                                                                                                                                                                                                 | [`POST /forgotpassword-v8`](https://docs.snapfix.com/engineering-reference/api/auth.md)                                                                                                    |
| "Send One-time Code" (web)                                                    | Anyone with a verified contact                                                    | Sends a code to the contact (a phone with its country code, header `note` `login-screen`) and, 1.5 seconds later, opens [Forgot password code](https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password-code.md) in the same card.                                                                                                                                                                                             | [`POST /login-with-otp`](https://docs.snapfix.com/engineering-reference/api/auth.md)                                                                                                       |
| "SEND ONE-TIME CODE" (iOS)                                                    | Anyone, once the field is not empty and the contact is not known to be unverified | Email: checks the username and, when it is verified, opens [Forgot password code](https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password-code.md) without sending a code. Phone: with WhatsApp codes off, checks the username, sends an SMS code and opens the code screen with its reference. An unverified contact shows the not-verified line.                                                                            | [`POST /validate-username`](https://docs.snapfix.com/engineering-reference/api/auth.md), then (phone) [`POST /login-with-otp`](https://docs.snapfix.com/engineering-reference/api/auth.md) |
| "SEND ONE-TIME CODE" (Android)                                                | Anyone, once the field holds a valid entry                                        | Checks the connection and the username. A verified user, or an answer with no user and `verified` 1, gets a code and the code screen. An unverified user gets the not-verified line. An unknown contact gets the server's "email does not exist!" or "mobile does not exist!" in an alert; only an unknown email at a domain with a single sign-on rule gets the not-verified line.                                                              | [`POST /validate-username-v2`](https://docs.snapfix.com/engineering-reference/api/auth.md), then [`POST /login-with-otp`](https://docs.snapfix.com/engineering-reference/api/auth.md)      |
| "Resend link to verify your profile." (web) / "Resend link to access." (apps) | Anyone, while the not-verified line shows                                         | Sends the same reset request as "Send Password Reset Link". The web then says "A verification link has been sent to:" instead of the reset sentence, but the request is the same \[[ASK-29](https://github.com/snapfix/docs/blob/main/ASK.md#ask-29-how-should-forgot-password-treat-an-unverified-email-or-phone)]. iOS and Android use their reset success text.                                                                               | [`POST /forgotpassword-v8`](https://docs.snapfix.com/engineering-reference/api/auth.md)                                                                                                    |
| Back                                                                          | Anyone                                                                            | Returns to [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md).                                                                                                                                                                                                                                                                                                                                                     | -                                                                                                                                                                                          |
| "HelpHub."                                                                    | Anyone                                                                            | As on [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md).                                                                                                                                                                                                                                                                                                                                                          | -                                                                                                                                                                                          |

## States

* **Loading:** web: the pressed button spins, and the form and radios are disabled during the reset request. iOS: "Refreshing...". Android: "Please wait...".
* **Empty:** web: the reset button is hidden and the code button disabled until the contact is verified. iOS: both buttons are disabled while the field is empty. Android: the code button is disabled until the entry is valid.
* **Error:** the messages in [Inputs](#inputs) and [Actions](#actions). A failed reset or code request shows the server's message. The web username check shows nothing.
* **No permission:** no role check.
* **Offline (mobile):** iOS reset shows "Reset Password" and "You must be connected to the Internet to carry out this task. Please connect and try again." The iOS code button shows its connection alert. Android shows "You must be connected to the Internet to carry out this task. Please connect and try again." with "OK".

## Dialogs and sheets

* **Web success:** the alert in [Actions](#actions). The dialog title "Password reset successful" is in the code but not shown.
* **Password reset successful (Android):** "Password reset successful", "Password reset link has been sent to :", the contact (a phone as "+353 871234567"), and for email "Make sure to check your Spam/Junk folder.". It cannot be dismissed except by "OK", which closes forgot password.
* **Channel choice (iOS and Android):** an SMS or WhatsApp choice for a phone code exists in the code, behind `whatsappOTPEnabled` (iOS) and `IS_WHATSAPP_OTP_ENABLED` (Android), which are both off. The web's delivery dialog is commented out. So codes and reset links always go by SMS or email \[[ASK-34](https://github.com/snapfix/docs/blob/main/ASK.md#ask-34-is-whatsapp-delivery-of-one-time-codes-meant-to-ship)].

## Platform differences

| Topic                             | Web                                          | iOS                                                                                   | Android                                                 |
| --------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| Reset button                      | hidden until the contact is verified         | shown; disabled while the field is empty                                              | shown; checked when pressed                             |
| Not-verified text for a phone     | "Email not verified."                        | "Email not verified."                                                                 | "Phone number not verified."                            |
| One-time code                     | sent, then the code step                     | email: the code screen opens with no code sent; phone: SMS sent, then the code screen | username check, SMS or email code, then the code screen |
| Country code in the reset request | not sent                                     | sent separately                                                                       | sent separately                                         |
| Username check                    | `validate-username-v2`, quietly while typing | `validate-username`, on the code button                                               | `validate-username-v2`, on the code button              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
