Cancel a VerificationSession

Changed on

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

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/identity/verification_sessions/{session}/cancel
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

sessionstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

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

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.