Skip to main content

How It Works

API Reference​

Authorization (OAuth 2.0)​

  • Client Credentials flow
  • POST to token endpoint with client_id + client_secret
  • Receive access_token (Bearer) + refresh_token
  • Use Bearer token in all API requests

Create Client​

  • Done via dashboard (API Keys section)
  • Returns client_id
  • Generate secret once (shown only once)

Notification Management​

Webhooks​

Two types:

  1. Event Notifications — real-time alerts (verification.completed, failed, etc.)
  2. Verification Check — custom mid-flow calls (your logic decides pass/fail/review)

See detailed guides:

Events​

Common ones:

  • verification.completed
  • verification.failed
  • verification.started
  • verification.manual_review
  • fraud.detected
  • workflow.created

Full catalog available in dashboard.

Alerts (SMS/Email)​

Alternative delivery channels for selected events (configured per webhook)

Workflow Management​

SDK Management​

Available SDKs (v1.0.0):

  • Web SDK — Quick link / embed script (headless, inherit, standalone modes)
  • Android SDK — Gradle / Maven
  • iOS SDK — Swift Package Manager / CocoaPods
  • React Native SDK — npm package + JWT auth

All SDKs use refresh_token (never expose client_secret).

Detailed integration code appears in Test tab of each workflow.