Send Verification Code

curl --request POST \
  --url https://app.easyotp.dev/api/v1/send \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "channel": "<string>",
  "recipient": "<string>",
  "message": "<string>",
  "subject": "<string>",
  "expires_in": 123,
  "code": "<string>"
}
'

import requests

url = "https://app.easyotp.dev/api/v1/send"

payload = {
    "channel": "<string>",
    "recipient": "<string>",
    "message": "<string>",
    "subject": "<string>",
    "expires_in": 123,
    "code": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    channel: '<string>',
    recipient: '<string>',
    message: '<string>',
    subject: '<string>',
    expires_in: 123,
    code: '<string>'
  })
};

fetch('https://app.easyotp.dev/api/v1/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.easyotp.dev/api/v1/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel' => '<string>',
    'recipient' => '<string>',
    'message' => '<string>',
    'subject' => '<string>',
    'expires_in' => 123,
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.easyotp.dev/api/v1/send"

	payload := strings.NewReader("{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.easyotp.dev/api/v1/send")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.easyotp.dev/api/v1/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "error": "channel is required and must be one of: sms, email, voice",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "recipient must be a valid E.164 phone number for SMS and voice channels",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is required. Provide it via Authorization: Bearer <token> or x-api-key header",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Insufficient credits. Please purchase more credits.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is disabled",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Rate limit exceeded: Maximum 2 verification codes per minute. Please try again in 42 seconds.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc",
  "retry_after": 42
}

{
  "error": "Failed to send verification",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

POST

api

send

Send Verification Code

curl --request POST \
  --url https://app.easyotp.dev/api/v1/send \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "channel": "<string>",
  "recipient": "<string>",
  "message": "<string>",
  "subject": "<string>",
  "expires_in": 123,
  "code": "<string>"
}
'

import requests

url = "https://app.easyotp.dev/api/v1/send"

payload = {
    "channel": "<string>",
    "recipient": "<string>",
    "message": "<string>",
    "subject": "<string>",
    "expires_in": 123,
    "code": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    channel: '<string>',
    recipient: '<string>',
    message: '<string>',
    subject: '<string>',
    expires_in: 123,
    code: '<string>'
  })
};

fetch('https://app.easyotp.dev/api/v1/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.easyotp.dev/api/v1/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel' => '<string>',
    'recipient' => '<string>',
    'message' => '<string>',
    'subject' => '<string>',
    'expires_in' => 123,
    'code' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.easyotp.dev/api/v1/send"

	payload := strings.NewReader("{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.easyotp.dev/api/v1/send")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.easyotp.dev/api/v1/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"channel\": \"<string>\",\n  \"recipient\": \"<string>\",\n  \"message\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"expires_in\": 123,\n  \"code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "error": "channel is required and must be one of: sms, email, voice",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "recipient must be a valid E.164 phone number for SMS and voice channels",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is required. Provide it via Authorization: Bearer <token> or x-api-key header",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Insufficient credits. Please purchase more credits.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is disabled",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Rate limit exceeded: Maximum 2 verification codes per minute. Please try again in 42 seconds.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc",
  "retry_after": 42
}

{
  "error": "Failed to send verification",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

Request

Send a one-time password to a recipient via your chosen channel.

Headers

string

required

Bearer token with your API key: Bearer YOUR_API_KEY

string

required

Must be application/json

Body Parameters

string

required

Communication channel for the verification code. Must be one of: sms, email, or voice

string

required

Recipient address:

For SMS/Voice: E.164 formatted phone number (e.g., +1234567890)
For Email: Valid email address (e.g., [email protected])

string

Custom message template. Use {code} as a placeholder for the verification code.Default: "Your verification code is: {code}"Example: "Your Acme Corp verification code is: {code}. Valid for 5 minutes."

string

Email subject line (only used when channel is email)Default: "Your Verification Code"Example: "Verify Your Acme Corp Account"

integer

Code expiration time in seconds. Must be between 60 and 3600.Default: 300 (5 minutes)

string

Custom verification code. Must be a numeric string between 4-10 digits.If not provided, a code will be automatically generated with a length defined in your account settings.Example: "123456"

Response

boolean

Always true for successful requests

string

Unique identifier for this verification. Use this when calling the verify endpoint.Example: "11f951d5-32d1-4b49-bdda-7da248e2615c"

string

ISO 8601 timestamp when the code expiresExample: "2024-01-01T12:05:00.000Z"

string

Unique request identifier for debuggingExample: "7b4d6022-7260-4568-b6b7-29c366c47bbc"

Examples

curl -X POST https://app.easyotp.dev/api/v1/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "sms",
    "recipient": "+1234567890",
    "message": "Your verification code is: {code}",
    "expires_in": 300
  }'

