API Reference

Complete REST API documentation for Q-OTP integration

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.q-otp.me/v1

POST /otp/send

Send a one-time password to a user via their preferred channel.

Request Body

{
  "phone_number": "+1234567890",
  "channel": "sms", // sms, whatsapp, telegram, rcs
  "code_length": 6,
  "expiry_seconds": 300,
  "template": "Your verification code is: {code}"
}

Response (200 OK)

{
  "success": true,
  "request_id": "req_abc123xyz",
  "status": "sent",
  "channel_used": "sms",
  "expires_at": "2025-11-01T14:35:00Z"
}

cURL Example

curl -X POST https://api.q-otp.me/v1/otp/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1234567890",
    "channel": "sms",
    "code_length": 6,
    "expiry_seconds": 300
  }'

JavaScript Example

const response = await fetch('https://api.q-otp.me/v1/otp/send', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone_number: '+1234567890',
    channel: 'sms',
    code_length: 6,
    expiry_seconds: 300
  })
});

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

POST /otp/verify

Verify a one-time password submitted by the user.

Request Body

{
  "request_id": "req_abc123xyz",
  "code": "123456"
}

Response (200 OK)

{
  "success": true,
  "valid": true,
  "request_id": "req_abc123xyz",
  "verified_at": "2025-11-01T14:32:15Z"
}

cURL Example

curl -X POST https://api.q-otp.me/v1/otp/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "req_abc123xyz",
    "code": "123456"
  }'

GET /otp/status/:request_id

Check the status of an OTP request.

Response (200 OK)

{
  "success": true,
  "request_id": "req_abc123xyz",
  "status": "delivered", // pending, sent, delivered, failed
  "channel": "sms",
  "attempts": 0,
  "max_attempts": 3,
  "expires_at": "2025-11-01T14:35:00Z"
}

cURL Example

curl -X GET https://api.q-otp.me/v1/otp/status/req_abc123xyz \
  -H "Authorization: Bearer YOUR_API_KEY"

Error Codes

Code	Description
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid API key
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error

Rate Limits

API requests are limited based on your plan:

Starter: 100 requests/minute
Business: 500 requests/minute
Enterprise: Custom limits

Documentation

Complete guide to integrating Q-OTP

Getting Started

Welcome to Q-OTP! This guide will help you integrate secure OTP authentication into your application in just a few minutes.

1. Create Your Account

Sign up for a Q-OTP account and obtain your API credentials from the dashboard. You'll receive:

API Key for authentication
Account ID for tracking
Webhook secret for event notifications

2. Choose Your Integration Method

REST API (Recommended)

Direct integration using our RESTful API. Works with any programming language that can make HTTP requests.

// Basic flow
1. Send OTP → POST /otp/send
2. User receives code via SMS/WhatsApp/etc
3. Verify code → POST /otp/verify

Official SDKs

We provide official SDKs for popular platforms:

Node.js: npm install @q-otp/node-sdk
Python: pip install q-otp
PHP: composer require q-otp/php-sdk
Ruby: gem install q_otp
Go: go get github.com/q-otp/go-sdk

3. Send Your First OTP

Here's a complete example using Node.js:

const QOTP = require('@q-otp/node-sdk');

const client = new QOTP({
  apiKey: 'your_api_key_here'
});

// Send OTP
async function sendOTP(phoneNumber) {
  try {
    const result = await client.otp.send({
      phoneNumber: phoneNumber,
      channel: 'sms',
      codeLength: 6,
      expirySeconds: 300 // 5 minutes
    });
    
    console.log('OTP sent:', result.requestId);
    return result.requestId;
  } catch (error) {
    console.error('Error:', error.message);
  }
}

// Verify OTP
async function verifyOTP(requestId, code) {
  try {
    const result = await client.otp.verify({
      requestId: requestId,
      code: code
    });
    
    if (result.valid) {
      console.log('✓ Code verified!');
      return true;
    } else {
      console.log('✗ Invalid code');
      return false;
    }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

4. Configure Webhooks

Set up webhooks to receive real-time notifications about delivery status, verification attempts, and more.

// Webhook endpoint example (Express.js)
app.post('/webhooks/qotp', (req, res) => {
  const event = req.body;
  
  switch (event.type) {
    case 'otp.delivered':
      console.log('OTP delivered successfully');
      break;
    case 'otp.failed':
      console.log('OTP delivery failed');
      break;
  }
  
  res.sendStatus(200);
});

Best Practices

Security: Never expose your API key in client-side code
Rate Limiting: Implement your own rate limiting to prevent abuse
Expiry Time: Use 5-10 minutes for OTP expiry
Code Length: 6 digits is the industry standard
Channel Fallback: Enable automatic fallback to alternative channels
Retry Logic: Implement exponential backoff for failed requests

Testing

Use our sandbox environment for testing without consuming real credits:

const client = new QOTP({
  apiKey: 'test_api_key',
  environment: 'sandbox'
});

// Test phone numbers that always succeed
const testNumbers = [
  '+15555550100', // Always delivers
  '+15555550101', // Always fails
  '+15555550102'  // Random behavior
];

Need Help?

Our support team is here to help:

📧 Email: support@q-otp.me
💬 Live Chat: Available 24/7 in the dashboard
📚 Knowledge Base: Comprehensive articles and guides
🐛 Report Issues: GitHub Issues

About Q-OTP

Building the future of secure authentication

Our Mission

At Q-OTP, we believe that secure authentication should be simple, reliable, and accessible to every business. Founded in 2022, we've grown to serve thousands of companies worldwide, delivering millions of OTP codes every day with industry-leading reliability.

Why We Built Q-OTP

Traditional OTP solutions are complex, expensive, and often unreliable. We experienced these challenges firsthand while building authentication systems for our previous ventures. That frustration led us to create Q-OTP—a service that just works, without the complexity.

Our Values

Security First: We treat your users' data with the same care we'd want for our own
Reliability: 99.99% uptime isn't just a promise—it's our commitment
Transparency: Clear pricing, no hidden fees, and honest communication
Developer Experience: Building great tools that developers love to use
Global Reach: Making secure authentication accessible worldwide

The Team

We're a distributed team of engineers, designers, and security experts passionate about making the internet safer. Our founding team has decades of combined experience building authentication systems at companies like Google, Amazon, and Microsoft.

Our Technology

Q-OTP runs on a global infrastructure with:

Direct connections to 200+ carriers worldwide
Multi-region deployment across 5 continents
SOC 2 Type II certified data centers
End-to-end encryption for all OTP codes
Real-time monitoring and automatic failover

Milestones

2022	Q-OTP founded • First 100 customers
2023	SOC 2 Type II certification • 1 million OTPs/day
2024	Series A funding • WhatsApp & RCS support
2025	10 million OTPs/day • 200+ country coverage

Investors & Partners

We're backed by leading venture capital firms and strategic partners who share our vision for a more secure internet. Our partners include major telecom carriers, cloud providers, and security organizations.

Join Us

We're always looking for talented people to join our mission. Check out our open positions or reach out at careers@q-otp.me.

Careers at Q-OTP

Join us in building the future of authentication

Why Work With Us

At Q-OTP, you'll work on technology that protects millions of users every day. We're a fast-growing company with a mission to make the internet more secure, and we're looking for talented people to help us get there.

What We Offer

Competitive Compensation: Market-leading salary plus equity in a growing company
Remote First: Work from anywhere with flexible hours
Health & Wellness: Comprehensive health insurance, mental health support, and fitness stipends
Learning Budget: $2,000/year for courses, conferences, and professional development
Equipment: Latest MacBook Pro or custom PC, plus $500 for home office setup
Time Off: Unlimited PTO policy plus company-wide closure during holidays
Team Retreats: Annual all-hands meetings in awesome locations

Open Positions

Engineering

Senior Backend Engineer

Build and scale our global OTP delivery infrastructure. Experience with Go, Kubernetes, and high-availability systems required.