Start Verification
vonage.verify_request
ActionVoice & SMSconnection required
Calls the Vonage API with the connection's credentials.
Start a Verify v2 check: Vonage generates a one-time code and delivers it over the channels named in the workflow, falling back through them in order. Returns the request id the check operation needs.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Vonage
- Secret shape
- {"api_key": "…", "api_secret": "…"}
- Config it needs
- api_region, from_number
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
brand The name the recipient sees as the sender of the code, up to 18 characters. | string | Yes | — | 1–18 characters | Acme |
to The number to verify, in E.164 format without a leading plus. Leave blank when giving an explicit workflow. | string | No | — | ≤ 50 characters | 447700900000 |
channel The single channel to deliver the code over when no explicit workflow is given. | string | No | sms | one of "silent_auth", "sms", "voice", "whatsapp", "rcs" | — |
workflow An explicit fallback chain of up to three steps, each an object with a channel and a to, tried in order. | array | No | — | array of object | — |
locale The language Vonage sends the code message in, such as en-us or es-es. | string | No | — | — | en-us |
channel_timeout How many seconds to wait for the code before falling back to the next channel in the workflow. | number | No | — | 15–900 | — |
code_length How many characters the generated code has. | number | No | — | 4–10 | — |
client_ref Your own reference for this verification, echoed back on the callbacks. | string | No | — | 1–40 characters | — |
template_id A custom message template to send the code with, on the SMS and RCS channels only. | string | No | — | — | — |
fraud_check Run Vonage's fraud check on the destination first. Only accounts with the capability enabled may set this. | boolean | No | — | — | — |
- At least one of to, workflow must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"brand": "Acme",
"channel": "sms",
"locale": "en-us",
"to": "447700900000"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
request_id The id of the verification, needed to check a code. | string | — |
check_url The URL that completes a silent-authentication check; empty for every other channel. | string | — |
{
"check_url": "",
"request_id": ""
}See Start Verification run in a workflow.
In a technical demo we add the Vonage connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.