Skip to content
APIs
/Verification API/Verification Sessions

Verification Sessions

Verify a credential definition, and poll and list verification sessions.

Operations

List verification sessions.

Request

Returns a paginated list of verification sessions for the calling service user's organization (X-Org-Id) and environment (X-Environment).

Security
BearerAuth
Query
limitinteger, (int64)

Maximum number of results to return (1-100, default 20).

offsetinteger, (int64)

Number of results to skip for pagination.

statusstring

Filter by session status: pending, success, failed, expired.

credential_definition_idstring

Filter by credential definition ID (UUID): sessions created from that definition.

case_idstring, (uuid)

Filter by verification case ID (UUID): sessions your organization launched from that case, your own or another organization's.

Headers
X-Org-Idstring, (uuid)required

Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.

X-Environmentstringrequired

Environment the call is scoped to. Resources are isolated per environment.

Enum:"beta""production"
curl -i -X GET \
  'https://docs.deepcredentials.swiss/_mock/docs/openapi/verification-v1/b2b/v1/verification-sessions?limit=0&offset=0&status=string&credential_definition_id=string&case_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Environment: beta' \
  -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Success response

Bodyapplication/json
countsobject(verification.SessionStatusCounts)required

SessionStatusCounts mirrors the filter tabs on the verification page — one tenant-wide count per status, plus a grand `All` total.

sessionsArray of objects(b2b.b2bSessionResponse)required

Page of sessions matching the list filters.

totalinteger, (int64)required

Total count matching filters (for pagination UI).

Response
{
  "sessions": [
    { … },
    { … },
    { … }
  ],
  "total": 3,
  "counts": {
    "all": 3,
    "success": 2,
    "pending": 1,
    "failed": 0,
    "expired": 0
  }
}