Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostIdentityVerificationSessionsSession

Description

Contains the different functions to run the operation postIdentityVerificationSessionsSession

Synopsis

postIdentityVerificationSessionsSession :: forall m. MonadHTTP m => Text -> Maybe PostIdentityVerificationSessionsSessionRequestBody -> ClientT m (Response PostIdentityVerificationSessionsSessionResponse)
data PostIdentityVerificationSessionsSessionRequestBody = PostIdentityVerificationSessionsSessionRequestBody {
}
mkPostIdentityVerificationSessionsSessionRequestBody :: PostIdentityVerificationSessionsSessionRequestBody
data PostIdentityVerificationSessionsSessionRequestBodyOptions' = PostIdentityVerificationSessionsSessionRequestBodyOptions' {
- postIdentityVerificationSessionsSessionRequestBodyOptions'Document :: Maybe PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants
}
mkPostIdentityVerificationSessionsSessionRequestBodyOptions' :: PostIdentityVerificationSessionsSessionRequestBodyOptions'
data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 = PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 {
}
mkPostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1
data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'
data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants
- = PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'EmptyString
- | PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1
data PostIdentityVerificationSessionsSessionRequestBodyType'
data PostIdentityVerificationSessionsSessionResponse

Documentation

postIdentityVerificationSessionsSession Source #

Arguments

:: forall m. MonadHTTP m
=> Text	session \| Constraints: Maximum length of 5000
-> Maybe PostIdentityVerificationSessionsSessionRequestBody	The request body to send
-> ClientT m (Response PostIdentityVerificationSessionsSessionResponse)	Monadic computation which returns the result of the operation

POST /v1/identity/verification_sessions/{session}

<p>Updates a VerificationSession object.</p>

<p>When the session status is <code>requires_input</code>, you can use this method to update the verification check and options.</p>

data PostIdentityVerificationSessionsSessionRequestBody Source #

Defines the object schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostIdentityVerificationSessionsSessionRequestBody

Fields

postIdentityVerificationSessionsSessionRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postIdentityVerificationSessionsSessionRequestBodyMetadata :: Maybe Object
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postIdentityVerificationSessionsSessionRequestBodyOptions :: Maybe PostIdentityVerificationSessionsSessionRequestBodyOptions'
options: A set of options for the session’s verification checks.
postIdentityVerificationSessionsSessionRequestBodyType :: Maybe PostIdentityVerificationSessionsSessionRequestBodyType'
type: The type of verification check to be performed.

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBody -> PostIdentityVerificationSessionsSessionRequestBody -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBody -> PostIdentityVerificationSessionsSessionRequestBody -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBody -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBody -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBody] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBody -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBody -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBody] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBody] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBody # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBody] #

mkPostIdentityVerificationSessionsSessionRequestBody :: PostIdentityVerificationSessionsSessionRequestBody Source #

Create a new PostIdentityVerificationSessionsSessionRequestBody with all required fields.

data PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #

Defines the object schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options in the specification.

A set of options for the session’s verification checks.

Constructors

PostIdentityVerificationSessionsSessionRequestBodyOptions'
Fields postIdentityVerificationSessionsSessionRequestBodyOptions'Document :: Maybe PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants document

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBodyOptions' -> PostIdentityVerificationSessionsSessionRequestBodyOptions' -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBodyOptions' -> PostIdentityVerificationSessionsSessionRequestBodyOptions' -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBodyOptions' -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBodyOptions' -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBodyOptions' -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBodyOptions' -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBodyOptions' # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBodyOptions'] #

mkPostIdentityVerificationSessionsSessionRequestBodyOptions' :: PostIdentityVerificationSessionsSessionRequestBodyOptions' Source #

Create a new PostIdentityVerificationSessionsSessionRequestBodyOptions' with all required fields.

data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #

Defines the object schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf in the specification.

Constructors

PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1

Fields

postIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes :: Maybe [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes']
allowed_types
postIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1RequireIdNumber :: Maybe Bool
require_id_number
postIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1RequireLiveCapture :: Maybe Bool
require_live_capture
postIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1RequireMatchingSelfie :: Maybe Bool
require_matching_selfie

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1] #

mkPostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 Source #

Create a new PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 with all required fields.

data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' Source #

Defines the enum schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf.properties.allowed_types.items in the specification.

Constructors

PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'EnumDrivingLicense	Represents the JSON value `"driving_license"`
PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'EnumIdCard	Represents the JSON value `"id_card"`
PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'EnumPassport	Represents the JSON value `"passport"`

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes' # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1AllowedTypes'] #

data PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants Source #

Defines the oneOf schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.options.properties.document.anyOf in the specification.

Constructors

PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'EmptyString	Represents the JSON value `""`
PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1 PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'OneOf1

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBodyOptions'Document'Variants] #

data PostIdentityVerificationSessionsSessionRequestBodyType' Source #

Defines the enum schema located at paths./v1/identity/verification_sessions/{session}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.type in the specification.

The type of verification check to be performed.

Constructors

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

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionRequestBodyType' -> PostIdentityVerificationSessionsSessionRequestBodyType' -> Bool # (/=) :: PostIdentityVerificationSessionsSessionRequestBodyType' -> PostIdentityVerificationSessionsSessionRequestBodyType' -> Bool #
Show PostIdentityVerificationSessionsSessionRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionRequestBodyType' -> ShowS # show :: PostIdentityVerificationSessionsSessionRequestBodyType' -> String # showList :: [PostIdentityVerificationSessionsSessionRequestBodyType'] -> ShowS #
ToJSON PostIdentityVerificationSessionsSessionRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods toJSON :: PostIdentityVerificationSessionsSessionRequestBodyType' -> Value # toEncoding :: PostIdentityVerificationSessionsSessionRequestBodyType' -> Encoding # toJSONList :: [PostIdentityVerificationSessionsSessionRequestBodyType'] -> Value # toEncodingList :: [PostIdentityVerificationSessionsSessionRequestBodyType'] -> Encoding #
FromJSON PostIdentityVerificationSessionsSessionRequestBodyType' Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods parseJSON :: Value -> Parser PostIdentityVerificationSessionsSessionRequestBodyType' # parseJSONList :: Value -> Parser [PostIdentityVerificationSessionsSessionRequestBodyType'] #

data PostIdentityVerificationSessionsSessionResponse Source #

Represents a response of the operation postIdentityVerificationSessionsSession.

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), PostIdentityVerificationSessionsSessionResponseError is used.

Constructors

PostIdentityVerificationSessionsSessionResponseError String	Means either no matching case available or a parse error
PostIdentityVerificationSessionsSessionResponse200 Identity'verificationSession	Successful response.
PostIdentityVerificationSessionsSessionResponseDefault Error	Error response.

Instances

Instances details

Eq PostIdentityVerificationSessionsSessionResponse Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods (==) :: PostIdentityVerificationSessionsSessionResponse -> PostIdentityVerificationSessionsSessionResponse -> Bool # (/=) :: PostIdentityVerificationSessionsSessionResponse -> PostIdentityVerificationSessionsSessionResponse -> Bool #
Show PostIdentityVerificationSessionsSessionResponse Source #
Instance details Defined in StripeAPI.Operations.PostIdentityVerificationSessionsSession Methods showsPrec :: Int -> PostIdentityVerificationSessionsSessionResponse -> ShowS # show :: PostIdentityVerificationSessionsSessionResponse -> String # showList :: [PostIdentityVerificationSessionsSessionResponse] -> ShowS #