Vonage Verify API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 74 JSON Schema definitions.
Tagged areas include Verify. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.
This API exposes
5 operations
across 4 paths,
and defines 45 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.1.
Requests are made against a single base URL, https://api.nexmo.com/v2/verify.
5 operations4 paths45 schemas1 DELETE1 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Vonage Verify API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
It accepts HTTP bearer tokens (JWT) (bearerAuth).
basicAuth — HTTP auth can be used for synchronous calls, for asynchronous calls and call backs use JWT authentication
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Verify 5
Provides 2FA authentication for end-users.
POST
/
Request a verification be sent to a user
newRequestbody→ 202401402409412422429500
POST
/{request_id}
Check a supplied code against a request to see if it is valid
checkCode1 parambody→ 200400401402404409410429
DELETE
/{request_id}
Cancel a verification
cancelRequest1 param→ 204401402404500
POST
/{request_id}/next_workflow
Next workflow
nextWorkflow1 param→ 200401402404409500
GET
/{request_id}/silent-auth/redirect
Attempt Silent Authentication completion
silentAuthCheck1 param→ 200302401404409412500
Schemas 45
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are SMSChannel (7 properties), SilentAuthChannel (5 properties), WhatsAppChannel (5 properties), ErrorInvalidParams (5 properties). Each schema is shown below with its type and property counts.
WhatsAppChannel
object
Request a code be sent to a user
5 properties3 required
To
string
The phone number to contact, in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number, start with t…
FraudCheck
boolean
Enables fraud checking for the verification request. When set to true, the request is checked against fraud detection rules and may be blocked if identified as…
CodeSubmitSuccess
object
2 properties
FromWhatsApp
string
A WABA connected sender number, in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone number, start wit…
ErrorNetworkNotSupported
object
Network not supported
4 properties4 required
ErrorNotFound
object
Template Fragment was not found.
4 properties4 required
ErrorConflict
object
Concurrent verifications to the same number are not allowed.
4 properties4 required
RCSChannel
object
Request a code be sent to a user
4 properties3 required
FromRcs
string
An sender identifier in alphanumeric format.
ErrorInvalidCode
object
The code you provided does not match the expected value.
4 properties4 required
CheckCodeByCode
object
1 property1 required
code
string
The code provided by the user. The PIN code can be retried a maximum of three times.
ClientRef
string
If the clientref is set when the request is sent, it will be included in the callbacks
TemplateId
string
A custom template ID to use. This parameter works only when channel is sms or rcs.
CheckCodeByToken
object
1 property1 required
ErrorInternalError
object
There was an error processing your request in the Platform.
4 properties4 required
ChannelTimeout
integer
Specifies the wait time in seconds between attempts to deliver the verification code. On the Verify Success pricing model, the minimum channeltimeout is fixed…
ErrorJwtExpired
object
JWT expired
4 properties4 required
Language
string
Languages that are available to use. See the full list of supported languages in the [Verify Languages Guide](https://developer.vonage.com/en/verify/guides/ver…
CoverageCheck
boolean
Controls network coverage lookup. If true, a synchronous error is returned when the network is unsupported. If false a checkurl is always returned and errors a…
Brand
string
The brand that is sending the verification request. Please note that for security reasons, the following regex is used to escape this value: ^[^\/{}:$]$. A val…
ErrorPaymentRequired
object
This request could not be performed due to your account balance being low.
4 properties4 required
RequestId
string
The ID of the request
SilentAuthChannel
object
5 properties2 required
VoiceChannel
object
Request a code be sent to a user
3 properties2 required
ToSilentAuth
string
The phone number to use for authentication, in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Don't use a leading + or 00 when entering a phone numbe…
CodeLength
integer
Length of the code to send to the user. It applies to all channels defined in the workflow.
SMSChannel
object
7 properties2 required
ToEmail
string
The email address to send the verification request to.
ErrorConflictTriggerNext
object
The trigger-next operation cannot be performed at this time due to a replication delay. Please try again later.
4 properties4 required
ErrorUnauthorizedMissingCredentials
object
Invalid Credentials
4 properties4 required
ErrorSilentAuth
object
Silent authentication failed
4 properties4 required
Code
string
An optional alphanumeric custom code to use if you don't want Vonage to generate the code. Only the Verify Conversion pricing model allows using this parameter…
FromSms
string
An optional sender identifier in either numeric or alphanumeric format. The maximum length is 11 characters for alphanumeric and 15 for numeric. When numeric,…
ErrorInvalidParams
object
5 properties
token
string
The token for Silent Auth Advanced verification. This is mutually exclusive with the code parameter.
MailChannel
object
Request an email code be sent to the user.
4 properties2 required
Mode
string
An optional parameter to specify whether to use Silent Authentication Advanced.
SilentAuthConfirmationSuccess
object
2 properties
FromEmail
string
The email address to send the verification request from.
ReuseCode
boolean
Use the same PIN code across multiple channels within a workflow
ErrorRateLimited
object
Please wait, then retry your request.
4 properties4 required
WhatsAppMode
string
Defines the WhatsApp verification experience. Use zerotap for automatic verification on Android apps. Defaults to otpcode.
Redirect
string
Optional final redirect added at the end of the checkurl request/response lifecycle. See the documentation for integrations. Will contain the requestid and cod…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Vonage Verify API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
