stile
PlaygroundVerification sessions

List verification sessions

GET
/v1/verification_sessions

Authorization

BearerAuth
AuthorizationBearer <token>

Use a secret API key as the bearer token. Keys are prefixed with vk_test_ (test mode) or vk_live_ (live mode).

In: header

Query Parameters

limit?integer

Number of items to return per page.

Default10
Range1 <= value <= 100
starting_after?string

Cursor for forward pagination. Returns items created after this ID.

ending_before?string

Cursor for backward pagination. Returns items created before this ID.

status?string

Filter by session status.

Value in"created" | "pending" | "processing" | "requires_input" | "verified" | "failed" | "cancelled" | "expired"

Response Body

application/json

application/json

curl -X GET "http://localhost:3000/v1/verification_sessions"
{
  "object": "list",
  "url": "string",
  "has_more": true,
  "total_count": 0,
  "data": [
    {
      "id": "string",
      "object": "verification_session",
      "status": "string",
      "type": "string",
      "verification_path": "string",
      "livemode": true,
      "created": 0
    }
  ]
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "request_id": "string"
  }
}