Email Verification Workflow
Wristband provides flexibility in how you can handle email verification, whether you choose to use Wristband-hosted UI pages or self-hosted pages within your application. This guide outlines both approaches.
Users should verify their email address to ensure they have legitimate access to your application. The Email Verification Workflow provides an explicit way for a user to do just that. It involves Wristband sending a transactional email to the user's email address requiring verification. This email includes an Action Link that, when clicked, directs the user to a page with a unique Email Authorization Code. This one-time code is used for finalizing the verification through the Wristband Verify Email API.
These are the workflows where a user may trigger the Email Verification Workflow, assuming the appropriate Workflow Policy is configured:
- Wristband IDP Signup
- External IDP Signup if the synced External IDP
Userinfo
contains an email address that is not verified - External IDP Login with Just-in-Time (JIT) Provisioning enabled if the synced External IDP
Userinfo
contains an email address that is not verified
You can also send verification emails directly to your application's users from the Wristband Dashboard, accessible through the Edit User Page.
Self-Hosted UI
If you intend to self-host the Email Verification Page and utilize Wristband APIs to facilitate the Email Verification Workflow, it is necessary to override the Action Link URL for the Email Verification Email Policy in the Wristband Dashboard for your application. The URL value should point to the location of your application's self-hosted Email Verification Page.
Workflow Steps:
- The user clicks on the Action Link in the verification email that was sent to their inbox.
- The user is redirected to your application's self-hosted Email Verification Page along with the Email Authorization Code query parameter.
- Your application calls the Wristband Verify Email API, passing along the Email Authorization Code.
- A message is displayed to the user indicating that verification succeeded.
At this point, the workflow is complete, and the user can exit the page.
Wristband-Hosted UI
By default, the Action Link in the verification email directs users to a Wristband-hosted Email Verification Page. No user interaction is necessary on this page; it is designed for UX purposes, providing a visual confirmation of successful or unsuccessful verification.
Workflow Steps:
- The user clicks on the Action Link in the verification email that was sent to their inbox.
- The user is redirected to the Wristband-hosted Email Verification Page.
- Wristband calls the Wristband Verify Email API, passing along the Email Authorization Code.
- A message is displayed to the user indicating that verification succeeded.
At this point, the workflow is complete, and the user can exit the page.
Updated 2 months ago