Struct IdentityVerificationSession

pub struct IdentityVerificationSession {

    pub client_reference_id: Option<String>,
    pub client_secret: Option<String>,
    pub created: Timestamp,
    pub id: IdentityVerificationSessionId,
    pub last_error: Option<GelatoSessionLastError>,
    pub last_verification_report: Option<Expandable<IdentityVerificationReport>>,
    pub livemode: bool,
    pub metadata: HashMap<String, String>,
    pub options: Option<GelatoVerificationSessionOptions>,
    pub provided_details: Option<GelatoProvidedDetails>,
    pub redaction: Option<VerificationSessionRedaction>,
    pub related_customer: Option<String>,
    pub status: IdentityVerificationSessionStatus,
    pub type_: IdentityVerificationSessionType,
    pub url: Option<String>,
    pub verification_flow: Option<String>,
    pub verified_outputs: Option<GelatoVerifiedOutputs>,
}

A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API.

For more details see <https://stripe.com/docs/api/identity/verification_sessions/object>.

Fields

client_reference_id: Option<String>

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.

client_secret: Option<String>

The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

id: IdentityVerificationSessionId

Unique identifier for the object.

last_error: Option<GelatoSessionLastError>

If present, this property tells you the last error encountered when processing the verification.

last_verification_report: Option<Expandable<IdentityVerificationReport>>

ID of the most recent VerificationReport. Learn more about accessing detailed verification results..

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: HashMap<String, String>

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.

options: Option<GelatoVerificationSessionOptions>

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

provided_details: Option<GelatoProvidedDetails>

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

redaction: Option<VerificationSessionRedaction>

Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.

related_customer: Option<String>

Customer ID

status: IdentityVerificationSessionStatus

Status of this VerificationSession. Learn more about the lifecycle of sessions.

type_: IdentityVerificationSessionType

The type of verification check to be performed.

url: Option<String>

The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.

verification_flow: Option<String>

The configuration token of a verification flow from the dashboard.

verified_outputs: Option<GelatoVerifiedOutputs>

The user’s verified data.

Trait Implementations

impl Clone for IdentityVerificationSession

fn clone(&self) -> IdentityVerificationSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityVerificationSession

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

Formats the value using the given formatter.

impl Deserialize for IdentityVerificationSession

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for IdentityVerificationSession

fn from_value(v: Value) -> Option<Self>

impl Object for IdentityVerificationSession

type Id = IdentityVerificationSessionId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for IdentityVerificationSession

type Builder = IdentityVerificationSessionBuilder