Signed eventsRetry enabled

Event Types

Production-grade webhook documentation for signed event delivery, retries, failed deliveries, event logs, and compliance-safe integrations.

Searchable categorized events

Use event names to subscribe webhook endpoints and filter logs. Events are grouped by verification, compliance, billing, webhook, and system workflows.

Implemented events

verification_completed

Sent when a citizen verification succeeds.

Trigger: POST /api/v1/verify/citizen returns a verified result.

Action: Update applicant status and store the verification ID in your HR or onboarding system.

Payload example

application/json

{  "event": "verification_completed",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

verification_failed

Sent when a citizen verification fails or cannot be completed.

Trigger: Verification returns failed, not found, or provider error.

Action: Notify the reviewer and pause downstream onboarding until resolved.

Payload example

application/json

{  "event": "verification_failed",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

credits_low

Sent when your credit balance drops below the configured threshold.

Trigger: Credit balance crosses the low-credit threshold.

Action: Alert finance or ops to top up before verifications are blocked.

Payload example

application/json

{  "event": "credits_low",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

credits_exhausted

Sent when credits are fully depleted.

Trigger: A verification attempt is blocked due to zero credits.

Action: Pause automated verification flows and trigger a top-up workflow.

Payload example

application/json

{  "event": "credits_exhausted",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

business_approved

Sent when your business account is approved for enterprise API access.

Trigger: Admin approves the business registration.

Action: Enable production integrations and issue live API keys.

Payload example

application/json

{  "event": "business_approved",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

business_suspended

Sent when your business account is suspended.

Trigger: Admin suspends the business account.

Action: Disable automated verification flows and contact support.

Payload example

application/json

{  "event": "business_suspended",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

Example payload

webhook payload

{  "event": "verification_completed",  "businessId": "uuid",  "verificationId": "uuid",  "result": "verified",  "purpose": "pre_employment",  "channel": "api",  "timestamp": "2026-06-02T12:30:00.000Z"}

Webhooks Overview

Webhook Security

Edit this page

Was this page helpful?