curl -X POST https://app.easyotp.dev/api/v1/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "recipient": "[email protected]",
    "subject": "Your Verification Code",
    "message": "Your verification code is: {code}",
    "expires_in": 600
  }'

curl -X POST https://app.easyotp.dev/api/v1/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "voice",
    "recipient": "+1234567890",
    "message": "Your verification code is: {code}",
    "expires_in": 300
  }'

const response = await fetch('https://app.easyotp.dev/api/v1/send', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    channel: 'sms',
    recipient: '+1234567890',
    message: 'Your verification code is: {code}',
    expires_in: 300
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    'https://app.easyotp.dev/api/v1/send',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={
        'channel': 'sms',
        'recipient': '+1234567890',
        'message': 'Your verification code is: {code}',
        'expires_in': 300
    }
)

data = response.json()
print(data)

Success Response

{
  "success": true,
  "verification_id": "11f951d5-32d1-4b49-bdda-7da248e2615c",
  "expires_at": "2024-01-01T12:05:00.000Z",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

Error Responses

{
  "error": "channel is required and must be one of: sms, email, voice",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "recipient must be a valid E.164 phone number for SMS and voice channels",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is required. Provide it via Authorization: Bearer <token> or x-api-key header",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Insufficient credits. Please purchase more credits.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "API key is disabled",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

{
  "error": "Rate limit exceeded: Maximum 2 verification codes per minute. Please try again in 42 seconds.",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc",
  "retry_after": 42
}

{
  "error": "Failed to send verification",
  "request_id": "7b4d6022-7260-4568-b6b7-29c366c47bbc"
}

Rate Limiting

This endpoint enforces per-recipient rate limits to prevent spam and abuse:

2 sends per minute per recipient
15 sends per hour per recipient
50 sends per 24 hours per recipient

When you exceed these limits, you’ll receive a 429 response with a retry_after field indicating how many seconds until you can retry.

In addition to per-recipient limits, API keys are also rate limited to 120 requests per minute across all endpoints. Test recipients (like +15555550100) are exempt from per-recipient limits but still count toward your API key limits. See the Rate Limits section for more details.

Best Practices

Keep messages clear and branded: Include your app name in the message so users know where the code is coming from.Good: "Your Acme Corp verification code is: {code}"Bad: "{code}"

Set appropriate expiration times:

SMS/Voice: 2-5 minutes (users typically verify immediately)
Email: 10-15 minutes (users may need to open their email client)

Phone number format: Phone numbers must be in E.164 format (starting with + and country code). Invalid formats will be rejected.

Message length limits:

SMS: 160 characters recommended
Email: No hard limit, but keep it concise
Voice: Keep under 50 characters for best experience

Credits Consumed

Each send request consumes 1 credit regardless of the channel:

Channel	Credits
SMS	1 credit
Email	1 credit
Voice	1 credit

Failed sends do not consume credits.

Introduction

SDK

Endpoints

Send Verification Code

Request

Headers

Body Parameters

Response

Examples

Success Response

Error Responses

Rate Limiting

Best Practices

Credits Consumed

​Request

​Headers

​Body Parameters

​Response

​Examples

​Success Response

​Error Responses

​Rate Limiting

​Best Practices

​Credits Consumed

Request

Headers

Body Parameters

Response

Examples

Success Response

Error Responses

Rate Limiting

Best Practices

Credits Consumed