Updates a VerificationSession object.
When the session status is requires_
, you can use this method to update the verification check and options.
Parameters
- metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - optionsobject
A set of options for the session’s verification checks.
- provided_
detailsobject Details provided about the user being verified. These details may be shown to the user.
- typeenum
The type of verification check to be performed.
Possible enum valuesdocument
id_
number
Returns
Returns the updated VerificationSession object
{ "id": "vs_1NuN9WLkdIwHu7ix597AR9uz", "object": "identity.verification_session", "client_secret": "...", "created": 1695680478, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": {}, "redaction": null, "status": "requires_input", "type": "id_number", "url": "..."}
Retrieves the details of a VerificationSession that was previously created.
When the session status is requires_
, you can use this method to retrieve a valid client_
or url
to allow re-submission.
Parameters
No parameters.
Returns
Returns a VerificationSession object
{ "id": "vs_1NuNAILkdIwHu7ixh7OtGMLw", "object": "identity.verification_session", "client_secret": "...", "created": 1695680526, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": { "document": { "require_matching_selfie": true } }, "redaction": null, "status": "requires_input", "type": "document", "url": "..."}
Returns a list of VerificationSessions
Parameters
- client_
reference_ idstring 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.
- createdobject
Only return VerificationSessions that were created during the given date interval.
- statusenum
Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.
Possible enum valuescanceled
The VerificationSession has been invalidated for future submission attempts.
processing
The session has been submitted and is being processed. Most verification checks are processed in less than 1 minute.
requires_
input Requires user input before processing can continue.
verified
Processing of all the verification checks are complete and successfully verified.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
List of VerificationSession objects that match the provided filter criteria.
{ "object": "list", "url": "/v1/identity/verification_sessions", "has_more": false, "data": [ { "id": "vs_1NuNAILkdIwHu7ixh7OtGMLw", "object": "identity.verification_session", "client_secret": "...", "created": 1695680526, "last_error": null, "last_verification_report": null, "livemode": false, "metadata": {}, "options": { "document": { "require_matching_selfie": true } }, "redaction": null, "status": "requires_input", "type": "document", "url": "..." } ]}
A VerificationSession object can be canceled when it is in requires_
status.
Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
Parameters
No parameters.
Returns
Returns the canceled VerificationSession object
{ "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}
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 requires_
or verified
status. Redacting a VerificationSession in requires_
state will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.
field will be set to processing
; when the process is finished, it will change to redacted
and an identity.
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 [redacted]
or a similar placeholder. The metadata
field will also be erased. Redacted objects cannot be updated or used for any purpose.
Parameters
No parameters.
Returns
Returns the redacted VerificationSession object
{ "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": { "status": "processing" }, "status": "canceled", "type": "document", "url": null}