Payload Structure

Understand the structure and fields of webhook payloads.

Base Payload Structure

All webhook events follow the same base structure:

These fields are present in all verification-related events:

Field	Type	Description
`id`	string	Unique event identifier (use for deduplication)
`type`	string	Event type (e.g., "verification.completed")
`apiVersion`	string	API version used for this event
`createdAt`	string (ISO 8601)	When the event was created
`data.verificationId`	string \| null	Verification ID (null if not started)
`data.linkId`	string	Verification link ID
`data.referenceId`	string \| null	Your reference ID (if provided)
`data.status`	string	Current verification status
`data.flowType`	string	"standard" or "enhanced"

Present in completed verifications:

Contains extracted personal information:

PII Access

Some fields may be partially masked or omitted based on your account's PII access settings. Contact support to enable full PII access.

Results of individual verification checks:

Status	Description
`passed`	Check passed successfully
`failed`	Check failed
`skipped`	Check was not performed (not configured)
`inconclusive`	Could not determine result (requires review)

Additional context about the verification:

The score field indicates confidence level (0-100):

Use these TypeScript types for type-safe webhook handling: