Introduction
E-mail and phone number verification is used when users create an account with a new e-mail address or phone number, or when they change their current information. With this functionality, you can check which users have verified and correct e-mail addresses and phone numbers, as well as those who haven't confirmed their information yet.
- This article explains how to enable and use e-mail and phone number verification.
- This article will be useful toClub Owners, PG Champions and System Administrators.
Before you start
Make sure you are familiar with the Automation module. To learn more check this article.
This configuration requires the following system permissions:
PGM -> Clubs -> Employees -> System Permissions -> System Settings
Instruction
How to enable email confirmation?
1. Go to the PGM -> Settings -> System settings
2. Select Authentication -> Email Confirmation.
3. Select checkbox under Enable option.
Please remember that it can take up to 4 hours to apply settings to applications.
Additionally, there are two more settings in this section:
Block Login To Client Portal – this option will block user with unverified e-mail addresses from logging to Client Portal.
Token Expire Time – it determines how long the verification link will be useful. By default, it’s 24 hours.
Add Automation Notifications
The next step is adding a new notification rule in Automation.
If you are not familiar with Automation, check this article.
1. Go to PGM -> Automation -> Automation Rules -> Automation Rules
2. Press Add automation rule button
3. In Name write a name of this rule.
4. In Action select Notification
5. In Event select User e-mail confirmation has been requested.
6. In Notification content add a Tag - CONFIRM_EMAIL_LINK
This is a simplified description of adding an Automation Rule, check this article for more information about Automation
E-mail address verification - feature description
E-mail verification is triggered every time a new user will be added and after every time an existing user changes their e-mail address.
Users can have one of these e-mail verification statuses:
- None - the verification process hasn't started for the user yet. Most users with this status will be users that were added to the system before turning on this functionality.
- In Progress (Waiting for verification) - the verification process started and there are sent notifications that are yet to expire.
- Failed - the verification process started, but all sent notifications expired.
- Verified - user has verified e-mail.
You can send new notifications to users in None, In Progress and Failed statuses. This will automatically move them to the In Progress status.
Users will be redirected to a verification page after pressing the verification link. There, the process will be finished by our system, and an appropriate screen will be displayed.
If the verification is successful the user will see information that the verification is complete. Moreover, there will be a button that will redirect them to the Client Portal. If the verification is successful, the user status will change to Verified.
If the verification link expires, then the user will see appropriate information with the option to resend a verification e-mail.
It's possible to check user's status in a couple of different places.
- In PGM:
- PGM -> Club Members -> Member Profile -> Data -> Information. Next to the user's e-mail, there will be the verification status and a button that will allow you to send, or resend a notification.
- Reports -> E-mail Verification Status
- In POSweb:
- Member profile -> Access Control -> Information -> Personal. Next to the e-mail address, there will be the verification status and a button that will allow you to send, or resend a notification.
E-mail verification - API endpoints
There are 2 new API endpoints that were created for this functionality:
- SendEmailConfirmationMessage – with this endpoint you are able to send a verification e-mail to a user. You can also use custom URL links which will be sent in e-mail verification. This way the user will be redirected to the website built by you
- ConfirmMemberEmail - with this endpoint you can set the verification status to Verified. You need to pass a verification token sent to a user before.
- There is also a new field in the Member endpoint, it's called EmailVerificationStatus. In it you can find information about the member's current email verification status.
How to enable phone number confirmation?
This feature is available starting from version R.93.
1. Go to the PGM -> Settings -> System settings
2. Select Authentication -> Email Confirmation.
3. Select checkbox under Enable phone number confirmation option.
This option is available only if you turned on email confirmation.
Please remember that it can take up to 4 hours to apply settings to applications.
Add Automation Notifications
The next step is adding a new notification rule in Automation.
If you are not familiar with Automation, check this article.
1. Go to PGM -> Automation -> Automation Rules -> Automation Rules
2. Press Add automation rule button
3. In Name write a name of this rule.
4. In Action select Notification
5. In Event select User e-mail confirmation has been requested.
6. In Notification content add a Tag - PHONE_NUMBER_CONFIRMATION_TOKEN
This is a simplified description of adding an Automation Rule, check this article for more information about Automation
Phone number verification - feature description
Verification is triggered every time a new user will be added and after every user update if user doesn’t have already verified email and phone number.
Users can have one of these phone verification statuses:
- None - the verification process hasn't started for the user yet. Most users with this status will be users that were added to the system before turning on this functionality.
- In Progress (Waiting for verification) - the verification process started and there are sent notifications that are yet to expire.
- Failed - the verification process started, but all sent notifications expired.
- Verified - user has verified phone number.
You can send new notifications to users in None, In Progress and Failed statuses. This will automatically move them to the In Progress status.
If this functionality is turned on then both email address and phone number verification becomes a two-step process. First user will receive email with link for email verification, then the user will be redirected to phone verification page after pressing the verification. Meanwhile, user will receive an SMS with verification code which he has to enter on verification page.
If something goes wrong then user will see appropriate information.
If the verification is successful, the user will see information that the verification is complete. Moreover, there will be a button that will redirect them to the Client Portal. If the verification is successful, the user status will change to Verified.
It's possible to check user's status in a couple of different places.
- In PGM:
- PGM -> Club Members -> Member Profile -> Data -> Information. Next to the user's e-mail, there will be the verification status and a button that will allow you to send, or resend a notification.
- Reports -> Phone Number Verification Status
- In POSweb:
- Member profile -> Access Control -> Information -> Personal. Next to the e-mail address, there will be the verification status and a button that will allow you to send, or resend a notification.
Phone number verification - API endpoints
There are 2 new API endpoints that were created for this functionality:
- SendPhoneNumberConfirmationMessage – with this endpoint you are able to send an SMS with verification code to a user.
- ConfirmMemberPhoneNumber - with this endpoint you can set the verification status to Verified. You need to pass a verification code sent to a user before.
- There is also a new field in the Member endpoint, it's calledPhoneNumberVerificationStatus. In it you can find information about the member's current phone number verification status.