Cancel a VerificationSession 

Identity
Verification Session
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.

Parameters

No parameters.

Returns

Returns the canceled VerificationSession object

POST /v1/identity/verification_sessions/:id/cancel
curl -X POST https://api.stripe.com/v1/identity/verification_sessions/vs_1NuN3kLkdIwHu7ixk5OvTq3b/cancel \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "vs_1NuN3kLkdIwHu7ixk5OvTq3b",
"object": "identity.verification_session",
"client_secret": null,
"created": 1695680120,
"last_error": null,
"last_verification_report": null,
"livemode": false,
"metadata": {},
"options": {
"document": {
"require_matching_selfie": true
}
},
"redaction": null,
"status": "canceled",
"type": "document",
"url": null
}