Updated API Reference, Identity Guides Step by Step, and Document Checks Explained
291 API endpoints, up from 203, identity guides rewritten step by step, and 13 troubleshooting pages sorted by symptom make up v2.1.4 of the Documentation and Developer Hub, published October 30, 2026.
What's New?
CommPeak Portal
Business and personal identities, step by step
Both guides now follow the wizard one task at a time: what to have ready, each step in order, and what happens after you submit.
- Business Identity: company details, choosing the operating location (registered address, a different office, or remote), the authorized representative, contact verification, and submitting for review.
- Personal Identity: personal details, proof of address, contact verification, and submitting for review.
Also, a new article explains every document check warning and how to clear it, one section per warning: Fixing Identity Document Issues.
API keys page rewritten for the Portal API
The API keys article now follows the current API Access page and the Portal API behind it: Managing Portal API Keys: naming a key, an optional default SMS stream and SIP account for calls, the access level (full access, or read-only for the Portal API), IP ACL entries in CIDR format, the password confirmation on creating a key and on revealing its token, and editing or deleting a key.
API Reference
API Reference rebuilt from the current CommPeak APIs
The API Reference now follows the current CommPeak API definitions: 291 endpoints, up from 203, and an overview page for every API group.
- CommPeak Portal API replaces the CommPeak Billing API and grows from 13 to 42 endpoints: SIP accounts, CDRs, call reports, allowed and dynamic caller IDs, voice and SMS rates, messages, Speech-to-Text, payments, invoices, users, DID numbers, voicemails, and voicemail playbacks. See the Portal API overview.
- CommPeak Dialer API grows from 91 to 132 endpoints, including dispatch automation, priority groups, call statistics, and Click2Call. See the Dialer API overview.
- CommPeak PBX API (formerly Cloud PBX API) grows from 39 to 51 endpoints. See the PBX API overview.
- TextPeak is split into two groups: the CommPeak TextPeak API for domains, senders, streams, users, and webhooks, and the CommPeak TextPeak Streams API for sending messages, OTP, message status, uploads, and WhatsApp.
- CommPeak Lookup API keeps its endpoints under a new Lookup API overview.
Three pages open the reference:
- Authentication and API Keys: which key authenticates which service, and how to send it.
- Requests, Errors, and Rate Limits: request format, error responses, and rate limits.
- Migrating to the New API Reference: what moved and what was renamed.
Documentation and Developer Hub
Troubleshooting pages organized by symptom
Every product section's troubleshooting landing page opens with the checks that solve the most common issues, then groups its articles into tables by symptom, each row naming what you see and the usual causes. Two broken article links on the Classic PBX and CommPeak Dialer pages are fixed.
- CommPeak Portal: Troubleshooting CommPeak Portal, Troubleshooting DID Numbers, Troubleshooting Messaging Service, Troubleshooting Speech-to-Text, and Troubleshooting HLR LookUp.
- SIP Trunking and Softphone: Troubleshooting SIP Trunking and Troubleshooting CommPeak Softphone.
- Cloud PBX and Classic PBX: Troubleshooting Cloud PBX Issues, Troubleshooting Classic PBX, and Troubleshooting Post-Answer Playback.
- CommPeak Dialer: Troubleshooting CommPeak Dialer and Troubleshooting Messaging Channels.
- TextPeak: Troubleshooting TextPeak Issues.
Live service status and linkable steps
Two changes show on the pages themselves:
- Service status card: seven troubleshooting pages now open with a live card for the services they cover. The card reads the CommPeak Status Page, marks services under maintenance, links to active incidents and to maintenance scheduled in the next 14 days, and refreshes every minute. It appears on Troubleshooting CommPeak Dialer, Troubleshooting CommPeak Portal, Troubleshooting SIP Trunking, Troubleshooting DID Numbers, Troubleshooting Messaging Service, Troubleshooting TextPeak Issues, and Troubleshooting Classic PBX. The overall card on Realtime System Status now reads the same source.
- Step lists: numbered procedures in more than 250 articles, in the CommPeak Portal, CommPeak Dialer, TextPeak, Cloud PBX, Classic PBX, CommPeak Softphone, and SIP Trunking sections, now show one step at a time, each step with its own title, from Business Identity and Personal Identity to Dialer Routes and Creating Campaigns. Click a step number to copy a direct link to that step. Numbered lists that are not step-by-step procedures, such as troubleshooting checklists and overviews, stay as plain lists.
DEPRECATEDThe PBX Stats API is deprecated and is not served through
api.commpeak.com. Existing integrations keep working at their current address. See Migrating to the New API Reference.
