Mayson Monorepo Documentation
    Preparing search index...

    Interface VerificationSessionCreateParams

    interface VerificationSessionCreateParams {
        client_reference_id?: string;
        expand?: string[];
        metadata?: MetadataParam;
        options?: Stripe.Identity.VerificationSessionCreateParams.Options;
        provided_details?: Stripe.Identity.VerificationSessionCreateParams.ProvidedDetails;
        related_customer?: string;
        related_customer_account?: string;
        related_person?: Stripe.Identity.VerificationSessionCreateParams.RelatedPerson;
        return_url?: string;
        type?: Stripe.Identity.VerificationSessionCreateParams.Type;
        verification_flow?: string;
    }
    Index

    Properties

    client_reference_id? expand? metadata? options? provided_details? related_customer? related_customer_account? related_person? return_url? type? verification_flow?

    Properties

    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.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    metadata?: MetadataParam

    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.

    options?: Stripe.Identity.VerificationSessionCreateParams.Options

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

    provided_details?: Stripe.Identity.VerificationSessionCreateParams.ProvidedDetails

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

    related_customer?: string

    Customer ID

    related_customer_account?: string

    The ID of the Account representing a customer.

    related_person?: Stripe.Identity.VerificationSessionCreateParams.RelatedPerson

    Tokens referencing a Person resource and it's associated account.

    return_url?: string

    The URL that the user will be redirected to upon completing the verification flow.

    type?: Stripe.Identity.VerificationSessionCreateParams.Type

    The type of verification check to be performed. You must provide a type if not passing verification_flow.

    verification_flow?: string

    The ID of a verification flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.

    Settings

    Member Visibility

    On This Page

    Properties