Loading...
Integrate the public API, configure linked Android delivery, and implement automated OTP or custom SMS flows.
This documentation covers the public /v1 API endpoints. All requests are authenticated using your project-scoped API keys.
Authenticate the public API with a project-scoped X-SMX-API-Key header.
Store the verificationId returned by send-otp and use it for the verify step later.
Each project routes messages through one active device. Just install the app, link it via QR code, and forget it—it delivers cleanly in the background.
Check functional status and aggregate message counts through dedicated read endpoints.
The architecture separates API integration, project boundaries, and device delivery states to ensure clean environment isolation and straightforward contract management.
Projects isolate API keys, OTP templates, test numbers, logs, stats, and linked-device state.
Sending OTP creates a verification challenge and returns a verificationId that remains the contract for verify.
If no linked device is active for the project, the public API returns a DEVICE_NOT_LINKED failure response.
The public API surface consists of high-throughput endpoints that map directly to the project's delivery engine.
Call POST /v1/send-otp with the project API key and the receiver number.
Persist the returned verificationId so your app can complete the challenge later.
Prompt the user for the OTP after delivery reaches the linked Android device.
Call POST /v1/verify-otp with the saved verificationId and the user-entered code.
Treat success: true with data.verified: true as the completed verification state.
Use the route guides below to move from first call to production-ready behavior.
Wire your first OTP send and verify flow.
Understand headers, API keys, and idempotency behavior.
Review the first endpoint most integrations call.
Complete challenges with verificationId and otp.
Send one-off or bulk custom messages.
Check functional readiness and aggregate OTP or custom SMS counts.
Review our canonical API error formats, response origins, and step-by-step handling recommendations.