SysSecure API Reference

The SysSecure API is organized around REST. All requests must be made over HTTPS. The base URL for all API calls is:

https://api.syssecure.me/v2

Quickstart

Send your first OTP in under 5 minutes. Install the SDK, grab your API key from the dashboard, and run the example below.

# Install the Python SDK
pip install syssecure-sdk

# Or via npm for Node.js
npm install @syssecure/sdk

import syssecure

# Initialize with your API key
client = syssecure.Client(api_key="sk_live_your_key_here")

# Send OTP via WhatsApp with SMS fallback
otp = client.otp.send(
    to="+32470123456",
    channels=["whatsapp", "sms"],
    expires_in=300
)

# Verify the code entered by the user
result = client.otp.verify(otp_id=otp.id, code="847291")
print(result.valid)  # True

Authentication

All API requests require an API key passed in the Authorization header. Keys are prefixed with sk_live_ for production or sk_test_ for sandbox.

Authorization: Bearer sk_live_your_api_key_here
Content-Type: application/json

Send OTP

Generates a secure one-time password and delivers it to the specified phone number. Supports automatic fallback across channels.

Request parameters

{
  "to": "+32470123456",
  "channels": ["whatsapp", "sms"],
  "expires_in": 300,
  "length": 6,
  "locale": "en",
  "metadata": {
    "user_id": "usr_abc123",
    "action": "login"
  }
}

{
  "otp_id": "otp_01HWXYZABC123DEF456",
  "status": "sent",
  "channel": "whatsapp",
  "to": "+32470123456",
  "expires_at": "2026-04-25T15:32:00Z",
  "created_at": "2026-04-25T15:27:00Z"
}

Verify OTP

Validates a code submitted by the user against the original OTP. Codes are single-use — once verified, the OTP is invalidated.

{
  "valid": true,
  "otp_id": "otp_01HWXYZABC123DEF456",
  "verified_at": "2026-04-25T15:28:14Z"
}

Send SMS

Send a standard or unicode SMS to any phone number in 195+ countries.

Webhook Events

SysSecure sends HTTP POST requests to your configured URL whenever a message event occurs. All requests include an X-SysSecure-Signature header for verification.

Event types

{
  "event": "message.delivered",
  "message_id": "msg_01HWXYZ789",
  "channel": "sms",
  "to": "+32470123456",
  "status": "delivered",
  "delivered_at": "2026-04-25T15:28:02Z",
  "latency_ms": 1241
}

Error handling

SysSecure uses standard HTTP status codes. All error responses include a JSON body with a machine-readable code and human-readable message.