Vonage Network APIs
Vonage Network APIs expose new capabilities from mobile operators, going beyond traditional SMS and Voice services.
Some Vonage Network APIs are developed based on the CAMARA standards, an open-source initiative within the Linux Foundation. CAMARA standardizes API requirements and publishes definitions to create a unified API solution. This allows developers to access to network capabilities across different networks and countries, allowing applications to work consistently across different operators worldwide.
The following table contains the list of supported Network APIs:
| API | Purpose |
|---|---|
| Verify API | Authenticate your end-users using one-time passcodes using different channels such as Silent Authentication, SMS, WhatsApp, RCS, Email, and Voice. |
| Number Verification API | Authenticates your end-users using a mobile data session and without the need for one-time passwords. |
| SIM Swap API | Determines if and when the SIM card linked to the phone number has recently changed. |
| Device Location Verification API | Verify whether the location of an end-user is within a specified area using cellular network positioning. |
| Device Location Retrieval API | Retrieve the last known location of a SIM enabled device that is connected to the network using cellular network positioning. |
| Device Status API | Query a device's roaming and connectivity status. |
| Quality on Demand API | Manage your application's traffic to gain more consistent performance from the network. |
Availability
When working with the Network APIs, there are two different environments:
- Production. This environment returns live data from the supported Operators in some countries. Access to the production environment requires approval from the mobile operators. To learn how to request access, follow this guide.
- Playground. The Playground is a safe and controlled testing environment where API calls return live data only for a small group of allowlisted phone numbers. Unlike production, it does not require approval from Operators. Additionally, the Playground provides access to the Virtual Operator, a simulated operator that generates fake but deterministic responses.
The Network APIs are available in the following Operators and environments:
| API | Production | Playground |
|---|---|---|
| Verify API | Silent Authentication Territories | Virtual Operator |
| Number Verification API | Germany: Deutsche Telekom, Telefónica Blau, Telefónica O2, Vodafone Spain: Orange, Telefónica, Vodafone | Germany: Deutsche Telekom, Telefónica Blau, Telefónica O2, Vodafone Spain: Orange, Telefónica, Vodafone Virtual Operator |
| SIM Swap API | Germany: Deutsche Telekom, Telefónica Blau, Telefónica O2, Vodafone Spain: Orange, Telefónica, Vodafone | Germany: Deutsche Telekom, Telefónica Blau, Telefónica O2, Vodafone Spain: Orange, Telefónica, Vodafone Virtual Operator |
| Device Location Verification API | Not Available | Virtual Operator |
| Device Location Retrieval API | Not Available | Virtual Operator |
| Device Status API | Not Available | Virtual Operator |
| Quality on Demand API | Not Available | Virtual Operator |