StripeAPI.Types.Identity_VerificationReport

Contains the types generated from the schema Identity_VerificationReport

Documentation

data Identity'verificationReport

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

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the `type` and `options` parameters used. You can find the result of each verification check performed in the appropriate sub-resource: `document`, `id_number`, `selfie`.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guides: Accessing verification results.

Constructors

Identity'verificationReport

Fields

• identity'verificationReportCreated :: Int

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

• identity'verificationReportDocument :: Maybe GelatoDocumentReport

  document: Result from a document check

• identity'verificationReportId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• identity'verificationReportIdNumber :: Maybe GelatoIdNumberReport

  id_number: Result from an id_number check

• identity'verificationReportLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• identity'verificationReportOptions :: GelatoVerificationReportOptions

  options:

• identity'verificationReportSelfie :: Maybe GelatoSelfieReport

  selfie: Result from a selfie check

• identity'verificationReportType :: Identity'verificationReportType'

  type: Type of report.

• identity'verificationReportVerificationSession :: Maybe Text

  verification_session: ID of the VerificationSession that created this report.

  Constraints:

  • Maximum length of 5000

Instances

Eq Identity'verificationReport

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

(==) :: Identity'verificationReport -> Identity'verificationReport -> Bool

(/=) :: Identity'verificationReport -> Identity'verificationReport -> Bool

Show Identity'verificationReport

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

showsPrec :: Int -> Identity'verificationReport -> ShowS

show :: Identity'verificationReport -> String

showList :: [Identity'verificationReport] -> ShowS

ToJSON Identity'verificationReport

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

toJSON :: Identity'verificationReport -> Value

toEncoding :: Identity'verificationReport -> Encoding

toJSONList :: [Identity'verificationReport] -> Value

toEncodingList :: [Identity'verificationReport] -> Encoding

FromJSON Identity'verificationReport

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

parseJSON :: Value -> Parser Identity'verificationReport

parseJSONList :: Value -> Parser [Identity'verificationReport]

mkIdentity'verificationReport

Arguments

:: Int

identity'verificationReportCreated

-> Text

identity'verificationReportId

-> Bool

identity'verificationReportLivemode

-> GelatoVerificationReportOptions

identity'verificationReportOptions

-> Identity'verificationReportType'

identity'verificationReportType

-> Identity'verificationReport

Create a new Identity'verificationReport with all required fields.

data Identity'verificationReportType'

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

Type of report.

Constructors

Identity'verificationReportType'Other Value

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

Identity'verificationReportType'Typed Text

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

Identity'verificationReportType'EnumDocument

Represents the JSON value "document"

Identity'verificationReportType'EnumIdNumber

Represents the JSON value "id_number"

Instances

Eq Identity'verificationReportType'

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

(==) :: Identity'verificationReportType' -> Identity'verificationReportType' -> Bool

(/=) :: Identity'verificationReportType' -> Identity'verificationReportType' -> Bool

Show Identity'verificationReportType'

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

showsPrec :: Int -> Identity'verificationReportType' -> ShowS

show :: Identity'verificationReportType' -> String

showList :: [Identity'verificationReportType'] -> ShowS

ToJSON Identity'verificationReportType'

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

toJSON :: Identity'verificationReportType' -> Value

toEncoding :: Identity'verificationReportType' -> Encoding

toJSONList :: [Identity'verificationReportType'] -> Value

toEncodingList :: [Identity'verificationReportType'] -> Encoding

FromJSON Identity'verificationReportType'

Defined in StripeAPI.Types.Identity_VerificationReport

Methods

parseJSON :: Value -> Parser Identity'verificationReportType'

parseJSONList :: Value -> Parser [Identity'verificationReportType']