Mayson Monorepo Documentation
    Preparing search index...

    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

    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "identity.verification_session"

    String representing the object's type. Objects of the same type share the same value.

    client_reference_id: 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: 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: number

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

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

    last_verification_report: string | Stripe.Identity.VerificationReport

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

    livemode: boolean

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

    metadata: Metadata

    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.

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

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

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

    related_customer: string

    Customer ID

    related_customer_account: string

    The ID of the Account representing a customer.

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

    The type of verification check to be performed.

    url: 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?: string

    The configuration token of a verification flow from the dashboard.

    The user's verified data.