Sample - Stripe API
GET/v1/identity/verification_sessions

List verification sessions

Lists verification sessions created for identity checks. Filter by customer, creation time, or session status, and use cursor parameters with limit to paginate the results.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

9 parameters
client_reference_idstringoptional
Reference for the user or verification in your systems, such as a customer ID or session ID. Maximum 5000 characters.
createdobjectoptional
Filter sessions by creation time using a Unix timestamp or a range object with `gt`, `gte`, `lt`, or `lte`.
ending_beforestringoptional
Cursor that identifies the object before the page you want to retrieve. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in each response object. Each value must be no longer than 5000 characters.
limitintegeroptional
Maximum number of sessions to return. Must be between 1 and 100 and defaults to 10 when omitted.
related_customerstringoptional
Filter sessions by customer ID. Maximum 5000 characters.
related_customer_accountstringoptional
Filter sessions by the Account representing a customer. Maximum 5000 characters.
starting_afterstringoptional
Cursor that identifies the object after the page you want to retrieve. Maximum 5000 characters.
statusstringoptional
Filter sessions by status: `canceled`, `processing`, `requires_input`, or `verified`.
Allowed:canceledprocessingrequires_inputverified

2 status codes
200Returns a paginated list object containing verification sessions, the list URL, the `has_more` indicator, and the session data.
dataarray<VerificationSession>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

client_reference_id, ending_before, related_customer, related_customer_account, and starting_after must be no longer than 5000 characters. limit accepts between 1 and 100 sessions and defaults to 10, while status must be canceled, processing, requires_input, or verified.