StripeAPI.Types.Identity_VerificationReport · stripeapi-3.0.0.0

datadata 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
- 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 (Nullable Text)
  verification_session: ID of the VerificationSession that created this report.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq Identity'verificationReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
Show Identity'verificationReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
FromJSON Identity'verificationReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
ToJSON Identity'verificationReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport

valuemkIdentity'verificationReport

:: 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.

datadata 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"

Instances4Eq, Show, FromJSON, ToJSON

Eq Identity'verificationReportType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
Show Identity'verificationReportType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
FromJSON Identity'verificationReportType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport
ToJSON Identity'verificationReportType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Identity_VerificationReport