API Reference
Didit Console
Start typing to search…

Quick Start

This guide will take you from zero → first live verification in 3 simple steps.

🎥 Want to see it first?

Watch the full console + integration walkthrough here:

✅ Step 1 — Create Your Free Didit Account

  1. Go to business.didit.me
  2. Sign up with your business email and use the magic login link.
  3. Create your Organization workspace — where your team will manage workflows, API keys, and all verification activity.

✅ Step 2 — Build Your First Verification Workflow

  1. In the Console → Verifications → Workflows → Create New
  2. Choose a template:
    1. KYC – Standard onboarding
    2. Adaptive Age Verification – Fast selfie check w/ fallback to document
    3. Biometric Authentication – Password-less selfie login
    4. Address Verification
  3. Customize with blocks like Liveness Detection, Face Match, AML, NFC, fallback logic, etc.

✅ Step 3 — Configure Webhook & Copy API Key

  1. Go to Verifications → Settings → API & Webhooks
  2. Add your Webhook URL (Didit will post live status updates here)
  3. Copy your API Key (keep it secure – do not expose it in frontend code)

✅ Step 4 — Start a Verification Session

⚡ Option A — Verification Links (Fastest)

  • In Verifications, click the “+” button and select a workflow.
  • Generate a secure link or QR code.
  • Send URL via email/SMS — or embed it in your product.

Or programmatically: POST /v2/session/ { "workflow_id": "your-workflow-id" }

🔍

Tip: You can find your workflow_id inside the console under Verifications → Workflows, where all your workflows are listed — simply copy the ID of the one you want to use.

💻 Option B — Standalone APIs (Advanced)

Call specific endpoints directly from your backend:

  • /v2/id-verification/ – ID document check
  • /v2/face-match/ – selfie vs ID
  • /v2/aml/ – compliance lists
  • /v2/passive-liveness/ – deepfake detection
  • and more ...

Best for fully custom UI / backend-only flows.

✅ Step 5 — Receive Real-Time Results

Once a session starts, Didit will send webhook events to your endpoint allowing you to sync data without polling.

We send webhooks for the following event types:

  • status.updated: Triggered whenever the verification status changes (e.g., from Not Started to In Progress, or from In Review to Approved). This includes the initial webhook sent when a session starts.
  • data.updated: Triggered when KYC or POA data is manually updated by a reviewer via the API. This allows you to stay in sync with data corrections or manual reviews.

✅ Step 6 — Manage & Monitor in the Console

  • View session progress in real time
  • Download PDF / CSV reports for compliance
  • Blocklist suspicious IDs or faces
  • Manually delete or reject sessions

🤝 Need Help?