Cancel a VerificationSession

A VerificationSession object can be canceled when it is in requires_input status.

Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

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

Path parameters

sessionstring required

Response

Successful response.

client_reference_idstring nullable

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

client_secretstring nullable

The short-lived client secret used by Stripe.js to show a verification modal inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on passing the client secret to the frontend to learn more.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'identity.verification_session' required

String representing the object's type. Objects of the same type share the same value.

related_customerstring nullable

Customer ID

related_customer_accountstring nullable

The ID of the Account representing a customer.

status'canceled' | 'processing' | 'requires_input' | 'verified' required

Status of this VerificationSession. Learn more about the lifecycle of sessions.

type'document' | 'id_number' | 'verification_flow' required

The type of verification check to be performed.

urlstring nullable

The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on verifying identity documents to learn how to redirect users to Stripe.

verification_flowstring

The configuration token of a verification flow from the dashboard.

Changes

Changed in 12 of the 51 revisions of this API.194926

Jul 1, 2026e24a26de41883See the full diff
- ▲
  removed the required property //////////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////////// from the response with the status
  response-required-property-removed
- ▲
  removed the required property ////////// from the response with the status
  response-required-property-removed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Sep 25, 2025eb1ac21ec19c5See the full diff
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ●
  added the new prevented enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new prevented enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new prevented enum value to the //////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e3See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  the response property / became required for the status
  response-property-became-required
- ○
  the response property / became required for the status
  response-property-became-required
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 13, 2024e970df54dcb928See the full diff
- ●
  removed the optional property ////////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ///////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property ////////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history (12 revisions)