Mayson Monorepo Documentation
    Preparing search index...

    A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

    Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

    Related guide: Accessing verification results.

    interface VerificationReport {
        id: string;
        object: "identity.verification_report";
        client_reference_id: string;
        created: number;
        document?: Stripe.Identity.VerificationReport.Document;
        email?: Stripe.Identity.VerificationReport.Email;
        id_number?: Stripe.Identity.VerificationReport.IdNumber;
        livemode: boolean;
        options?: Stripe.Identity.VerificationReport.Options;
        phone?: Stripe.Identity.VerificationReport.Phone;
        selfie?: Stripe.Identity.VerificationReport.Selfie;
        type: Stripe.Identity.VerificationReport.Type;
        verification_flow?: string;
        verification_session: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "identity.verification_report"

    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.

    created: number

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

    Result from a document check

    Result from a email check

    Result from an id_number check

    livemode: boolean

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

    Result from a phone check

    Result from a selfie check

    Type of report.

    verification_flow?: string

    The configuration token of a verification flow from the dashboard.

    verification_session: string

    ID of the VerificationSession that created this report.