Verify API Technical Details

Introduction

The Verify API is Vonage’s next-generation two-factor authentication (2FA) solution. It expands on traditional authentication methods by supporting a wider range of channels, including over-the-top (OTT) channels like WhatsApp, as well as SMS, Voice, and Email.

Verify introduces event callbacks and summary callbacks that enable deeper integrations and greater customization. For example:

  • You can configure a webhook to receive summary callbacks, providing detailed insights into which channels successfully converted and which ones did not.
  • Event callbacks enable advanced user experiences, such as the WhatsApp Codeless flow. In this case, an end-user can simply tap a button within a WhatsApp message to authenticate, triggering an event callback to your backend to continue the verification flow.

Authentication

Verify requires that you authenticate API requests securely. Learn more about how to authenticate your Verify API requests in the Authentication Guide.

Workflow

The workflow defines the sequence of channels used to deliver the OTP to the end-user. You can customize the order, timeout settings, and fallback behavior to optimize the verification experience.

Find detailed information and examples in the Workflow Guide.

How does the API work?

Below is a visual representation of a Verify request flow with summary callbacks:

Verify V2 Request with Summary Callbacks

For initial setup and a step-by-step introduction, please refer to the Getting Started Guide.

Supported Languages

The Verify API supports many languages with the locale parameter (see API Reference). The Verify locale guide contains a list of supported locale.

Reporting

The Reports API is a central way to retrieve usage and reporting data across Vonage products, giving developers and businesses a consistent way to track activity, billing, and transaction details including call records and phone numbers. It simplifies reporting by bringing usage and billing data from multiple Vonage APIs into one consistent format. You can use the Reports API in a wide variety of use cases, including:

  • Customer billing - Download transactions related to all your sub-accounts and use the included price data to determine what to bill your customers.
  • Invoice reconciliation - Compare your usage data with the invoice you have received.
  • Monitoring and analytics - Add real-time CDR data to your business intelligence or analytics system to correlate it with other events.
  • Debugging - Troubleshoot issues by exploring up to 13 months of detailed usage data.

See the Reports API documentation for more information, including guides, code snippets, best practices, and pricing.

What's next?

Now that you understand the technical foundations of the Verify API, you're ready to start building!

  • Follow the Getting Started Guide to implement your first verification workflow step-by-step.

  • Explore the API Reference for a complete list of endpoints, parameters, and advanced options.