Returns all event types that can be subscribed to. Includes session
events (e.g. session.approved, session.declined,
session.resubmission-required), identity events
(identity.created, identity.updated, identity.flagged,
identity.archived, identity.restored, identity.tag-added,
identity.tag-removed), and consortium events
(consortium.match_found, consortium.match_resolved).
The session.resubmission-required event fires when a session is
auto-rejected because the submitted ID photos were too blurry or
low-quality for OCR processing. The applicant must create a new
session with the same external_ref and resubmit clearer photos.
consortium.match_found payloadFires when the consortium executor finds a cross-org match for a session at workflow time. Both involved organizations receive the event. Payload fields:
similarity is a rounded float (face-embedding cosine similarity).ghost_student_tier is one of low, medium, high, critical.identity.flagged payloadFires when an identity is flagged for review. As of Wave 4 (audit H41)
the payload no longer includes flagged_by or flag_reason —
those fields contained reviewer email and free-text PII. Use
GET /identities/{identity_id} to fetch them if your subscriber has
the right scopes. The new has_reason boolean lets you tell whether
a reason was recorded without exposing its contents.
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.