Difference between revisions of "Client Email Verification"

From WHMCS Documentation

m (Why enable it?)
Line 1: Line 1:
Email Verification is a feature available to validate and ensure that the email address a client registers with is valid and their own.
+
'''Email Verification''' checks to ensure that the email address a client registers with is valid and their own.
  
When enabled, upon creation of a new client account or change of email address, an email is sent to the email address provided asking the user to confirm that they intended to register or make the change of email address.
+
When you enable this, upon creation of a new client account or change of email address, the system sends an email is to the email address, asking the user to confirm that they intended to register or make the change to the email address.
  
The validation link they receive is valid for 24 hours. Should it expire, the client can request a new verification email be sent by logging into the client area.
+
The validation link they receive is valid for 24 hours. If it expires, the client can request a new verification email by logging in to the client area.
  
 
==Why enable it?==
 
==Why enable it?==
  
Enabling Email Verification adds an additional layer of protection against signing up using incorrectly typed and unauthorized email addresses, and can also be used as part of order review and fraud screening procedures.
+
Enabling '''Email Verification''' helps to protect against signing up using incorrectly-typed and unauthorized email addresses. It can also act as part of order review and fraud screening procedures.
<div class="docs-alert-info">When enabled, the client will not receive the separate Welcome e-mail.</div>
+
 
 +
<div class="docs-alert-info">
 +
<span class="title">Note</span><br />
 +
When you enable this, the client will not receive the separate ''Welcome'' email.
 +
</div>
  
 
==Enabling Email Verification==
 
==Enabling Email Verification==
  
To enable email verification, navigate to ''Setup >> General Settings >> Security tab''.  Tick the '''Email Verification''' checkbox and save the changes.  
+
To enable '''Email Verification''', navigate to '''[[Configuration|Setup > General Settings > Security]]'''.  Check the '''Email Verification''' checkbox and save the changes.  
  
 
[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]
 
[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]
  
<div class="docs-alert-info">Enabling Email Verification will not send an email verification request to any existing clients automatically. Their accounts will simply show as unverified and continue to operate unaffected.</div>
+
<div class="docs-alert-info">
 +
<span class="title">Note</span><br />
 +
Enabling '''Email Verification''' will not send an email verification request to any existing clients automatically. Their accounts will display as unverified and continue to operate unaffected.
 +
</div>
  
 
==Default Behaviour==
 
==Default Behaviour==
  
When enabled, the client will be sent an email verification notice when the following events occur:
+
When you enable this, the client will receive an email verification notice when the following events occur:
  
* A new user registration
+
* A new user registration.
* Change of email address for an existing account
+
* A change of email address for an existing account.
  
Clients access is not restricted to the client area, services or support resources prior to email verification being completed. This is to allow the client to access the services they have paid for and your support resources.
+
Clients access is not restricted to the client area, services, or support resources prior to email verification completion. This is to allow the client to access the services and support resources they have paid for.
  
Upon the client following the link sent in the verification email, the client will be required to log into the client area to complete the verification process. Once successfully authenticated, a success confirmation message will be displayed on the next page.
+
After the client follows the link in the verification email, the client must log in to the client area to complete the verification process. Once they successfully authenticate, a success message will display on the next page.
  
 
[[File:Verified_banner.png|850x250px|Verified email successfully]]
 
[[File:Verified_banner.png|850x250px|Verified email successfully]]
  
In the admin area, the email verification banner will no longer be present and a Verified badge will display alongside the client's email address.  
+
In the admin area, the email verification banner will no longer display and a ''Verified'' badge will display alongside the client's email address.  
  
 
[[File:Verified_client_profile.png|850x250px|Verified email in client profile view]]
 
[[File:Verified_client_profile.png|850x250px|Verified email in client profile view]]
Line 37: Line 44:
 
==Resending the Verification Email==
 
==Resending the Verification Email==
  
If a client has not verified their email address, they will see the option to resend the verification email in the banner notice displayed within the client area. Admins also have this ability from the admin client summary page.
+
If a client has not verified their email address, they will see the option to resend the verification email in the banner notice in the client area. Admins also have this ability from the admin client summary page.
  
