IdentityVerificationSheet
final public class IdentityVerificationSheet
A drop-in class that presents a sheet for a user to verify their identity. This class is in beta; see https://stripe.com/docs/identity for access
-
The result of an attempt to finish an identity verification flow
See moreDeclaration
Swift
@frozen public enum VerificationFlowResult
-
Configuration for an IdentityVerificationSheet
See moreDeclaration
Swift
public struct Configuration
-
The client secret of the Stripe VerificationSession object. See https://stripe.com/docs/api/identity/verification_sessions
Declaration
Swift
public let verificationSessionClientSecret: String
-
Initializes a web-based
IdentityVerificationSheet
.Declaration
Swift
@available(iOS 14.3, *) public convenience init(verificationSessionClientSecret: String)
Parameters
verificationSessionClientSecret
The client secret of a Stripe VerificationSession object.
-
Initializes an
IdentityVerificationSheet
from native iOS components.Note
This initializer and creating an ephemeral key for a VerificationSession is available on an invite only basis. Please contact support+identity@stripe.com to learn more.
Declaration
Swift
@available(iOSApplicationExtension, unavailable) @available(macCatalystApplicationExtension, unavailable) public convenience init( verificationSessionId: String, ephemeralKeySecret: String, configuration: Configuration )
Parameters
verificationSessionId
The id of a Stripe VerificationSession object.
ephemeralKeySecret
A short-lived token that allows the SDK to access a VerificationSession object.
configuration
Configuration for the
IdentityVerificationSheet
including your brand logo. -
Presents a sheet for a customer to verify their identity.
Declaration
Swift
@available(iOSApplicationExtension, unavailable) public func present( from presentingViewController: UIViewController, completion: @escaping (VerificationFlowResult) -> Void )
Parameters
presentingViewController
The view controller to present the identity verification sheet.
completion
Called with the result of the verification session after the identity verification sheet is dismissed.
-
When running on the simulator, mocks the camera output for document scanning with these images
-
When running on the simulator, mocks the camera output for selfie scanning with these images