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.Builder
A builder for VerificationCreateParams.
public final class
VerificationCreateParams.Body
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 /verify/v2/documentation/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()
Returns the raw JSON value of target. final JsonField<String>
_dispatchId()
Returns the raw JSON value of dispatchId. final JsonField<VerificationCreateParams.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<VerificationCreateParams.Options>
_options()
Returns the raw JSON value of options. final JsonField<VerificationCreateParams.Signals>
_signals()
Returns the raw JSON value of signals. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
Additional headers to send with the request. final QueryParams
_additionalQueryParams()
Additional query param to send with the request. final VerificationCreateParams.Builder
toBuilder()
final VerificationCreateParams.Body
_body()
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. 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 /verify/v2/documentation/prevent-fraud#signals.
-
_target
final JsonField<VerificationCreateParams.Target> _target()
Returns the raw JSON value of target.
Unlike target, this method doesn't throw if the JSON field has an unexpected type.
-
_dispatchId
final JsonField<String> _dispatchId()
Returns the raw JSON value of dispatchId.
Unlike dispatchId, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<VerificationCreateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_options
final JsonField<VerificationCreateParams.Options> _options()
Returns the raw JSON value of options.
Unlike options, this method doesn't throw if the JSON field has an unexpected type.
-
_signals
final JsonField<VerificationCreateParams.Signals> _signals()
Returns the raw JSON value of signals.
Unlike signals, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final VerificationCreateParams.Builder toBuilder()
-
_body
final VerificationCreateParams.Body _body()
-
_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.
-
builder
final static VerificationCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of VerificationCreateParams.
The following fields are required:
.target()
-
-
-
-