Difference between revisions of "Client Email Verification"

From WHMCS Documentation

Line 1: Line 1:
'''Email Verification''' is an optional feature which allows admins to request that users confirm their email addresses on signup or change of email address.  This adds a layer of security when manually accepting client orders, as well as ensuring that correct information is provided.  To enable email verification, navigate to ''Setup >> General Settings >> Security tab''.  Tick the '''Email Verification''' checkbox and save the changes.  
+
Email Verification is a feature available to validate and ensure that the email address a client registers with is valid and their own.
  
[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]
+
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.
  
 +
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.
  
When viewing the '''Client Profile''' page, a warning banner displays notifying admins if that specific client has an unverified email address on file.  By clicking the '''Resend Verification Email''' button, a new verification email is sent to the client, which contains a link that is valid for 24 hours and invalidates the previous link.  No banner will display after the client has verified their email address.  A similar banner displays on the Manage Orders page, with the same option to resend the verification email, advising the admin when the email address on file has not been verified.
+
==Why enable it?==
  
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
+
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.
[[File:Manage_orders_verification_banner.png|400x150px|Manage orders client verification status]]
 
  
 +
==Enabling Email Verification==
  
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.
+
To enable email verification, navigate to ''Setup >> General Settings >> Security tab''.  Tick the '''Email Verification''' checkbox and save the changes.  
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
 
[[File:Verified_badge.png|400x250px|Verified email badge]]
 
  
 +
[[File:Enable_email_verification.png|center|850x250px|Enable email verification in general settings]]
  
The client will be able to log into their account associated with the unverified email address, however, a banner reminding them to take action will display, as well as the '''Resend Verification Email''' button.  No functionality is limited in the client area for clients with an unverified email address.
+
<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>
  
[[File:Client_verification_banner.png|center|850x250px|Email verification banner on client side]]
+
==Default Behaviour==
  
 +
When enabled, the client will be sent an email verification notice when the following events occur:
  
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 (which invalidates the previous link), then an error will display when the client tries to log in, but they will be allowed to generate and send a new email once they authenticate.
+
* A new user registration
 +
* Change of email address for an existing account
  
[[File:Expired_verification_warning.png|200x150px|Expired verification key warning]][[File:Expired_verification_banner.png|400x150px|Expired verification key banner]]
+
By default, clients access is not restricted in any way when an email address has not been verified. This is intentional so as not to restrict the clients ability to access both the services they have paid for or your support resources.
  
 +
<div class="docs-alert-warning">Should you wish, restrictions can be implemented either at the template level or via [[Hooks]]</div>
  
Upon the client following the link sent in the verification email, the client will be required to log into the client area.  Even if the client is already logged in, they will be required to re-authenticate.  Once logged in, the client will see a success message on the first page.
+
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.
  
 
[[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 be present and a Verified badge will display alongside the client's email address.  
Line 34: Line 36:
 
[[File:Verified_client_profile.png|850x250px|Verified email in client profile view]]
 
[[File:Verified_client_profile.png|850x250px|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 displayed within 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.
  
Changing of the email address, whether via the admin interface or in the client area will cause the email verification banner and Unverified badge to re-appear.
+
==Client Area User Interface==
  
'''Email Verification''' is a useful optional feature which assists admins in judging whether to manually accept an order and encourages correct information from clientsWhile no functionality is limited in the client area for clients with unverified email addresses, the verification email's link is masked when viewing email history in the client area.  The link is not masked when viewing the email from the admin area.
+
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 loginThis banner is displayed 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]]
 +
 
 +
==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).
 +
 
 +
[[File:Client_profile_verification_banner.png|400x150px|Client profile verification banner]]
 +
[[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.
 +
 
 +
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.
 +
 
 +
[[File:Unverified_badge.png|right|400x250px|Unverified email badge]]
 +
[[File:Verified_badge.png|400x250px|Verified email badge]]

Revision as of 18:53, 29 March 2016

Email Verification is a feature available to validate and 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.

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.

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

To enable email verification, navigate to Setup >> General Settings >> Security tab. Tick the Email Verification checkbox and save the changes.

Enable email verification in general settings
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.

Default Behaviour

When enabled, the client will be sent an email verification notice when the following events occur:

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

By default, clients access is not restricted in any way when an email address has not been verified. This is intentional so as not to restrict the clients ability to access both the services they have paid for or your support resources.

Should you wish, restrictions can be implemented either at the template level or via Hooks

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.

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.

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 displayed within 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.

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.

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 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).

Client profile verification banner 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.

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.

Unverified email badge

Verified email badge