All Implemented Interfaces:


public final class VerificationCreateParams.Options

Verification options

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`VerificationCreateParams.Options.Builder`	A builder for Options.
`public final class`	`VerificationCreateParams.Options.AppRealm`	This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.
`public final class`	`VerificationCreateParams.Options.Variables`	The variables to be replaced in the template.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<VerificationCreateParams.Options.AppRealm>`	`appRealm()`	This allows you to automatically retrieve and fill the OTP code on mobile apps.
`final Optional<String>`	`callbackUrl()`	The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes.
`final Optional<Long>`	`codeSize()`	The size of the code generated.
`final Optional<String>`	`customCode()`	The custom code to use for OTP verification.
`final Optional<String>`	`locale()`	A BCP-47 formatted locale string with the language the text message will be sent to.
`final Optional<String>`	`senderId()`	The Sender ID to use for this message.
`final Optional<String>`	`templateId()`	The identifier of a verification template.
`final Optional<VerificationCreateParams.Options.Variables>`	`variables()`	The variables to be replaced in the template.
`final JsonField<VerificationCreateParams.Options.AppRealm>`	`_appRealm()`	This allows you to automatically retrieve and fill the OTP code on mobile apps.
`final JsonField<String>`	`_callbackUrl()`	The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes.
`final JsonField<Long>`	`_codeSize()`	The size of the code generated.
`final JsonField<String>`	`_customCode()`	The custom code to use for OTP verification.
`final JsonField<String>`	`_locale()`	A BCP-47 formatted locale string with the language the text message will be sent to.
`final JsonField<String>`	`_senderId()`	The Sender ID to use for this message.
`final JsonField<String>`	`_templateId()`	The identifier of a verification template.
`final JsonField<VerificationCreateParams.Options.Variables>`	`_variables()`	The variables to be replaced in the template.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final VerificationCreateParams.Options`	`validate()`
`final VerificationCreateParams.Options.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static VerificationCreateParams.Options.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Options.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - appRealm
```
 final Optional<VerificationCreateParams.Options.AppRealm> appRealm()
```
    This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.
  - callbackUrl
```
 final Optional<String> callbackUrl()
```
    The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes. For more details, refer to /api-reference/v2/verify/webhook.
  - codeSize
```
 final Optional<Long> codeSize()
```
    The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.
  - customCode
```
 final Optional<String> customCode()
```
    The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case. For more details, refer to /concepts/multi-routing.
  - locale
```
 final Optional<String> locale()
```
    A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, it defaults to US English.
  - senderId
```
 final Optional<String> senderId()
```
    The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.
  - templateId
```
 final Optional<String> templateId()
```
    The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.
  - variables
```
 final Optional<VerificationCreateParams.Options.Variables> variables()
```
    The variables to be replaced in the template.
  - _appRealm
```
 final JsonField<VerificationCreateParams.Options.AppRealm> _appRealm()
```
    This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.
  - _callbackUrl
```
 final JsonField<String> _callbackUrl()
```
    The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes. For more details, refer to /api-reference/v2/verify/webhook.
  - _codeSize
```
 final JsonField<Long> _codeSize()
```
    The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.
  - _customCode
```
 final JsonField<String> _customCode()
```
    The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case. For more details, refer to /concepts/multi-routing.
  - _locale
```
 final JsonField<String> _locale()
```
    A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, it defaults to US English.
  - _senderId
```
 final JsonField<String> _senderId()
```
    The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.
  - _templateId
```
 final JsonField<String> _templateId()
```
    The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.
  - _variables
```
 final JsonField<VerificationCreateParams.Options.Variables> _variables()
```
    The variables to be replaced in the template.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final VerificationCreateParams.Options validate()
```
  - toBuilder
```
 final VerificationCreateParams.Options.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static VerificationCreateParams.Options.Builder builder()
```
    Returns a mutable builder for constructing an instance of Options.

Class VerificationCreateParams.Options

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

appRealm

callbackUrl

codeSize

customCode

locale

senderId

templateId

variables

_appRealm

_callbackUrl

_codeSize

_customCode

_locale

_senderId

_templateId

_variables

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder