Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostIdentityVerificationSessions

Description

Contains the different functions to run the operation postIdentityVerificationSessions

Synopsis

postIdentityVerificationSessions :: forall m. MonadHTTP m => PostIdentityVerificationSessionsRequestBody -> StripeT m (Response PostIdentityVerificationSessionsResponse)
data PostIdentityVerificationSessionsRequestBody = PostIdentityVerificationSessionsRequestBody {
}
mkPostIdentityVerificationSessionsRequestBody :: PostIdentityVerificationSessionsRequestBodyType' -> PostIdentityVerificationSessionsRequestBody
data PostIdentityVerificationSessionsRequestBodyOptions' = PostIdentityVerificationSessionsRequestBodyOptions' {
- postIdentityVerificationSessionsRequestBodyOptions'Document :: Maybe PostIdentityVerificationSessionsRequestBodyOptions'Document'Variants
}
mkPostIdentityVerificationSessionsRequestBodyOptions' :: PostIdentityVerificationSessionsRequestBodyOptions'
data PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 = PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 {
}
mkPostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 :: PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1
data PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes'
data PostIdentityVerificationSessionsRequestBodyOptions'Document'Variants
- = PostIdentityVerificationSessionsRequestBodyOptions'Document'EmptyString
- | PostIdentityVerificationSessionsRequestBodyOptions'Document'PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1
data PostIdentityVerificationSessionsRequestBodyType'
data PostIdentityVerificationSessionsResponse

Documentation

postIdentityVerificationSessions Source #

Arguments

:: forall m. MonadHTTP m
=> PostIdentityVerificationSessionsRequestBody	The request body to send
-> StripeT m (Response PostIdentityVerificationSessionsResponse)	Monadic computation which returns the result of the operation

POST /v1/identity/verification_sessions

Creates a VerificationSession object.

After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>.

If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

Related guide: <a href="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a>.

data PostIdentityVerificationSessionsRequestBody Source #

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

Constructors

PostIdentityVerificationSessionsRequestBody

Fields

postIdentityVerificationSessionsRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postIdentityVerificationSessionsRequestBodyMetadata :: 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`.
postIdentityVerificationSessionsRequestBodyOptions :: Maybe PostIdentityVerificationSessionsRequestBodyOptions'
options: A set of options for the session’s verification checks.
postIdentityVerificationSessionsRequestBodyReturnUrl :: Maybe Text
return_url: The URL that the user will be redirected to upon completing the verification flow.
postIdentityVerificationSessionsRequestBodyType :: PostIdentityVerificationSessionsRequestBodyType'
type: The type of verification check to be performed.

Instances

Instances details

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

mkPostIdentityVerificationSessionsRequestBody Source #

Arguments

:: PostIdentityVerificationSessionsRequestBodyType'	`postIdentityVerificationSessionsRequestBodyType`
-> PostIdentityVerificationSessionsRequestBody

Create a new PostIdentityVerificationSessionsRequestBody with all required fields.

data PostIdentityVerificationSessionsRequestBodyOptions' Source #

Defines the object schema located at paths./v1/identity/verification_sessions.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

PostIdentityVerificationSessionsRequestBodyOptions'
Fields postIdentityVerificationSessionsRequestBodyOptions'Document :: Maybe PostIdentityVerificationSessionsRequestBodyOptions'Document'Variants document

Instances

Instances details

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

mkPostIdentityVerificationSessionsRequestBodyOptions' :: PostIdentityVerificationSessionsRequestBodyOptions' Source #

Create a new PostIdentityVerificationSessionsRequestBodyOptions' with all required fields.

data PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 Source #

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

Constructors

PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1

Fields

postIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes :: Maybe [PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes']
allowed_types
postIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1RequireIdNumber :: Maybe Bool
require_id_number
postIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1RequireLiveCapture :: Maybe Bool
require_live_capture
postIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1RequireMatchingSelfie :: Maybe Bool
require_matching_selfie

Instances

Instances details

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

mkPostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 :: PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1 Source #

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

data PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes' Source #

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

Constructors

PostIdentityVerificationSessionsRequestBodyOptions'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.
PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes'EnumDrivingLicense	Represents the JSON value `"driving_license"`
PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes'EnumIdCard	Represents the JSON value `"id_card"`
PostIdentityVerificationSessionsRequestBodyOptions'Document'OneOf1AllowedTypes'EnumPassport	Represents the JSON value `"passport"`

Instances

Instances details

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

data PostIdentityVerificationSessionsRequestBodyOptions'Document'Variants Source #

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

Constructors

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

Instances

Instances details

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

data PostIdentityVerificationSessionsRequestBodyType' Source #

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

The type of verification check to be performed.

Constructors

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

Instances

Instances details

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

data PostIdentityVerificationSessionsResponse Source #

Represents a response of the operation postIdentityVerificationSessions.

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

Constructors

PostIdentityVerificationSessionsResponseError String	Means either no matching case available or a parse error
PostIdentityVerificationSessionsResponse200 Identity'verificationSession	Successful response.
PostIdentityVerificationSessionsResponseDefault Error	Error response.

Instances

Instances details

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