Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// File generated from our OpenAPI spec
package com.stripe.param.identity;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class VerificationSessionCreateParams extends ApiRequestParams {
/**
* A string to reference this user. This can be a customer ID, a session ID, or similar, and can
* be used to reconcile this verification with your internal systems.
*/
@SerializedName("client_reference_id")
String clientReferenceId;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format. Individual keys can be unset by posting an empty value to them. All keys can
* be unset by posting an empty value to {@code metadata}.
*/
@SerializedName("metadata")
Map metadata;
/** A set of options for the session’s verification checks. */
@SerializedName("options")
Options options;
/** Details provided about the user being verified. These details may be shown to the user. */
@SerializedName("provided_details")
ProvidedDetails providedDetails;
/** Token referencing a Customer resource. */
@SerializedName("related_customer")
String relatedCustomer;
/** The URL that the user will be redirected to upon completing the verification flow. */
@SerializedName("return_url")
String returnUrl;
/**
* The type of verification
* check to be performed. You must provide a {@code type} if not passing {@code
* verification_flow}.
*/
@SerializedName("type")
Type type;
/**
* The ID of a Verification Flow from the Dashboard. See
* https://docs.stripe.com/identity/verification-flows.
*/
@SerializedName("verification_flow")
String verificationFlow;
private VerificationSessionCreateParams(
String clientReferenceId,
List expand,
Map extraParams,
Map metadata,
Options options,
ProvidedDetails providedDetails,
String relatedCustomer,
String returnUrl,
Type type,
String verificationFlow) {
this.clientReferenceId = clientReferenceId;
this.expand = expand;
this.extraParams = extraParams;
this.metadata = metadata;
this.options = options;
this.providedDetails = providedDetails;
this.relatedCustomer = relatedCustomer;
this.returnUrl = returnUrl;
this.type = type;
this.verificationFlow = verificationFlow;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String clientReferenceId;
private List expand;
private Map extraParams;
private Map metadata;
private Options options;
private ProvidedDetails providedDetails;
private String relatedCustomer;
private String returnUrl;
private Type type;
private String verificationFlow;
/** Finalize and obtain parameter instance from this builder. */
public VerificationSessionCreateParams build() {
return new VerificationSessionCreateParams(
this.clientReferenceId,
this.expand,
this.extraParams,
this.metadata,
this.options,
this.providedDetails,
this.relatedCustomer,
this.returnUrl,
this.type,
this.verificationFlow);
}
/**
* A string to reference this user. This can be a customer ID, a session ID, or similar, and can
* be used to reconcile this verification with your internal systems.
*/
public Builder setClientReferenceId(String clientReferenceId) {
this.clientReferenceId = clientReferenceId;
return this;
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* VerificationSessionCreateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* VerificationSessionCreateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* VerificationSessionCreateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link VerificationSessionCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* VerificationSessionCreateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link VerificationSessionCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/** A set of options for the session’s verification checks. */
public Builder setOptions(VerificationSessionCreateParams.Options options) {
this.options = options;
return this;
}
/** Details provided about the user being verified. These details may be shown to the user. */
public Builder setProvidedDetails(
VerificationSessionCreateParams.ProvidedDetails providedDetails) {
this.providedDetails = providedDetails;
return this;
}
/** Token referencing a Customer resource. */
public Builder setRelatedCustomer(String relatedCustomer) {
this.relatedCustomer = relatedCustomer;
return this;
}
/** The URL that the user will be redirected to upon completing the verification flow. */
public Builder setReturnUrl(String returnUrl) {
this.returnUrl = returnUrl;
return this;
}
/**
* The type of verification
* check to be performed. You must provide a {@code type} if not passing {@code
* verification_flow}.
*/
public Builder setType(VerificationSessionCreateParams.Type type) {
this.type = type;
return this;
}
/**
* The ID of a Verification Flow from the Dashboard. See
* https://docs.stripe.com/identity/verification-flows.
*/
public Builder setVerificationFlow(String verificationFlow) {
this.verificationFlow = verificationFlow;
return this;
}
}
@Getter
public static class Options {
/**
* Options that apply to the document check.
*/
@SerializedName("document")
Object document;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
private Options(Object document, Map extraParams) {
this.document = document;
this.extraParams = extraParams;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Object document;
private Map extraParams;
/** Finalize and obtain parameter instance from this builder. */
public VerificationSessionCreateParams.Options build() {
return new VerificationSessionCreateParams.Options(this.document, this.extraParams);
}
/**
* Options that apply to the document
* check.
*/
public Builder setDocument(VerificationSessionCreateParams.Options.Document document) {
this.document = document;
return this;
}
/**
* Options that apply to the document
* check.
*/
public Builder setDocument(EmptyParam document) {
this.document = document;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* VerificationSessionCreateParams.Options#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link VerificationSessionCreateParams.Options#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
}
@Getter
public static class Document {
/**
* Array of strings of allowed identity document types. If the provided identity document
* isn’t one of the allowed types, the verification check will fail with a
* document_type_not_allowed error code.
*/
@SerializedName("allowed_types")
List allowedTypes;
/**
* Map of extra parameters for custom features not available in this client library. The
* content in this map is not serialized under this field's {@code @SerializedName} value.
* Instead, each key/value pair is serialized as if the key is a root-level field (serialized)
* name in this param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* Collect an ID number and perform an ID number
* check with the document’s extracted name and date of birth.
*/
@SerializedName("require_id_number")
Boolean requireIdNumber;
/**
* Disable image uploads, identity document images have to be captured using the device’s
* camera.
*/
@SerializedName("require_live_capture")
Boolean requireLiveCapture;
/**
* Capture a face image and perform a selfie check
* comparing a photo ID and a picture of your user’s face. Learn more.
*/
@SerializedName("require_matching_selfie")
Boolean requireMatchingSelfie;
private Document(
List allowedTypes,
Map extraParams,
Boolean requireIdNumber,
Boolean requireLiveCapture,
Boolean requireMatchingSelfie) {
this.allowedTypes = allowedTypes;
this.extraParams = extraParams;
this.requireIdNumber = requireIdNumber;
this.requireLiveCapture = requireLiveCapture;
this.requireMatchingSelfie = requireMatchingSelfie;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private List allowedTypes;
private Map extraParams;
private Boolean requireIdNumber;
private Boolean requireLiveCapture;
private Boolean requireMatchingSelfie;
/** Finalize and obtain parameter instance from this builder. */
public VerificationSessionCreateParams.Options.Document build() {
return new VerificationSessionCreateParams.Options.Document(
this.allowedTypes,
this.extraParams,
this.requireIdNumber,
this.requireLiveCapture,
this.requireMatchingSelfie);
}
/**
* Add an element to `allowedTypes` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* VerificationSessionCreateParams.Options.Document#allowedTypes} for the field
* documentation.
*/
public Builder addAllowedType(
VerificationSessionCreateParams.Options.Document.AllowedType element) {
if (this.allowedTypes == null) {
this.allowedTypes = new ArrayList<>();
}
this.allowedTypes.add(element);
return this;
}
/**
* Add all elements to `allowedTypes` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* VerificationSessionCreateParams.Options.Document#allowedTypes} for the field
* documentation.
*/
public Builder addAllAllowedType(
List elements) {
if (this.allowedTypes == null) {
this.allowedTypes = new ArrayList<>();
}
this.allowedTypes.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link VerificationSessionCreateParams.Options.Document#extraParams} for the
* field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original
* map. See {@link VerificationSessionCreateParams.Options.Document#extraParams} for the
* field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Collect an ID number and perform an ID number
* check with the document’s extracted name and date of birth.
*/
public Builder setRequireIdNumber(Boolean requireIdNumber) {
this.requireIdNumber = requireIdNumber;
return this;
}
/**
* Disable image uploads, identity document images have to be captured using the device’s
* camera.
*/
public Builder setRequireLiveCapture(Boolean requireLiveCapture) {
this.requireLiveCapture = requireLiveCapture;
return this;
}
/**
* Capture a face image and perform a selfie check
* comparing a photo ID and a picture of your user’s face. Learn more.
*/
public Builder setRequireMatchingSelfie(Boolean requireMatchingSelfie) {
this.requireMatchingSelfie = requireMatchingSelfie;
return this;
}
}
public enum AllowedType implements ApiRequestParams.EnumParam {
@SerializedName("driving_license")
DRIVING_LICENSE("driving_license"),
@SerializedName("id_card")
ID_CARD("id_card"),
@SerializedName("passport")
PASSPORT("passport");
@Getter(onMethod_ = {@Override})
private final String value;
AllowedType(String value) {
this.value = value;
}
}
}
}
@Getter
public static class ProvidedDetails {
/** Email of user being verified. */
@SerializedName("email")
String email;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/** Phone number of user being verified. */
@SerializedName("phone")
String phone;
private ProvidedDetails(String email, Map extraParams, String phone) {
this.email = email;
this.extraParams = extraParams;
this.phone = phone;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private String email;
private Map extraParams;
private String phone;
/** Finalize and obtain parameter instance from this builder. */
public VerificationSessionCreateParams.ProvidedDetails build() {
return new VerificationSessionCreateParams.ProvidedDetails(
this.email, this.extraParams, this.phone);
}
/** Email of user being verified. */
public Builder setEmail(String email) {
this.email = email;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* VerificationSessionCreateParams.ProvidedDetails#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link VerificationSessionCreateParams.ProvidedDetails#extraParams} for the field
* documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/** Phone number of user being verified. */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("document")
DOCUMENT("document"),
@SerializedName("id_number")
ID_NUMBER("id_number");
@Getter(onMethod_ = {@Override})
private final String value;
Type(String value) {
this.value = value;
}
}
}
