Code Generator is a security feature for your Application used with two-factor authentication. You can 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 is sent to their mobile device either via SMS, Email or WhatsApp through an authentication app. For this reason, the first step is to create the code generator and configure the code that will be sent to the user.

At this point, you need to define the code length, the expiration time of the code, the delivery channel in which the code will be sent, and the message body with the code placeholder that is sent to the end user.

You are currently able to deliver the security code through two delivery channels:

SMS: SMS is the most popular channel for two-factor authentication (2FA). That's because most people can receive text messages, and onboarding is seamless.
Email: One-time passcodes (OTP) sent to email can help protect your users if their password is brute-forced or phished. Like SMS, it doesn't require downloading another app, so onboarding will be quick and seamless.
WhatsApp: If your app offers users the option to receive one-time passwords or verification codes via WhatsApp, you must use a WhatsApp Authentication Template.

📘
NOTE
Before creating a code generator, you need to create a Whatsapp Authentication Template. For more details go to the Two factor Authentication (WhatsApp) use case to know how to integrate WhatsApp with two Factor Authentication.

Therefore, this endpoint allows you to create 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).

2012FA Interaction Created

401User not allowed

403Forbidden Access

422Unprocessable Entity

500Internal Server Error