Difference between revisions of "Client Email Verification"

From WHMCS Documentation

(Default Behaviour)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''Email Verification''' checks to 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 a user or admin creates a new client account or changes a client's email address, the system sends an email asking the user to confirm that they intended to register or make the change to the 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.
+
This helps protect against signups using incorrectly-typed and unauthorized email addresses. It can also act as part of order review and fraud screening procedures.
 
 
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.
 
 
 
<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 '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > [[Configuration#General_Settings|Security]]''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security'''.  Check the '''Email Verification''' checkbox and save the changes.
+
You can enable email verification in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.   
 
 
[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]
 
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
<span class="title">Note</span><br />
+
Enabling '''Email Verification''' will not send an email verification request to any existing users automatically. Their accounts will display as unverified and continue to operate unaffected.
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>
 
</div>
  
 
==Default Behaviour==
 
==Default Behaviour==
  
When you enable this, the client will receive an email verification notice when the following events occur:
+
WHMCS sends email verification notices 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.
 
 
 
In the admin area, the email verification banner will no longer display and a ''Verified'' badge will display.
 
 
 
[[File:email-verified-ca.png|800px|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 60 minutes. If the recipient follows the link after the 60 minute 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.
+
* A new user completes registration.
 +
* An existing user's email address changes.
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
Prior to 8.0, the email verification link was valid for 24 hours.
+
To help reduce the number of emails new clients are sent after signing up, the client will not receive the separate ''Welcome'' email when '''Email Verification''' is enabled.
 
</div>
 
</div>
  
==Client Area User Interface==
+
User access is not restricted to the client area, services, or support resources prior to email verification completion. This is to allow the user to access the services and support resources they have paid for.
 
 
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.
 
  
[[File:Client_verification_banner.png|center|850x250px|Email verification banner on client side]]
+
After the user follows the link in the verification email, the user 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.
  
==Admin Area User Interface==
+
In the admin area, the email verification banner will no longer display.
  
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).
+
==The Validation Link==
  
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
+
The validation link in each verification email is valid for 60 minutes for WHMCS 8.0 and higher or, prior to WHMCS 8.0, 24 hours. If the link expires, the user can request a new verification email by logging in to the Client Area.
[[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. Clicking this will invalidate any previous verification links.
+
Users who have not verified their email address will see the option to resend the verification email in the banner notice in the Client Area.  
  
A badge will also display alongside the client's email address throughout the admin area, denoting whether the client's email address is verified.
+
Admins can view the client's email verification status from the '''[[Clients:Summary Tab|Summary]]''' tab in the client's profile and a banner will also display when viewing orders from that account. A badge will also display alongside the user's email address, denoting whether the email address is verified.
  
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
+
Clicking '''Resend Verification Email''' sends an email with a new link in a new verification email.
[[File:Verified_badge.png|400x250px|Verified email badge]]
 

Latest revision as of 19:10, 19 April 2022

Email Verification checks to ensure that the email address a client registers with is valid and their own. When a user or admin creates a new client account or changes a client's email address, the system sends an email asking the user to confirm that they intended to register or make the change to the email address.

This helps protect against signups using incorrectly-typed and unauthorized email addresses. It can also act as part of order review and fraud screening procedures.

Enabling Email Verification

You can enable email verification in the Security tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

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

Default Behaviour

WHMCS sends email verification notices when the following events occur:

  • A new user completes registration.
  • An existing user's email address changes.

To help reduce the number of emails new clients are sent after signing up, the client will not receive the separate Welcome email when Email Verification is enabled.

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

After the user follows the link in the verification email, the user 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.

In the admin area, the email verification banner will no longer display.

The Validation Link

The validation link in each verification email is valid for 60 minutes for WHMCS 8.0 and higher or, prior to WHMCS 8.0, 24 hours. If the link expires, the user can request a new verification email by logging in to the Client Area.

Users who have not verified their email address will see the option to resend the verification email in the banner notice in the Client Area.

Admins can view the client's email verification status from the Summary tab in the client's profile and a banner will also display when viewing orders from that account. A badge will also display alongside the user's email address, denoting whether the email address is verified.

Clicking Resend Verification Email sends an email with a new link in a new verification email.