{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"22128e3d-cd55-4600-9080-5c341851539e","name":"Authkey API Documentation","description":"Authkey is a secure omnichannel platform offering a comprehensive suite of services, including SMS OTPs, transactional messages, promotional bulk SMS, WhatsApp Business messaging, Voice IVR, Email, and RCS messaging. Built to empower developers and businesses, our platform ensures high performance, reliability, and seamless communication across multiple channels.\n\n### Omnichannel Integration Benefits\n\nBy integrating Authkey’s omnichannel API, businesses can:\n\n- Deliver consistent communication across SMS, WhatsApp, Voice, Email, and RCS channels.\n    \n- Create unified customer experiences with personalised interactions on their preferred channel.\n    \n- Monitor and optimize campaigns through centralized analytics and reporting tools.\n    \n\n# Authentication\n\nAuthkey ensures secure access through API key-based authentication. Every client is assigned a unique API Key to authenticate their account.\n\n#### Key Security Features:\n\n- **IP-Based Restrictions**: Clients can limit API usage to specific IP addresses to enhance security.\n    \n- **Custom Encryption**: Use the POST method; if encryption is required, we provide Base16 encoding or develop encryption according to specific needs.\n    \n- **Data Masking**: We offer options for data masking and secure downloads.\n    \n\n#### Authentication Error Response:\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n---\n\n# Services Offered\n\nAuthkey stands out as a true omnichannel communication platform, enabling businesses to connect with customers via multiple channels:\n\n1. **SMS Messaging**:\n    \n    - **Use Cases**: OTPs, transactional updates, and promotional campaigns.\n        \n    - **Key Features**: High delivery rates, real-time reporting, and bulk campaign support.\n        \n2. **WhatsApp Business Messaging**:\n    \n    - **Use Cases**: Customer support, notifications, promotional campaigns, and chat automation.\n        \n    - **Key Features**:\n        \n        - Personalized two-way communication.\n            \n        - Multi-Agent Support.\n            \n        - Drag-and-Drop Chatbot Flow.\n            \n        - Quick template approval for message delivery.\n            \n        - Website WhatsApp Chat Widget.\n            \n        - Click-to-Ads Support.\n            \n3. **Voice IVR Services**:\n    \n    - **Use Cases**: Interactive customer support, automated call routing, and survey collection.\n        \n    - **Key Features**:\n        \n        - Easy-to-configure IVR flows.\n            \n        - Direct API with TTS support.\n            \n        - High-quality audio delivery.\n            \n        - Multi-level IVR support for complex call handling.\n            \n4. **Email Messaging**:\n    \n    - **Use Cases**: Transactional emails, newsletters, and marketing campaigns.\n        \n    - **Key Features**:\n        \n        - High deliverability and advanced spam filtering.\n            \n        - Detailed analytics for email performance.\n            \n5. **RCS Messaging (Rich Communication Services)**:\n    \n    - **Use Cases**: Interactive and media-rich customer interactions.\n        \n    - **Key Features**:\n        \n        - Support for images, carousels, and call-to-action buttons.\n            \n        - Branded messaging for an enhanced customer experience.\n            \n        - Real-time delivery tracking and analytics.\n            \n        - SMS as fallback to ensure a 100% delivery rate.\n            \n\n---\n\n# API Throughput and Scalability\n\nAuthkey.io is built for enterprise-grade performance, ensuring reliability and scalability for businesses of all sizes.\n\n**Default Performance**:\n\n- **Rate Limit**:\n    \n    - SMS: 5,000 TPS\n        \n    - Voice: 500 TPS\n        \n    - WhatsApp: 1,000 TPS (depending on account sending limits)\n        \n    - Email: 500 TPS\n        \n- **Throughput**: Supports up to 20,000 requests per second under standard configurations.\n    \n- **Response Times**: Average response time ranges from 100 ms to 400 ms.\n    \n\n**Enhanced Scalability with High-Performance Clusters**:\n\n- **Throughput**: Capable of processing up to 5,000 transactions per second (TPS).\n    \n- **Response Times**: Average response time ranges from 50 ms to 120 ms.\n    \n\nFor custom scalability requirements, contact [<b>hello@authkey.io</b>](https://null).\n\n---\n\n### Data Privacy & Security Measures\n\nAt Authkey, safeguarding customer data is our top priority. Our security practices ensure that data is securely transmitted, stored, and processed in compliance with global standards.\n\n#### API Hosting and Encryption:\n\n- **Cloud Hosting Environment**: All endpoints are hosted on a serverless infrastructure for high availability.\n    \n- **SSL/TLS Encryption**: End-to-end encryption ensures secure communication.\n    \n\n#### Threat Intelligence and Protection:\n\n- **Web Application Firewall (WAF)**: Protects API endpoints against unauthorized access.\n    \n- **IP-Based Restrictions**: Enable strict control over API access.\n    \n\n---\n\n### Data Retention & Disposal Policies\n\nAuthkey ensures secure data retention and disposal to meet regulatory requirements:\n\n#### Data Retention:\n\n- **Banking Clients**: Data is retained for 1 year as per regulations.\n    \n- **Other Clients**: Data is retained for 2 months and then archived securely.\n    \n\n#### Data Disposal:\n\n- Data is archived in flat files and securely stored in cold storage.\n    \n\n---\n\n### Access to Logs and Data\n\n#### Authentication:\n\nAccessing logs requires multi-factor authentication:\n\n1. Log in using your credentials.\n    \n2. Complete OTP verification sent to your registered mobile number.\n    \n\n#### Access Control:\n\n- **Account Owners**: Full access to logs.\n    \n- **Support Team**: Limited access for resolving issues.\n    \n- **Third Parties**: No access is granted to external entities.\n    \n\n---\n\n### Contact Information\n\nFor more information about Authkey.io’s services, security measures, or integration support, contact us:\n\n- **Email**: [hello@authkey.io](https://null)\n    \n- **Website**: [www.authkey.io](http://www.authkey.io)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"28006064","team":5213053,"collectionId":"22128e3d-cd55-4600-9080-5c341851539e","publishedId":"2sAYXCje4N","public":true,"publicUrl":"https://documenter-api.postman.tech/view/28006064/2sAYXCje4N","privateUrl":"https://go.postman.co/documentation/28006064-22128e3d-cd55-4600-9080-5c341851539e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-07-28T09:45:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7f855cca0e8003c6353e629dcd90f854e582043701762ca13bbb6258b7ed5e26","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYXCje4N"}