Constructor Detail

Method Detail

• appRealm

   final VerificationCreateParams.Options.Builder appRealm(VerificationCreateParams.Options.AppRealm appRealm)

  This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.

• appRealm

   final VerificationCreateParams.Options.Builder appRealm(JsonField<VerificationCreateParams.Options.AppRealm> appRealm)

  Sets Builder.appRealm to an arbitrary JSON value.

  You should usually call Builder.appRealm with a well-typed AppRealm value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• callbackUrl

   final VerificationCreateParams.Options.Builder callbackUrl(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.

• callbackUrl

   final VerificationCreateParams.Options.Builder callbackUrl(JsonField<String> callbackUrl)

  Sets Builder.callbackUrl to an arbitrary JSON value.

  You should usually call Builder.callbackUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• codeSize

   final VerificationCreateParams.Options.Builder codeSize(Long codeSize)

  The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.

• codeSize

   final VerificationCreateParams.Options.Builder codeSize(JsonField<Long> codeSize)

  Sets Builder.codeSize to an arbitrary JSON value.

  You should usually call Builder.codeSize with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• customCode

   final VerificationCreateParams.Options.Builder customCode(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-codes.

• customCode

   final VerificationCreateParams.Options.Builder customCode(JsonField<String> customCode)

  Sets Builder.customCode to an arbitrary JSON value.

  You should usually call Builder.customCode with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• locale

   final VerificationCreateParams.Options.Builder locale(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.

• locale

   final VerificationCreateParams.Options.Builder locale(JsonField<String> locale)

  Sets Builder.locale to an arbitrary JSON value.

  You should usually call Builder.locale with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• method

   final VerificationCreateParams.Options.Builder method(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.

• method

   final VerificationCreateParams.Options.Builder method(JsonField<VerificationCreateParams.Options.Method> method)

  Sets Builder.method to an arbitrary JSON value.

  You should usually call Builder.method with a well-typed Method value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• preferredChannel

   final VerificationCreateParams.Options.Builder preferredChannel(VerificationCreateParams.Options.PreferredChannel preferredChannel)

  The preferred channel to be used in priority for verification.

• preferredChannel

   final VerificationCreateParams.Options.Builder preferredChannel(JsonField<VerificationCreateParams.Options.PreferredChannel> preferredChannel)

  Sets Builder.preferredChannel to an arbitrary JSON value.

  You should usually call Builder.preferredChannel with a well-typed PreferredChannel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• senderId

   final VerificationCreateParams.Options.Builder senderId(String senderId)

  The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.

• senderId

   final VerificationCreateParams.Options.Builder senderId(JsonField<String> senderId)

  Sets Builder.senderId to an arbitrary JSON value.

  You should usually call Builder.senderId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• templateId

   final VerificationCreateParams.Options.Builder templateId(String templateId)

  The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.

• templateId

   final VerificationCreateParams.Options.Builder templateId(JsonField<String> templateId)

  Sets Builder.templateId to an arbitrary JSON value.

  You should usually call Builder.templateId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• variables

   final VerificationCreateParams.Options.Builder variables(VerificationCreateParams.Options.Variables variables)

  The variables to be replaced in the template.

• variables

   final VerificationCreateParams.Options.Builder variables(JsonField<VerificationCreateParams.Options.Variables> variables)

  Sets Builder.variables to an arbitrary JSON value.

  You should usually call Builder.variables with a well-typed Variables value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final VerificationCreateParams.Options.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final VerificationCreateParams.Options.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final VerificationCreateParams.Options.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final VerificationCreateParams.Options.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final VerificationCreateParams.Options.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final VerificationCreateParams.Options build()

  Returns an immutable instance of Options.

  Further updates to this Builder will not mutate the returned instance.