verification

Summary

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.

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

Query parameters

group_by'status' | 'type' | 'provider'

bucket dimension

status'pending' | 'active' | 'verified' | 'failed' | 'expired' | 'revoked'

filter by session status

type'kyc' | 'kyb'

filter by verification type

providerstring

filter by provider

group_idstring uuid

only sessions of accounts that are members of this group; 404 group_not_found if the group is not visible to you

exclude_group_idstring uuid

drop sessions of members of this group; 404 group_not_found if not visible

sincestring

RFC3339 lower bound on created_at (inclusive)

untilstring

RFC3339 upper bound on created_at (exclusive)

intervalstring

hour | day | week | month — returns data.series

tzstring

IANA time zone for bucketing (default UTC)

tenant_idstring uuid

list this tenant instead of your own (default: the caller's own tenant, platform admins included). Another tenant requires the cross_tenant grant — 403 otherwise

all_tenantsboolean

list EVERY tenant (platform-wide admin view). Requires the cross_tenant grant — 403 otherwise. Mutually exclusive with tenant_id (400 conflicting_tenant_scope)

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.