Stripe/postIdentityVerificationSessionsSessionCancel

Preview only · details below

StripeStripe Identity verification API

POST/v1/identity/verification_sessions/{session}/cancel

Cancel a VerificationSession

A VerificationSession object can be canceled when it is in `requires_input` [status](https://docs.stripe.com/identity/how-sessions-work). Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/identity/verification-sessions#cancel).

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
postIdentityVerificationSessionsSessionCancel
Server
https://api.stripe.com
Authentication
bearerAuth

Request parameters

session

pathstringrequired

Request body

object

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

Properties: 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": {}
}