Clicking the '''Resend Verification Email''' button sends an email with a link that is valid for 24 hours. If the link is followed after the 24 hour window or if the button is clicked again (which invalidates the previous link) then an error will be displayed upon attempting to verify using an older link. Again however, the user will have the option to request a new email verification.
+
Clicking the '''Resend Verification Email''' button sends an email with a link that is valid for 24 hours. If the recipient follows the link after the 24 hour window or multiple times (which invalidates the previous link) then an error will display upon attempting to verify using an older link. The user will have the option to request a new email verification.
  
 
==Client Area User Interface==
 
==Client Area User Interface==
  
When enabled, any client who has not completed the email verification process will be prompted with a banner reminding them to take action when they login.  This banner is displayed on all pages of the client area.
+
When you enable this, any client who has not completed the email verification process will see a banner reminding them to take action when they log in.  This banner appears on all pages of the client area.
  
 
No functionality is limited in the client area for clients with an unverified email address.
 
No functionality is limited in the client area for clients with an unverified email address.
Line 51: Line 58:
 
==Admin Area User Interface==
 
==Admin Area User Interface==
  
When enabled, any client who has not completed the email verification process will have a banner shown at the top of their client summary page and when viewing orders submitted by them (pictured below).
+
When you enable this, any client who has not completed the email verification process will see a banner at the top of their client summary page and when viewing orders they submitted (pictured below).
  
 
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
 
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
 
[[File:Manage_orders_verification_banner.png|400x150px|Manage orders client verification status]]
 
[[File:Manage_orders_verification_banner.png|400x150px|Manage orders client verification status]]
  
An option to resend the verification email is also available from both pages. Be aware that clicking this will invalidate any previous verification links.
+
An option to resend the verification email is also available from both pages. Clicking this will invalidate any previous verification links.
  
A badge will also display alongside the client's email address throughout the admin backend denoting whether the client's email address is verified or not.
+
A badge will also display alongside the client's email address throughout the admin area, denoting whether the client's email address is verified.
  
 
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
 
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
 
[[File:Verified_badge.png|400x250px|Verified email badge]]
 
[[File:Verified_badge.png|400x250px|Verified email badge]]

Revision as of 20:47, 9 June 2020

Email Verification checks to ensure that the email address a client registers with is valid and their own.

When you enable this, upon creation of a new client account or change of email address, the system sends an email is to the email address, asking the user to confirm that they intended to register or make the change to the email address.

The validation link they receive is valid for 24 hours. If it expires, the client can request a new verification email by logging in to the client area.

Why enable it?

Enabling Email Verification helps to protect against signing up using incorrectly-typed and unauthorized email addresses. It can also act as part of order review and fraud screening procedures.

Note
When you enable this, the client will not receive the separate Welcome email.

Enabling Email Verification

To enable Email Verification, navigate to Setup > General Settings > Security. Check the Email Verification checkbox and save the changes.

Enable email verification in general settings

Note
Enabling Email Verification will not send an email verification request to any existing clients automatically. Their accounts will display as unverified and continue to operate unaffected.

Default Behaviour

When you enable this, the client will receive an email verification notice when the following events occur:

  • A new user registration.
  • A change of email address for an existing account.

Clients access is not restricted to the client area, services, or support resources prior to email verification completion. This is to allow the client to access the services and support resources they have paid for.

After the client follows the link in the verification email, the client must log in to the client area to complete the verification process. Once they successfully authenticate, a success message will display on the next page.

Verified email successfully

In the admin area, the email verification banner will no longer display and a Verified badge will display alongside the client's email address.

Verified email in client profile view

Resending the Verification Email

If a client has not verified their email address, they will see the option to resend the verification email in the banner notice in the client area. Admins also have this ability from the admin client summary page.

Clicking the Resend Verification Email button sends an email with a link that is valid for 24 hours. If the recipient follows the link after the 24 hour window or multiple times (which invalidates the previous link) then an error will display upon attempting to verify using an older link. The user will have the option to request a new email verification.

Client Area User Interface

When you enable this, any client who has not completed the email verification process will see a banner reminding them to take action when they log in. This banner appears on all pages of the client area.

No functionality is limited in the client area for clients with an unverified email address.

Email verification banner on client side

Admin Area User Interface

When you enable this, any client who has not completed the email verification process will see a banner at the top of their client summary page and when viewing orders they submitted (pictured below).

Client profile verification banner Manage orders client verification status

An option to resend the verification email is also available from both pages. Clicking this will invalidate any previous verification links.

A badge will also display alongside the client's email address throughout the admin area, denoting whether the client's email address is verified.

Unverified email badge

Verified email badge