pub struct CreateIdentityVerificationSession { /* private fields */ }
Expand description
Creates a VerificationSession object.
After the VerificationSession is created, display a verification modal using the session client_secret
or send your users to the session’s url
.
If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents.
Implementations§
Source§impl CreateIdentityVerificationSession
impl CreateIdentityVerificationSession
Sourcepub fn client_reference_id(self, client_reference_id: impl Into<String>) -> Self
pub fn client_reference_id(self, client_reference_id: impl Into<String>) -> Self
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.
Sourcepub fn expand(self, expand: impl Into<Vec<String>>) -> Self
pub fn expand(self, expand: impl Into<Vec<String>>) -> Self
Specifies which fields in the response should be expanded.
Sourcepub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self
pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self
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
.
Sourcepub fn options(
self,
options: impl Into<CreateIdentityVerificationSessionOptions>,
) -> Self
pub fn options( self, options: impl Into<CreateIdentityVerificationSessionOptions>, ) -> Self
A set of options for the session’s verification checks.
Sourcepub fn provided_details(
self,
provided_details: impl Into<ProvidedDetailsParam>,
) -> Self
pub fn provided_details( self, provided_details: impl Into<ProvidedDetailsParam>, ) -> Self
Details provided about the user being verified. These details may be shown to the user.
Customer ID
Sourcepub fn return_url(self, return_url: impl Into<String>) -> Self
pub fn return_url(self, return_url: impl Into<String>) -> Self
The URL that the user will be redirected to upon completing the verification flow.
Sourcepub fn type_(
self,
type_: impl Into<CreateIdentityVerificationSessionType>,
) -> Self
pub fn type_( self, type_: impl Into<CreateIdentityVerificationSessionType>, ) -> Self
The type of verification check to be performed.
You must provide a type
if not passing verification_flow
.
Sourcepub fn verification_flow(self, verification_flow: impl Into<String>) -> Self
pub fn verification_flow(self, verification_flow: impl Into<String>) -> Self
The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
Source§impl CreateIdentityVerificationSession
impl CreateIdentityVerificationSession
Sourcepub async fn send<C: StripeClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>
Send the request and return the deserialized response.
Sourcepub fn send_blocking<C: StripeBlockingClient>(
&self,
client: &C,
) -> Result<<Self as StripeRequest>::Output, C::Err>
pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>
Send the request and return the deserialized response, blocking until completion.
Trait Implementations§
Source§impl Clone for CreateIdentityVerificationSession
impl Clone for CreateIdentityVerificationSession
Source§fn clone(&self) -> CreateIdentityVerificationSession
fn clone(&self) -> CreateIdentityVerificationSession
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more