Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.GelatoDocumentReport

Contains the types generated from the schema GelatoDocumentReport

9 types
6 values

Packagestripeapi-3.0.0.0
Exports15
LanguageHaskell2010
LicenceMIT
SourceGelatoDocumentReport.hs

datadata GelatoDocumentReport

Defines the object schema located at components.schemas.gelato_document_report in the specification.

Result from a document check

Constructors

GelatoDocumentReport
- gelatoDocumentReportAddress :: Maybe (Nullable GelatoDocumentReportAddress'NonNullable)
  address: Address as it appears in the document.
- gelatoDocumentReportDob :: Maybe (Nullable GelatoDocumentReportDob'NonNullable)
  dob: Date of birth as it appears in the document.
- gelatoDocumentReportError :: Maybe (Nullable GelatoDocumentReportError'NonNullable)
  error: Details on the verification error. Present when status is `unverified`.
- gelatoDocumentReportExpirationDate :: Maybe (Nullable GelatoDocumentReportExpirationDate'NonNullable)
  expiration_date: Expiration date of the document.
- gelatoDocumentReportFiles :: Maybe (Nullable [Text])
  files: Array of File ids containing images for this document.
- gelatoDocumentReportFirstName :: Maybe (Nullable Text)
  first_name: First name as it appears in the document.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportIssuedDate :: Maybe (Nullable GelatoDocumentReportIssuedDate'NonNullable)
  issued_date: Issued date of the document.
- gelatoDocumentReportIssuingCountry :: Maybe (Nullable Text)
  issuing_country: Issuing country of the document.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportLastName :: Maybe (Nullable Text)
  last_name: Last name as it appears in the document.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportNumber :: Maybe (Nullable Text)
  number: Document ID number.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportStatus :: GelatoDocumentReportStatus'
  status: Status of this `document` check.
- gelatoDocumentReportType :: Maybe (Nullable GelatoDocumentReportType'NonNullable)
  type: Type of the document.

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReport

:: GelatoDocumentReportStatus'
gelatoDocumentReportStatus
-> GelatoDocumentReport

Create a new GelatoDocumentReport with all required fields.

datadata GelatoDocumentReportAddress'NonNullable

Defines the object schema located at components.schemas.gelato_document_report.properties.address.anyOf in the specification.

Address as it appears in the document.

Constructors

GelatoDocumentReportAddress'NonNullable
- gelatoDocumentReportAddress'NonNullableCity :: Maybe (Nullable Text)
  city: City, district, suburb, town, or village.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportAddress'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportAddress'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Address line 1 (e.g., street, PO Box, or company name).
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportAddress'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Address line 2 (e.g., apartment, suite, unit, or building).
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportAddress'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- gelatoDocumentReportAddress'NonNullableState :: Maybe (Nullable Text)
  state: State, county, province, or region.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportAddress'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReportAddress'NonNullable :: GelatoDocumentReportAddress'NonNullable

Create a new GelatoDocumentReportAddress'NonNullable with all required fields.

datadata GelatoDocumentReportDob'NonNullable

Defines the object schema located at components.schemas.gelato_document_report.properties.dob.anyOf in the specification.

Date of birth as it appears in the document.

Constructors

GelatoDocumentReportDob'NonNullable
- gelatoDocumentReportDob'NonNullableDay :: Maybe (Nullable Int)
  day: Numerical day between 1 and 31.
- gelatoDocumentReportDob'NonNullableMonth :: Maybe (Nullable Int)
  month: Numerical month between 1 and 12.
- gelatoDocumentReportDob'NonNullableYear :: Maybe (Nullable Int)
  year: The four-digit year.

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportDob'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportDob'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportDob'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportDob'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReportDob'NonNullable :: GelatoDocumentReportDob'NonNullable

Create a new GelatoDocumentReportDob'NonNullable with all required fields.

datadata GelatoDocumentReportError'NonNullable

Defines the object schema located at components.schemas.gelato_document_report.properties.error.anyOf in the specification.

Details on the verification error. Present when status is \`unverified\`.

Constructors

GelatoDocumentReportError'NonNullable
- gelatoDocumentReportError'NonNullableCode :: Maybe (Nullable GelatoDocumentReportError'NonNullableCode'NonNullable)
  code: A short machine-readable string giving the reason for the verification failure.
- gelatoDocumentReportError'NonNullableReason :: Maybe (Nullable Text)
  reason: A human-readable message giving the reason for the failure. These messages can be shown to your users.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportError'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportError'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportError'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportError'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReportError'NonNullable :: GelatoDocumentReportError'NonNullable

Create a new GelatoDocumentReportError'NonNullable with all required fields.

datadata GelatoDocumentReportError'NonNullableCode'NonNullable

Defines the enum schema located at components.schemas.gelato_document_report.properties.error.anyOf.properties.code in the specification.

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

Constructors

GelatoDocumentReportError'NonNullableCode'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportError'NonNullableCode'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportError'NonNullableCode'NonNullableEnumDocumentExpired
Represents the JSON value "document_expired"
GelatoDocumentReportError'NonNullableCode'NonNullableEnumDocumentTypeNotSupported
Represents the JSON value "document_type_not_supported"
GelatoDocumentReportError'NonNullableCode'NonNullableEnumDocumentUnverifiedOther
Represents the JSON value "document_unverified_other"

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportError'NonNullableCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportError'NonNullableCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportError'NonNullableCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportError'NonNullableCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

datadata GelatoDocumentReportExpirationDate'NonNullable

Defines the object schema located at components.schemas.gelato_document_report.properties.expiration_date.anyOf in the specification.

Expiration date of the document.

Constructors

GelatoDocumentReportExpirationDate'NonNullable
- gelatoDocumentReportExpirationDate'NonNullableDay :: Maybe (Nullable Int)
  day: Numerical day between 1 and 31.
- gelatoDocumentReportExpirationDate'NonNullableMonth :: Maybe (Nullable Int)
  month: Numerical month between 1 and 12.
- gelatoDocumentReportExpirationDate'NonNullableYear :: Maybe (Nullable Int)
  year: The four-digit year.

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportExpirationDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportExpirationDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportExpirationDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportExpirationDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReportExpirationDate'NonNullable :: GelatoDocumentReportExpirationDate'NonNullable

Create a new GelatoDocumentReportExpirationDate'NonNullable with all required fields.

datadata GelatoDocumentReportIssuedDate'NonNullable

Defines the object schema located at components.schemas.gelato_document_report.properties.issued_date.anyOf in the specification.

Issued date of the document.

Constructors

GelatoDocumentReportIssuedDate'NonNullable
- gelatoDocumentReportIssuedDate'NonNullableDay :: Maybe (Nullable Int)
  day: Numerical day between 1 and 31.
- gelatoDocumentReportIssuedDate'NonNullableMonth :: Maybe (Nullable Int)
  month: Numerical month between 1 and 12.
- gelatoDocumentReportIssuedDate'NonNullableYear :: Maybe (Nullable Int)
  year: The four-digit year.

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportIssuedDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportIssuedDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportIssuedDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportIssuedDate'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

valuemkGelatoDocumentReportIssuedDate'NonNullable :: GelatoDocumentReportIssuedDate'NonNullable

Create a new GelatoDocumentReportIssuedDate'NonNullable with all required fields.

datadata GelatoDocumentReportStatus'

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

Status of this `document` check.

Constructors

GelatoDocumentReportStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportStatus'EnumUnverified
Represents the JSON value "unverified"
GelatoDocumentReportStatus'EnumVerified
Represents the JSON value "verified"

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport

datadata GelatoDocumentReportType'NonNullable

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

Type of the document.

Constructors

GelatoDocumentReportType'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GelatoDocumentReportType'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
GelatoDocumentReportType'NonNullableEnumDrivingLicense
Represents the JSON value "driving_license"
GelatoDocumentReportType'NonNullableEnumIdCard
Represents the JSON value "id_card"
GelatoDocumentReportType'NonNullableEnumPassport
Represents the JSON value "passport"

Instances4Eq, Show, FromJSON, ToJSON

Eq GelatoDocumentReportType'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
Show GelatoDocumentReportType'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
FromJSON GelatoDocumentReportType'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport
ToJSON GelatoDocumentReportType'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.GelatoDocumentReport