Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postIdentityVerificationSessionsSessionRedact
Synopsis
- postIdentityVerificationSessionsSessionRedact :: forall m. MonadHTTP m => Text -> Maybe PostIdentityVerificationSessionsSessionRedactRequestBody -> StripeT m (Response PostIdentityVerificationSessionsSessionRedactResponse)
- data PostIdentityVerificationSessionsSessionRedactRequestBody = PostIdentityVerificationSessionsSessionRedactRequestBody {}
- mkPostIdentityVerificationSessionsSessionRedactRequestBody :: PostIdentityVerificationSessionsSessionRedactRequestBody
- data PostIdentityVerificationSessionsSessionRedactResponse
Documentation
postIdentityVerificationSessionsSessionRedact Source #
:: forall m. MonadHTTP m | |
=> Text | session | Constraints: Maximum length of 5000 |
-> Maybe PostIdentityVerificationSessionsSessionRedactRequestBody | The request body to send |
-> StripeT m (Response PostIdentityVerificationSessionsSessionRedactResponse) | Monadic computation which returns the result of the operation |
POST /v1/identity/verification_sessions/{session}/redact
<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.</p>
<p>A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code> <a href="/docs/identity/how-sessions-work">status</a>. Redacting a VerificationSession in <code>requires_action</code> state will automatically cancel it.</p>
<p>The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is finished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event will be emitted.</p>
<p>Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar placeholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or used for any purpose.</p>
<p><a href="/docs/identity/verification-sessions#redact">Learn more</a>.</p>
data PostIdentityVerificationSessionsSessionRedactRequestBody Source #
Defines the object schema located at paths./v1/identity/verification_sessions/{session}/redact.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostIdentityVerificationSessionsSessionRedactRequestBody | |
|
Instances
mkPostIdentityVerificationSessionsSessionRedactRequestBody :: PostIdentityVerificationSessionsSessionRedactRequestBody Source #
Create a new PostIdentityVerificationSessionsSessionRedactRequestBody
with all required fields.
data PostIdentityVerificationSessionsSessionRedactResponse Source #
Represents a response of the operation postIdentityVerificationSessionsSessionRedact
.
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), PostIdentityVerificationSessionsSessionRedactResponseError
is used.
PostIdentityVerificationSessionsSessionRedactResponseError String | Means either no matching case available or a parse error |
PostIdentityVerificationSessionsSessionRedactResponse200 Identity'verificationSession | Successful response. |
PostIdentityVerificationSessionsSessionRedactResponseDefault Error | Error response. |