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 /verify/v2/documentation/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. To use the custom code feature, contact us to enable it for your account. For more details, refer to /verify/v2/documentation/custom-code.

• 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.

• method

   final Optional<VerificationCreateParams.Options.Method> method()

  The method used for verifying this phone number. The 'voice' option provides an accessible alternative for visually impaired users by delivering the verification code through a phone call rather than a text message. It also allows verification of landline numbers that cannot receive SMS messages.

• preferredChannel

   final Optional<VerificationCreateParams.Options.PreferredChannel> preferredChannel()

  The preferred channel to be used in priority for verification.

• 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()

  Returns the raw JSON value of appRealm.

  Unlike appRealm, this method doesn't throw if the JSON field has an unexpected type.

• _callbackUrl

   final JsonField<String> _callbackUrl()

  Returns the raw JSON value of callbackUrl.

  Unlike callbackUrl, this method doesn't throw if the JSON field has an unexpected type.

• _codeSize

   final JsonField<Long> _codeSize()

  Returns the raw JSON value of codeSize.

  Unlike codeSize, this method doesn't throw if the JSON field has an unexpected type.

• _customCode

   final JsonField<String> _customCode()

  Returns the raw JSON value of customCode.

  Unlike customCode, this method doesn't throw if the JSON field has an unexpected type.

• _locale

   final JsonField<String> _locale()

  Returns the raw JSON value of locale.

  Unlike locale, this method doesn't throw if the JSON field has an unexpected type.

• _method

   final JsonField<VerificationCreateParams.Options.Method> _method()

  Returns the raw JSON value of method.

  Unlike method, this method doesn't throw if the JSON field has an unexpected type.

• _preferredChannel

   final JsonField<VerificationCreateParams.Options.PreferredChannel> _preferredChannel()

  Returns the raw JSON value of preferredChannel.

  Unlike preferredChannel, this method doesn't throw if the JSON field has an unexpected type.

• _senderId

   final JsonField<String> _senderId()

  Returns the raw JSON value of senderId.

  Unlike senderId, this method doesn't throw if the JSON field has an unexpected type.

• _templateId

   final JsonField<String> _templateId()

  Returns the raw JSON value of templateId.

  Unlike templateId, this method doesn't throw if the JSON field has an unexpected type.

• _variables

   final JsonField<VerificationCreateParams.Options.Variables> _variables()

  Returns the raw JSON value of variables.

  Unlike variables, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final VerificationCreateParams.Options.Builder toBuilder()

• validate

   final VerificationCreateParams.Options validate()

• isValid

   final Boolean isValid()

• 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.