---
title: "Summary"
method: GET
path: "/verification/summary"
tags: ["verification"]
---

# Summary

`GET /verification/summary`

## Request

- Base URL: `https://api.instruxi.dev/api/v1/enforcer`
- URL: `https://api.instruxi.dev/api/v1/enforcer/verification/summary`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `X-API-Key`

Counts of the verification sessions (KYC/KYB and whatever else is provider-configured) the caller may read — never more than their own account visibility already grants, so a plain user's summary covers only their own sessions, a tenant admin's their tenant's. group_by=status uses the full six-state lifecycle (pending, active, verified, failed, expired, revoked), not just verified/failed/pending. type and provider are open query filters, not closed enums — they pass through to whatever a tenant's connection is actually configured with. since/until bound the totals and any bucket dimension too, not just interval series, so a dashboard tile scoped to a window never reports a lifetime count.

## Query parameters

- `group_by` 'status' | 'type' | 'provider'
- `status` 'pending' | 'active' | 'verified' | 'failed' | 'expired' | 'revoked'
- `type` 'kyc' | 'kyb'
- `provider` string
- `group_id` string, uuid
- `exclude_group_id` string, uuid
- `since` string
- `until` string
- `interval` string
- `tz` string
- `tenant_id` string, uuid
- `all_tenants` boolean

## Response `200`

OK

- EnforcerV3InternalDomainSummaryResponse
  - `data` EnforcerV3InternalDomainSummaryData
    - `buckets` EnforcerV3InternalDomainSummaryBucket[]
      - `count` integer
      - `key` string
      - `label` string
      - `pct` number
    - `dimension` string
    - `multi_valued` boolean
    - `series` EnforcerV3InternalDomainSummaryPoint[]
      - `by` object
      - `count` integer
      - `ts` string
    - `total` integer
    - `truncated` boolean
  - `success` boolean
  - `window` EnforcerV3InternalDomainSummaryWindow
    - `interval` string
    - `since` string
    - `tz` string
    - `until` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: forbidden: tenant_id/all_tenants beyond your own tenant without the cross_tenant grant
- `404`: group_not_found

---

[API](https://skmtc.dev/instruxi/apis/enforcer-api.md) · [All operations](https://skmtc.dev/instruxi/apis/enforcer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/instruxi/apis/enforcer-api/revisions/fa82bc1becc0?raw)