/ 
Net-API-Stripe-v2.0.5
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::Identity::VerificationSession

NAME

Net::API::Stripe::Identity::VerificationSession - The VerificationSession object

SYNOPSIS

VERSION

v0.1.0

DESCRIPTION

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

METHODS

id string

Unique identifier for the object.

object string

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

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 timestamp

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

last_error hash

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

It has the following properties:

code string

A short machine-readable string giving the reason for the verification or user-session failure.

reason string

A message that explains the reason for verification or user-session failure.

last_verification_report expandable

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

When expanded this is an Net::API::Stripe::Identity::VerificationReport object.

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 hash

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 hash

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

It has the following properties:

document hash

Options that apply to the document check.

allowed_types array

Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a documenttypenot_allowed error code.

require_id_number boolean

Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.

require_live_capture boolean

Disable image uploads, identity document images have to be captured using the device’s camera.

require_matching_selfie boolean

Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.

id_number hash

Options that apply to the id number check.

id_number

This is an empty hash.

redaction object

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

This is a Net::API::Stripe::Balance::Transaction object.

status string

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

type string

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.

verified_outputs object

The user’s verified data.

This is a Net::API::Stripe::Connect::Person object.

API SAMPLE

[ { "client_secret" : null, "created" : "1662261086", "id" : "vs_1Le9F42eZvKYlo2Chf4NfVUc", "last_error" : null, "last_verification_report" : "vr_MMt18CcerTGCqLkvTzwaSqfw", "livemode" : 0, "metadata" : {}, "object" : "identity.verification_session", "options" : { "document" : { "require_matching_selfie" : 1 } }, "redaction" : null, "status" : "verified", "type" : "document", "url" : null } ]

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

Copyright (c) 2019-2022 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.