Creates a Code Generator to configure the number of characters of the security code (codeLength), expiration time of the code in minutes (expirationMinutes), the delivery channel where the code will be sent (SMS or Email) and the message body with the code placeholder that is sent to end users (text). If you want to send the code by SMS channel, you need to provide a specific sender (shortcode) to be used on an SMS message sent to the end user. In case of sending the code by Email channel, you need to provide a specific sender (from) to be used on an Email message sent to the end user. Note: You must be registered in a delivery channel from which the message will be sent to get a valid short code (SMS) or a valid email sender.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
You use a Code Generator, a security feature for your application, with two-factor authentication. You add an authentication factor linked to a channel (SMS, Email, or WhatsApp).
When a user signs up or logs into your application, a numeric code goes to the user's mobile device via SMS, Email, or WhatsApp, through an authentication app. You create the code generator and configure that code as the first step.
At this point, you define the code length, the expiration time of the code, the delivery channel the code is sent through, and the message body with the code placeholder sent to the end user.
You currently deliver the security code through two delivery channels:
-
SMS: SMS is the most popular channel for two-factor authentication (2FA), since most people can receive text messages and onboarding is seamless.
-
Email: One-time passcodes (OTP) sent to email help protect your users if their password is brute-forced or phished. Like SMS, it doesn't require downloading another app, so onboarding is quick and seamless.
-
WhatsApp: If your app offers users the option to receive one-time passwords or verification codes via WhatsApp, you use a WhatsApp Authentication Message Template.
NOTEYou create a WhatsApp Authentication Message Template before creating a code generator. The Two Factor Authentication (WhatsApp) use case covers how to integrate WhatsApp with Two-Factor Authentication.
This endpoint lets you create a Code Generator and configure the settings for the security code it delivers.