Difference between revisions of "Client Email Verification"

From WHMCS Documentation

(Why enable it?)
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 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.
+
When you enable this, upon creation of a new client account or change of the account owner'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.
  
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.
+
The validation link they receive is valid for 60 minutes. If it expires, the user can request a new verification email by logging in to the client area.
  
 
==Why enable it?==
 
==Why enable it?==
Line 22: Line 22:
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
 
<span class="title">Note</span><br />
 
<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.
+
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.
 
</div>
 
</div>
  
 
==Default Behaviour==
 
==Default Behaviour==
  
When you enable this, the client will receive an email verification notice when the following events occur:
+
An email verification notice is sent when the following events occur:
  
* A new user registration.
+
* A new user completes registration.
* A change of email address for an existing account.
+
* An existing account owner changes their email address.
  
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.
+
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 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.
+
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 and a ''Verified'' badge will display.
+
In the admin area, the email verification banner will no longer display.
  
 
[[File:email-verified-ca.png|800px|Verified email in client profile view]]
 
[[File:email-verified-ca.png|800px|Verified email in client profile view]]
Line 42: Line 42:
 
==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 in the client area. Admins also have this ability from the admin client summary page.
+
If a user 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 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.
+
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. The user will have the option to request a new email verification.
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
Line 52: Line 52:
 
==Client Area User Interface==
 
==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.
+
Any user 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 users with an unverified email address.
  
 
[[File:Verify-email-link-ca.png|center|850px|Email verification banner on client side]]
 
[[File:Verify-email-link-ca.png|center|850px|Email verification banner on client side]]
Line 60: Line 60:
 
==Admin Area User Interface==
 
==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).
+
A banner will be displayed at the top of the client summary page and when viewing orders for any account where the account owner has not completed the email verification process.
  
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
+
[[File:Client vertification banner 8.png|850px|Client profile verification banner]]
[[File:Manage_orders_verification_banner.png|400x150px|Manage orders client verification status]]
+
<br/><br/>
 +
[[File:Client vertification banner order 8.png|850px|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.
 
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.
+
A badge will display alongside the user's email address, denoting whether the email address is verified.
  
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
+
[[File:User verified badge.png|850px|User verified badge]]
[[File:Verified_badge.png|400x250px|Verified email badge]]
 

Revision as of 15:16, 19 August 2021

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 the account owner'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.

The validation link they receive is valid for 60 minutes. If it expires, the user 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
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.

Enabling Email Verification

To enable Email Verification, navigate to Configuration () > System Settings > General Settings > Security or, prior to WHMCS 8.0, 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 users automatically. Their accounts will display as unverified and continue to operate unaffected.

Default Behaviour

An email verification notice is sent when the following events occur:

  • A new user completes registration.
  • An existing account owner changes their email address.

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.

Verified email in client profile view

Resending the Verification Email

If a user 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 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. The user will have the option to request a new email verification.

Prior to 8.0, the email verification link was valid for 24 hours.

Client Area User Interface

Any user 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 users with an unverified email address.

Email verification banner on client side

Admin Area User Interface

A banner will be displayed at the top of the client summary page and when viewing orders for any account where the account owner has not completed the email verification process.

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 display alongside the user's email address, denoting whether the email address is verified.

User verified badge