Redact a VerificationSession

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. A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code> <a href="https://docs.stripe.com/identity/how-sessions-work">status</a>. Redacting a VerificationSession in <code>requires_action</code> state will automatically cancel it. 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. 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. <a href="https://docs.stripe.com/identity/verification-sessions#redact">Learn more</a>.

Create, retrieve, update, cancel, and redact Stripe Identity verification sessions, and retrieve verification reports. The collection covers all 8 Endpoints under the official Identity path boundary; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: postIdentityVerificationSessionsSessionRedact
Server: https://api.stripe.com
Authentication: bearerAuth

Request parameters

`session`

pathstringrequired

Request body

object

Content-Type: application/x-www-form-urlencoded

Properties: expand

{
  "expand": [
    {}
  ]
}

Responses

`200`

stripe_identity_verification_sessionapplication/json

Successful response.

Properties: client_reference_idclient_secretcreatedidlast_errorlast_verification_reportlivemodemetadataobjectoptionsprovided_detailsredactionrelated_customerrelated_customer_accountrelated_personstatustypeurlverification_flowverified_outputs

`default`

stripe_errorapplication/json

Error response.

Properties: error

{
  "created": 0,
  "livemode": false,
  "metadata": {}
}