HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Identity_VerificationSession

Contains the types generated from the schema Identity_VerificationSession

  • 12 types
  • 6 values
  • Packagestripeapi-3.0.0.0
  • Exports18
  • LanguageHaskell2010
  • LicenceMIT
  • SourceIdentity_VerificationSession.hs

Defines the object schema located at components.schemas.identity.verification_session in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Create a new Identity'verificationSession with all required fields.

Defines the object schema located at components.schemas.identity.verification_session.properties.last_error.anyOf in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at components.schemas.identity.verification_session.properties.last_error.anyOf.properties.code in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the oneOf schema located at components.schemas.identity.verification_session.properties.last_verification_report.anyOf in the specification.

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

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at components.schemas.identity.verification_session.properties.redaction.anyOf in the specification.

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

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at components.schemas.identity.verification_session.properties.redaction.anyOf.properties.status in the specification.

Indicates whether this object and its related objects have been redacted or not.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at components.schemas.identity.verification_session.properties.status in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at components.schemas.identity.verification_session.properties.type in the specification.

The type of verification check to be performed.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at components.schemas.identity.verification_session.properties.verified_outputs.anyOf in the specification.

The user’s verified data.

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at components.schemas.identity.verification_session.properties.verified_outputs.anyOf.properties.address.anyOf in the specification.

The user\'s verified address.

Constructors

Instances4Eq, Show, FromJSON, ToJSON

Defines the object schema located at components.schemas.identity.verification_session.properties.verified_outputs.anyOf.properties.dob.anyOf in the specification.

The user’s verified date of birth.

Instances4Eq, Show, FromJSON, ToJSON

Defines the enum schema located at components.schemas.identity.verification_session.properties.verified_outputs.anyOf.properties.id_number_type in the specification.

The user's verified id number type.

Constructors

Instances4Eq, Show, FromJSON, ToJSON