stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Identity_VerificationSession

Description

Contains the types generated from the schema Identity_VerificationSession

Synopsis

Documentation

data Identity'verificationSession Source #

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

Identity'verificationSession 

Fields

data Identity'verificationSessionLastError' Source #

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

Identity'verificationSessionLastError' 

Fields

data Identity'verificationSessionLastError'Code' Source #

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

Identity'verificationSessionLastError'Code'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Identity'verificationSessionLastError'Code'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Identity'verificationSessionLastError'Code'EnumAbandoned

Represents the JSON value "abandoned"

Identity'verificationSessionLastError'Code'EnumConsentDeclined

Represents the JSON value "consent_declined"

Identity'verificationSessionLastError'Code'EnumCountryNotSupported

Represents the JSON value "country_not_supported"

Identity'verificationSessionLastError'Code'EnumDeviceNotSupported

Represents the JSON value "device_not_supported"

Identity'verificationSessionLastError'Code'EnumDocumentExpired

Represents the JSON value "document_expired"

Identity'verificationSessionLastError'Code'EnumDocumentTypeNotSupported

Represents the JSON value "document_type_not_supported"

Identity'verificationSessionLastError'Code'EnumDocumentUnverifiedOther

Represents the JSON value "document_unverified_other"

Identity'verificationSessionLastError'Code'EnumIdNumberInsufficientDocumentData

Represents the JSON value "id_number_insufficient_document_data"

Identity'verificationSessionLastError'Code'EnumIdNumberMismatch

Represents the JSON value "id_number_mismatch"

Identity'verificationSessionLastError'Code'EnumIdNumberUnverifiedOther

Represents the JSON value "id_number_unverified_other"

Identity'verificationSessionLastError'Code'EnumSelfieDocumentMissingPhoto

Represents the JSON value "selfie_document_missing_photo"

Identity'verificationSessionLastError'Code'EnumSelfieFaceMismatch

Represents the JSON value "selfie_face_mismatch"

Identity'verificationSessionLastError'Code'EnumSelfieManipulated

Represents the JSON value "selfie_manipulated"

Identity'verificationSessionLastError'Code'EnumSelfieUnverifiedOther

Represents the JSON value "selfie_unverified_other"

Identity'verificationSessionLastError'Code'EnumUnderSupportedAge

Represents the JSON value "under_supported_age"

data Identity'verificationSessionLastVerificationReport'Variants Source #

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.

Instances

Instances details
Eq Identity'verificationSessionLastVerificationReport'Variants Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

Show Identity'verificationSessionLastVerificationReport'Variants Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

ToJSON Identity'verificationSessionLastVerificationReport'Variants Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

FromJSON Identity'verificationSessionLastVerificationReport'Variants Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

data Identity'verificationSessionRedaction' Source #

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.

Constructors

Identity'verificationSessionRedaction' 

Fields

data Identity'verificationSessionRedaction'Status' Source #

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

Identity'verificationSessionRedaction'Status'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Identity'verificationSessionRedaction'Status'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Identity'verificationSessionRedaction'Status'EnumProcessing

Represents the JSON value "processing"

Identity'verificationSessionRedaction'Status'EnumRedacted

Represents the JSON value "redacted"

data Identity'verificationSessionStatus' Source #

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

Identity'verificationSessionStatus'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Identity'verificationSessionStatus'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Identity'verificationSessionStatus'EnumCanceled

Represents the JSON value "canceled"

Identity'verificationSessionStatus'EnumProcessing

Represents the JSON value "processing"

Identity'verificationSessionStatus'EnumRequiresInput

Represents the JSON value "requires_input"

Identity'verificationSessionStatus'EnumVerified

Represents the JSON value "verified"

data Identity'verificationSessionType' Source #

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

Identity'verificationSessionType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Identity'verificationSessionType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Identity'verificationSessionType'EnumDocument

Represents the JSON value "document"

Identity'verificationSessionType'EnumIdNumber

Represents the JSON value "id_number"

data Identity'verificationSessionVerifiedOutputs' Source #

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

The user’s verified data.

Constructors

Identity'verificationSessionVerifiedOutputs' 

Fields

data Identity'verificationSessionVerifiedOutputs'Address' Source #

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

Identity'verificationSessionVerifiedOutputs'Address' 

Fields

Instances

Instances details
Eq Identity'verificationSessionVerifiedOutputs'Address' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

Show Identity'verificationSessionVerifiedOutputs'Address' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

ToJSON Identity'verificationSessionVerifiedOutputs'Address' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

FromJSON Identity'verificationSessionVerifiedOutputs'Address' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

data Identity'verificationSessionVerifiedOutputs'Dob' Source #

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.

Instances

Instances details
Eq Identity'verificationSessionVerifiedOutputs'Dob' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

Show Identity'verificationSessionVerifiedOutputs'Dob' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

ToJSON Identity'verificationSessionVerifiedOutputs'Dob' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

FromJSON Identity'verificationSessionVerifiedOutputs'Dob' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

data Identity'verificationSessionVerifiedOutputs'IdNumberType' Source #

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

Identity'verificationSessionVerifiedOutputs'IdNumberType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Identity'verificationSessionVerifiedOutputs'IdNumberType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumBrCpf

Represents the JSON value "br_cpf"

Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumSgNric

Represents the JSON value "sg_nric"

Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumUsSsn

Represents the JSON value "us_ssn"

Instances

Instances details
Eq Identity'verificationSessionVerifiedOutputs'IdNumberType' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

Show Identity'verificationSessionVerifiedOutputs'IdNumberType' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

ToJSON Identity'verificationSessionVerifiedOutputs'IdNumberType' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession

FromJSON Identity'verificationSessionVerifiedOutputs'IdNumberType' Source # 
Instance details

Defined in StripeAPI.Types.Identity_VerificationSession