Package com.stripe.param.identity

Class VerificationSessionCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.identity.VerificationSessionCreateParams

public class VerificationSessionCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VerificationSessionCreateParams.Builder
static class	VerificationSessionCreateParams.Options
static class	VerificationSessionCreateParams.ProvidedDetails	Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face.
static enum	VerificationSessionCreateParams.Type	Phone number of user being verified.

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static VerificationSessionCreateParams.Builder	builder()
String	getClientReferenceId()	A string to reference this user.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
VerificationSessionCreateParams.Options	getOptions()	A set of options for the session’s verification checks.
VerificationSessionCreateParams.ProvidedDetails	getProvidedDetails()	Details provided about the user being verified.
String	getRelatedCustomer()	Token referencing a Customer resource.
String	getReturnUrl()	The URL that the user will be redirected to upon completing the verification flow.
VerificationSessionCreateParams.Type	getType()	The type of verification check to be performed.
String	getVerificationFlow()	The ID of a Verification Flow from the Dashboard.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static VerificationSessionCreateParams.Builder builder()

getClientReferenceId

public String getClientReferenceId()

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.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,Object> getExtraParams()

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

getMetadata

public Map<String,String> getMetadata()

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

getOptions

public VerificationSessionCreateParams.Options getOptions()

A set of options for the session’s verification checks.

getProvidedDetails

public VerificationSessionCreateParams.ProvidedDetails getProvidedDetails()

Details provided about the user being verified. These details may be shown to the user.

getRelatedCustomer

public String getRelatedCustomer()

Token referencing a Customer resource.

getReturnUrl

public String getReturnUrl()

The URL that the user will be redirected to upon completing the verification flow.

getType

public VerificationSessionCreateParams.Type getType()

The type of verification check to be performed. You must provide a type if not passing verification_flow.

getVerificationFlow

public String getVerificationFlow()

The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.