1. get-started
VoiceDock
  • introduction
  • configuration
    • analysis-templates
    • custom-tools
    • sip-trunks
    • tool-templates
  • core-concepts
    • assistants
    • calls
    • phone-numbers
    • webhooks
  • features
    • ai-generation
    • autonomous-silence-handling
    • call-analysis
    • call-transfers
    • campaigns-setup
    • campaigns
    • privacy-compliance
    • voicemail-detection
    • web-calls
  • get-started
    • authentication
    • quickstart
  • guides
    • data-processing-agreement
  • integrations
    • byok-setup
    • mcp-server
    • provider-pricing
    • xai-grok-integration
  • platform
    • billing
    • dashboard-security
    • eu-data-sovereignty
    • privacy-policy
    • voice-selection-psychology
    • whitelabel
  • reference
    • error-codes
    • rate-limits
    • troubleshooting
  • sdks
    • node
  • webhooks
    • assistant-request
    • end-of-call-report
    • overview
    • security
    • status-update
    • tool-calls
Book a meeting
Linkedin
Github
📄 Documentation
🔌 API Reference🤖 MCP📦 SDK🟢 Status
📄 Documentation
🔌 API Reference🤖 MCP📦 SDK🟢 Status
  1. get-started

authentication

All API requests require authentication using a Bearer token in the Authorization header.

Getting Your API Key#

1.
Log in to the HMS Sovereign dashboard
2.
Navigate to Settings > API Keys
3.
Copy your API key

Making Authenticated Requests#

Include your API key in the Authorization header with every request:

Request Headers#

HeaderValueRequired
AuthorizationBearer YOUR_API_KEYYes
Content-Typeapplication/jsonFor POST/PATCH requests

Example: Get Account Information#

Response:
{
  "id": "user-uuid-here",
  "email": "you@example.com",
  "company_name": "Your Company",
  "minutes_balance": 500,
  "monthly_usage_minutes": 120,
  "active_numbers": 3,
  "active_agents": 2,
  "active_calls": 0
}
See Get Account Information for full details.

Rate Limits#

The API enforces the following rate limits:
Limit TypeRate
General API requests100 requests per minute per API key
Call control commands10 commands per minute per active call
When you exceed a rate limit, the API returns a 429 Too Many Requests response.

Error Responses#

401 Unauthorized#

Returned when the API key is missing, invalid, or expired.
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

403 Forbidden#

Returned when your API key doesn't have permission for the requested resource.
{
  "error": "Forbidden",
  "message": "You don't have access to this resource"
}

Security Best Practices#

1.
Never expose your API key in client-side code - Always make API calls from your server
2.
Rotate keys periodically - Generate new keys and revoke old ones regularly
3.
Use environment variables - Store keys in environment variables, not in code
4.
Monitor usage - Check your account dashboard for unexpected API activity
Modified at 2026-05-04 13:09:51
Previous
web-calls
Next
quickstart
Built with