Documentation
Integrate enterprise-grade voice verification into your application with just a few lines of code.
# Quick Start
Install the Rivoct SDK using your preferred package manager:
npm install @rivoct/sdkOr use cURL to make direct API calls:
curl -X POST https://api.rivoct.com/v1/verify \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"phone": "+919876543210", "channel": "whatsapp"}'# Authentication
All API requests require authentication using Bearer tokens. Include your API key in the Authorization header:
Authorization: Bearer riv_live_1234567890abcdefWARNING:Never expose your API key in client-side code (browsers/mobile apps). Always route requests through your own backend server.
API Reference
Detailed breakdown of available endpoints.
# Send Verification
Initiate a verification request via WhatsApp, SMS, voice call, or flash call.
POST /v1/verify
Request Body
{
"phone": "+919876543210",
"channel": "whatsapp",
"locale": "en",
"code_length": 6
}Response
{
"status": "sent",
"request_id": "req_abc123def456",
"to": "+919876543210",
"channel": "whatsapp",
"created_at": "2025-11-26T08:30:00Z"
}# Check Code
Verify the OTP code submitted by the user.
POST /v1/verify/check
Request Body
{
"request_id": "req_abc123def456",
"code": "123456"
}Response
{
"status": "approved",
"request_id": "req_abc123def456",
"verified_at": "2025-11-26T08:32:00Z"
}