Create Verification

The phone number or email to verify. Phone numbers must be in E.164 format.

The verification method to use. One of: email, sms, whatsapp, call, sna or auto.

A custom user defined friendly name that overwrites the existing one in the verification message

The text of a custom message to use for the verification.

The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of sendDigits.

Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. See supported languages and more information here.

A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

The custom key-value pairs of Programmable Rate Limits. Keys correspond to unique_name fields defined when creating your Rate Limit. Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.

email channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.

Your App Hash to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: <#> Your AppName verification code is: 1234 He42w354ol9.

The message template. If provided, will override the default template for the Service. SMS and Voice channels only.

A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.

Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.

An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.

Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo Permissions etc per verification attempt basis, allowing Verify to block traffic considered fraudulent if enabled or bypass active protections if disabled. Can be: enable(default) or disable. For SMS channel only.

A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.