List VerificationSessions

GET / v1 / identity / verification_sessions

Returns a list of VerificationSessions

Parameters

• client _ reference _ id string 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.
• created object Only return VerificationSessions that were created during the given date interval.
• related _ customer string Customer ID
• related _ customer _ account string The ID of the Account representing a customer.
• status enum Only return VerificationSessions with this status. Learn more about the lifecycle of sessions. Possible enum values canceled 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 _ before string
• limit integer
• starting _ after string

Returns

List of VerificationSession objects that match the provided filter criteria.

Response

Cancel a VerificationSession

POST / v1 / identity / verification_sessions /:id / cancel

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

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}

Redact a VerificationSession

POST / v1 / identity / verification_sessions /:id / redact

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_input or verified status. Redacting a VerificationSession in requires_action 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.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted 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.

Learn more.

Parameters

No parameters.

Returns

Returns the redacted VerificationSession object

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": { "status": "processing" }, "status": "canceled", "type": "document", "url": null}