List VerificationSessions

<p>Returns a list of VerificationSessions</p>

Create, retrieve, update, cancel, and redact Stripe Identity verification sessions, and retrieve verification reports. The collection covers all 8 Endpoints under the official Identity path boundary; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: getIdentityVerificationSessions
Server: https://api.stripe.com
Authentication: bearerAuth

Request parameters

`client_reference_id`

querystring

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`

querystring

Only return VerificationSessions that were created during the given date interval.

`ending_before`

querystring

A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

`expand`

queryarray

Specifies which fields in the response should be expanded.

`limit`

queryinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

`related_customer`

querystring

Customer ID

`related_customer_account`

querystring

The ID of the Account representing a customer.

`starting_after`

querystring

A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

`status`

querystring

Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).

Responses

`200`

objectapplication/json

Successful response.

Properties: datahas_moreobjecturl

`default`

stripe_errorapplication/json

Error response.

Properties: error

{
  "data": [
    {
      "created": 0,
      "livemode": false,
      "metadata": {}
    }
  ],
  "has_more": false,
  "object": "list"
}