Struct CreateIdentityVerificationSession

pub struct CreateIdentityVerificationSession { /* private fields */ }

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

impl CreateIdentityVerificationSession

pub fn new() -> Self

Construct a new CreateIdentityVerificationSession.

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

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.

pub fn options( self, options: impl Into<CreateIdentityVerificationSessionOptions>, ) -> Self

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

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.

pub fn related_customer(self, related_customer: impl Into<String>) -> Self

Customer ID

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.

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.

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.

impl CreateIdentityVerificationSession

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

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

impl Clone for CreateIdentityVerificationSession

fn clone(&self) -> CreateIdentityVerificationSession

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateIdentityVerificationSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateIdentityVerificationSession

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for CreateIdentityVerificationSession

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for CreateIdentityVerificationSession

type Output = IdentityVerificationSession

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.