Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetIdentityVerificationReports

Contains the different functions to run the operation getIdentityVerificationReports

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetIdentityVerificationReports.hs

valuegetIdentityVerificationReports

:: MonadHTTP m
=> GetIdentityVerificationReportsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetIdentityVerificationReportsResponse)
Monadic computation which returns the result of the operation

GET /v1/identity/verification_reports

<p>List all verification reports.</p>

datadata GetIdentityVerificationReportsParameters

Defines the object schema located at paths./v1/identity/verification_reports.GET.parameters in the specification.

Constructors

GetIdentityVerificationReportsParameters
- getIdentityVerificationReportsParametersQueryCreated :: Maybe GetIdentityVerificationReportsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getIdentityVerificationReportsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  Constraints:
  - Maximum length of 5000
- getIdentityVerificationReportsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getIdentityVerificationReportsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getIdentityVerificationReportsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  Constraints:
  - Maximum length of 5000
- getIdentityVerificationReportsParametersQueryType :: Maybe GetIdentityVerificationReportsParametersQueryType'
  queryType: Represents the parameter named 'type'
  Only return VerificationReports of this type
- getIdentityVerificationReportsParametersQueryVerificationSession :: Maybe Text
  queryVerification_session: Represents the parameter named 'verification_session'
  Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationReportsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
FromJSON GetIdentityVerificationReportsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
ToJSON GetIdentityVerificationReportsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

valuemkGetIdentityVerificationReportsParameters :: GetIdentityVerificationReportsParameters

Create a new GetIdentityVerificationReportsParameters with all required fields.

datadata GetIdentityVerificationReportsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/identity/verification_reports.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetIdentityVerificationReportsParametersQueryCreated'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationReportsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
FromJSON GetIdentityVerificationReportsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
ToJSON GetIdentityVerificationReportsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

value

mkGetIdentityVerificationReportsParametersQueryCreated'OneOf1 :: GetIdentityVerificationReportsParametersQueryCreated'OneOf1

Create a new GetIdentityVerificationReportsParametersQueryCreated'OneOf1 with all required fields.

datadata GetIdentityVerificationReportsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/identity/verification_reports.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetIdentityVerificationReportsParametersQueryCreated'GetIdentityVerificationReportsParametersQueryCreated'OneOf1 GetIdentityVerificationReportsParametersQueryCreated'OneOf1
GetIdentityVerificationReportsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationReportsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
FromJSON GetIdentityVerificationReportsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
ToJSON GetIdentityVerificationReportsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

datadata GetIdentityVerificationReportsParametersQueryType'

Defines the enum schema located at paths./v1/identity/verification_reports.GET.parameters.properties.queryType in the specification.

Represents the parameter named 'type'

Only return VerificationReports of this type

Constructors

GetIdentityVerificationReportsParametersQueryType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIdentityVerificationReportsParametersQueryType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetIdentityVerificationReportsParametersQueryType'EnumDocument
Represents the JSON value "document"
GetIdentityVerificationReportsParametersQueryType'EnumIdNumber
Represents the JSON value "id_number"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationReportsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
FromJSON GetIdentityVerificationReportsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
ToJSON GetIdentityVerificationReportsParametersQueryType'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

datadata GetIdentityVerificationReportsResponse

Represents a response of the operation getIdentityVerificationReports.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetIdentityVerificationReportsResponseError is used.

Constructors

GetIdentityVerificationReportsResponseError String
Means either no matching case available or a parse error
GetIdentityVerificationReportsResponse200 GetIdentityVerificationReportsResponseBody200
Successful response.
GetIdentityVerificationReportsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetIdentityVerificationReportsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

datadata GetIdentityVerificationReportsResponseBody200

Defines the object schema located at paths./v1/identity/verification_reports.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetIdentityVerificationReportsResponseBody200
- getIdentityVerificationReportsResponseBody200Data :: [Identity'verificationReport]
  data
- getIdentityVerificationReportsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getIdentityVerificationReportsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/identity/verification_reports'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationReportsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
Show GetIdentityVerificationReportsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
FromJSON GetIdentityVerificationReportsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports
ToJSON GetIdentityVerificationReportsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationReports

valuemkGetIdentityVerificationReportsResponseBody200

:: [Identity'verificationReport]
getIdentityVerificationReportsResponseBody200Data
-> Bool
getIdentityVerificationReportsResponseBody200HasMore
-> Text
getIdentityVerificationReportsResponseBody200Url
-> GetIdentityVerificationReportsResponseBody200

Create a new GetIdentityVerificationReportsResponseBody200 with all required fields.