Skip to main content
Before integrating the OTP API, ensure your Beem account and OTP configuration are fully set up.

​
Requirements

You will need:
  • A Beem account with access to the OTP service.
  • An OTP application created in the Beem Dashboard. The generated Application ID (appId) is required when requesting OTPs.
  • An API Key and Secret or an Access Token for authenticating API requests.
  • A recipient phone number capable of receiving OTPs via SMS or WhatsApp.
  • At least one active OTP template for the delivery channel you intend to use.

​
Configure your delivery channel

The OTP API supports multiple delivery channels. Before sending OTPs, configure the appropriate template for the channel you plan to use.
To send OTPs over SMS:
  1. Navigate to OTP → Templates in the Beem Dashboard.
  2. Create an SMS OTP template.
  3. Associate the template with an approved Sender ID.
  4. Ensure the template status is Active before using it in production.
SMS OTP templates require an approved Sender ID. Requests using inactive templates or unapproved Sender IDs will fail.

​
Before you begin

Before making your first OTP request, verify that:
  • ✅ Your Beem account is active.
  • ✅ Your OTP application has been created and you have its appId.
  • ✅ Your API credentials or access token are available.
  • ✅ Your SMS or WhatsApp template is Active.
  • ✅ Your Sender ID (SMS only) has been approved.
  • ✅ Your test recipient can receive SMS or WhatsApp messages.