Class VerificationCreateParams
-
- All Implemented Interfaces:
-
so.prelude.sdk.core.Params
public final class VerificationCreateParams implements Params
Create a new verification for a specific phone number. If another non-expired verification exists (the request is performed within the verification window), this endpoint will perform a retry instead.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
VerificationCreateParams.Body
public final class
VerificationCreateParams.Builder
A builder for VerificationCreateParams.
public final class
VerificationCreateParams.Target
The verification target. Either a phone number or an email address. To use the email verification feature contact us to discuss your use case.
public final class
VerificationCreateParams.Metadata
The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.
public final class
VerificationCreateParams.Options
Verification options
public final class
VerificationCreateParams.Signals
The signals used for anti-fraud. For more details, refer to /guides/prevent-fraud#signals.
-
Method Summary
Modifier and Type Method Description final VerificationCreateParams.Target
target()
The verification target. final Optional<String>
dispatchId()
The identifier of the dispatch that came from the front-end SDK. final Optional<VerificationCreateParams.Metadata>
metadata()
The metadata for this verification. final Optional<VerificationCreateParams.Options>
options()
Verification options final Optional<VerificationCreateParams.Signals>
signals()
The signals used for anti-fraud. final JsonField<VerificationCreateParams.Target>
_target()
The verification target. final JsonField<String>
_dispatchId()
The identifier of the dispatch that came from the front-end SDK. final JsonField<VerificationCreateParams.Metadata>
_metadata()
The metadata for this verification. final JsonField<VerificationCreateParams.Options>
_options()
Verification options final JsonField<VerificationCreateParams.Signals>
_signals()
The signals used for anti-fraud. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. final VerificationCreateParams.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VerificationCreateParams.Builder
builder()
Returns a mutable builder for constructing an instance of VerificationCreateParams. -
-
Method Detail
-
target
final VerificationCreateParams.Target target()
The verification target. Either a phone number or an email address. To use the email verification feature contact us to discuss your use case.
-
dispatchId
final Optional<String> dispatchId()
The identifier of the dispatch that came from the front-end SDK.
-
metadata
final Optional<VerificationCreateParams.Metadata> metadata()
The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.
-
options
final Optional<VerificationCreateParams.Options> options()
Verification options
-
signals
final Optional<VerificationCreateParams.Signals> signals()
The signals used for anti-fraud. For more details, refer to /guides/prevent-fraud#signals.
-
_target
final JsonField<VerificationCreateParams.Target> _target()
The verification target. Either a phone number or an email address. To use the email verification feature contact us to discuss your use case.
-
_dispatchId
final JsonField<String> _dispatchId()
The identifier of the dispatch that came from the front-end SDK.
-
_metadata
final JsonField<VerificationCreateParams.Metadata> _metadata()
The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.
-
_options
final JsonField<VerificationCreateParams.Options> _options()
Verification options
-
_signals
final JsonField<VerificationCreateParams.Signals> _signals()
The signals used for anti-fraud. For more details, refer to /guides/prevent-fraud#signals.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
toBuilder
final VerificationCreateParams.Builder toBuilder()
-
builder
final static VerificationCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of VerificationCreateParams.
The following fields are required:
.target()
-
-
-
-