Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Identity_VerificationSession
Description
Contains the types generated from the schema Identity_VerificationSession
Synopsis
- data Identity'verificationSession = Identity'verificationSession {
- identity'verificationSessionClientSecret :: Maybe Text
- identity'verificationSessionCreated :: Int
- identity'verificationSessionId :: Text
- identity'verificationSessionLastError :: Maybe Identity'verificationSessionLastError'
- identity'verificationSessionLastVerificationReport :: Maybe Identity'verificationSessionLastVerificationReport'Variants
- identity'verificationSessionLivemode :: Bool
- identity'verificationSessionMetadata :: Object
- identity'verificationSessionOptions :: GelatoVerificationSessionOptions
- identity'verificationSessionRedaction :: Maybe Identity'verificationSessionRedaction'
- identity'verificationSessionStatus :: Identity'verificationSessionStatus'
- identity'verificationSessionType :: Identity'verificationSessionType'
- identity'verificationSessionUrl :: Maybe Text
- identity'verificationSessionVerifiedOutputs :: Maybe Identity'verificationSessionVerifiedOutputs'
- mkIdentity'verificationSession :: Int -> Text -> Bool -> Object -> GelatoVerificationSessionOptions -> Identity'verificationSessionStatus' -> Identity'verificationSessionType' -> Identity'verificationSession
- data Identity'verificationSessionLastError' = Identity'verificationSessionLastError' {}
- mkIdentity'verificationSessionLastError' :: Identity'verificationSessionLastError'
- data Identity'verificationSessionLastError'Code'
- = Identity'verificationSessionLastError'Code'Other Value
- | Identity'verificationSessionLastError'Code'Typed Text
- | Identity'verificationSessionLastError'Code'EnumAbandoned
- | Identity'verificationSessionLastError'Code'EnumConsentDeclined
- | Identity'verificationSessionLastError'Code'EnumCountryNotSupported
- | Identity'verificationSessionLastError'Code'EnumDeviceNotSupported
- | Identity'verificationSessionLastError'Code'EnumDocumentExpired
- | Identity'verificationSessionLastError'Code'EnumDocumentTypeNotSupported
- | Identity'verificationSessionLastError'Code'EnumDocumentUnverifiedOther
- | Identity'verificationSessionLastError'Code'EnumIdNumberInsufficientDocumentData
- | Identity'verificationSessionLastError'Code'EnumIdNumberMismatch
- | Identity'verificationSessionLastError'Code'EnumIdNumberUnverifiedOther
- | Identity'verificationSessionLastError'Code'EnumSelfieDocumentMissingPhoto
- | Identity'verificationSessionLastError'Code'EnumSelfieFaceMismatch
- | Identity'verificationSessionLastError'Code'EnumSelfieManipulated
- | Identity'verificationSessionLastError'Code'EnumSelfieUnverifiedOther
- | Identity'verificationSessionLastError'Code'EnumUnderSupportedAge
- data Identity'verificationSessionLastVerificationReport'Variants
- data Identity'verificationSessionRedaction' = Identity'verificationSessionRedaction' {}
- mkIdentity'verificationSessionRedaction' :: Identity'verificationSessionRedaction'
- data Identity'verificationSessionRedaction'Status'
- data Identity'verificationSessionStatus'
- data Identity'verificationSessionType'
- data Identity'verificationSessionVerifiedOutputs' = Identity'verificationSessionVerifiedOutputs' {
- identity'verificationSessionVerifiedOutputs'Address :: Maybe Identity'verificationSessionVerifiedOutputs'Address'
- identity'verificationSessionVerifiedOutputs'Dob :: Maybe Identity'verificationSessionVerifiedOutputs'Dob'
- identity'verificationSessionVerifiedOutputs'FirstName :: Maybe Text
- identity'verificationSessionVerifiedOutputs'IdNumber :: Maybe Text
- identity'verificationSessionVerifiedOutputs'IdNumberType :: Maybe Identity'verificationSessionVerifiedOutputs'IdNumberType'
- identity'verificationSessionVerifiedOutputs'LastName :: Maybe Text
- mkIdentity'verificationSessionVerifiedOutputs' :: Identity'verificationSessionVerifiedOutputs'
- data Identity'verificationSessionVerifiedOutputs'Address' = Identity'verificationSessionVerifiedOutputs'Address' {
- identity'verificationSessionVerifiedOutputs'Address'City :: Maybe Text
- identity'verificationSessionVerifiedOutputs'Address'Country :: Maybe Text
- identity'verificationSessionVerifiedOutputs'Address'Line1 :: Maybe Text
- identity'verificationSessionVerifiedOutputs'Address'Line2 :: Maybe Text
- identity'verificationSessionVerifiedOutputs'Address'PostalCode :: Maybe Text
- identity'verificationSessionVerifiedOutputs'Address'State :: Maybe Text
- mkIdentity'verificationSessionVerifiedOutputs'Address' :: Identity'verificationSessionVerifiedOutputs'Address'
- data Identity'verificationSessionVerifiedOutputs'Dob' = Identity'verificationSessionVerifiedOutputs'Dob' {}
- mkIdentity'verificationSessionVerifiedOutputs'Dob' :: Identity'verificationSessionVerifiedOutputs'Dob'
- data Identity'verificationSessionVerifiedOutputs'IdNumberType'
- = Identity'verificationSessionVerifiedOutputs'IdNumberType'Other Value
- | Identity'verificationSessionVerifiedOutputs'IdNumberType'Typed Text
- | Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumBrCpf
- | Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumSgNric
- | Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumUsSsn
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
|
Instances
mkIdentity'verificationSession Source #
Arguments
:: Int | |
-> Text | |
-> Bool | |
-> Object | |
-> GelatoVerificationSessionOptions | |
-> Identity'verificationSessionStatus' | |
-> Identity'verificationSessionType' | |
-> Identity'verificationSession |
Create a new Identity'verificationSession
with all required 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
|
Instances
mkIdentity'verificationSessionLastError' :: Identity'verificationSessionLastError' Source #
Create a new Identity'verificationSessionLastError'
with all required 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
Instances
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.
Constructors
Identity'verificationSessionLastVerificationReport'Text Text | |
Identity'verificationSessionLastVerificationReport'Identity'verificationReport Identity'verificationReport |
Instances
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
|
Instances
mkIdentity'verificationSessionRedaction' :: Identity'verificationSessionRedaction' Source #
Create a new Identity'verificationSessionRedaction'
with all required 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 |
Identity'verificationSessionRedaction'Status'EnumRedacted | Represents the JSON value |
Instances
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 |
Identity'verificationSessionStatus'EnumProcessing | Represents the JSON value |
Identity'verificationSessionStatus'EnumRequiresInput | Represents the JSON value |
Identity'verificationSessionStatus'EnumVerified | Represents the JSON value |
Instances
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 |
Identity'verificationSessionType'EnumIdNumber | Represents the JSON value |
Instances
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
|
Instances
mkIdentity'verificationSessionVerifiedOutputs' :: Identity'verificationSessionVerifiedOutputs' Source #
Create a new Identity'verificationSessionVerifiedOutputs'
with all required 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
mkIdentity'verificationSessionVerifiedOutputs'Address' :: Identity'verificationSessionVerifiedOutputs'Address' Source #
Create a new Identity'verificationSessionVerifiedOutputs'Address'
with all required fields.
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.
Constructors
Identity'verificationSessionVerifiedOutputs'Dob' | |
Fields
|
Instances
mkIdentity'verificationSessionVerifiedOutputs'Dob' :: Identity'verificationSessionVerifiedOutputs'Dob' Source #
Create a new Identity'verificationSessionVerifiedOutputs'Dob'
with all required fields.
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 |
Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumSgNric | Represents the JSON value |
Identity'verificationSessionVerifiedOutputs'IdNumberType'EnumUsSsn | Represents the JSON value |