DiditSDK for Web

A lightweight JavaScript/TypeScript SDK for embedding Didit identity verification in web applications.

Features

• 🎯 Simple API - Singleton pattern with easy-to-use methods
• 🔐 Flexible Integration - Use UniLink URL directly or create sessions via backend
• 📱 Responsive - Works on desktop and mobile browsers
• 🎨 Customizable - Configuration options for styling and behavior
• 📦 Multiple Formats - ESM, CommonJS, and UMD builds
• 🔷 TypeScript - Full type definitions included

Installation

NPM/Yarn

npm install @didit-protocol/sdk-web
# or
yarn add @didit-protocol/sdk-web

CDN (UMD)

<script src="https://unpkg.com/@didit-protocol/sdk-web/dist/didit-sdk.umd.min.js"></script>

Quick Start

ES Modules / TypeScript

import { DiditSdk } from '@didit-protocol/sdk-web';

// Set up completion callback
DiditSdk.shared.onComplete = (result) => {
  switch (result.type) {
    case 'completed':
      console.log('Verification completed!');
      console.log('Session ID:', result.session?.sessionId);
      console.log('Status:', result.session?.status);
      break;
    case 'cancelled':
      console.log('User cancelled verification');
      break;
    case 'failed':
      console.error('Verification failed:', result.error?.message);
      break;
  }
};

// Start verification with URL (from your backend or UniLink)
DiditSdk.shared.startVerification({
  url: 'https://verify.didit.me/session/session-token'
});

Script Tag (UMD)

<script src="https://unpkg.com/@didit-protocol/sdk-web/dist/didit-sdk.umd.min.js"></script>
<script>
  const { DiditSdk } = DiditSDK;

  DiditSdk.shared.onComplete = (result) => {
    if (result.type === 'completed') {
      alert('Verification completed: ' + result.session.status);
    }
  };

  function startVerification() {
    DiditSdk.shared.startVerification({
      // You can get this link by clicking on "copy link" in the workflows view
      url: 'https://verify.didit.me/u/WORKFLOW_ID_IN_BASE_64'
    });
  }
</script>

<button onclick="startVerification()">Verify Identity</button>

Integration Methods

There are two ways to integrate the SDK:

Method 1: UniLink URL (Simplest)

Use your workflow's UniLink URL directly from the Didit Console. No backend required.

DiditSdk.shared.startVerification({
  // You can get this link by clicking on "copy link" in the workflows view
  url: 'https://verify.didit.me/u/WORKFLOW_ID_IN_BASE_64'
});

Get your UniLink URL from the Didit Console → Your Workflow → Copy Link.

The session_id generated will be sent to you by an event. Check event reference here

Method 2: Backend Session (Recommended for production)

Your backend creates a session via the Didit API and returns the verification URL. This gives you more control over session creation, user tracking, and security. Read more about how the create session API works here: https://docs.didit.me/reference/create-session-verification-sessions

// Get the verification URL from your backend
const { url } = await yourBackend.createVerificationSession();

DiditSdk.shared.startVerification({
  url,
  configuration: {
    loggingEnabled: true
  }
});

Configuration

interface DiditSdkConfiguration {
  /**
   * Enable SDK logging for debugging
   * @default false
   */
  loggingEnabled?: boolean;

  /**
   * Custom container element to mount the modal
   * @default document.body
   */
  containerElement?: HTMLElement;

  /**
   * Z-index for the modal overlay
   * @default 9999
   */
  zIndex?: number;

  /**
   * Show close button on modal
   * @default true
   */
  showCloseButton?: boolean;

  /**
   * Show exit confirmation dialog when closing
   * @default true
   */
  showExitConfirmation?: boolean;  
  /**
   * Automatically close modal when verification completes
   * @default false
   */
  closeModalOnComplete?: boolean;

  /**
   * Render verification inline instead of modal overlay
   * @default false
   */
  embedded?: boolean;

  /**
   * Container element ID for embedded mode
   * Required when embedded is true
   */
  embeddedContainerId?: string;
}

Embedded Mode

Render verification inline instead of a modal overlay:

<div id="verification-container" style="width: 500px; height: 700px;"></div>

DiditSdk.shared.startVerification({
  url: 'https://verify.didit.me/u/...',
  configuration: {
    embedded: true,
    embeddedContainerId: 'verification-container'
  }
});

Verification Results

The SDK returns three types of results:

Completed

Verification flow finished (approved, pending, or declined).

{
  type: 'completed',
  session: {
    sessionId: 'session-uuid',
    status: 'Approved' | 'Pending' | 'Declined'
  }
}

Cancelled

User closed the verification modal.

{
  type: 'cancelled',
  session: {
    sessionId: 'session-uuid',
    status: 'Pending'
  }
}

Failed

An error occurred during verification.

{
  type: 'failed',
  error: {
    type: 'sessionExpired' | 'networkError' | 'cameraAccessDenied' | 'unknown',
    message: 'Your verification session has expired.'
  }
}

State Management

You can observe the SDK state for custom UI:

DiditSdk.shared.onStateChange = (state, error) => {
  switch (state) {
    case 'idle':
      // Ready to start
      break;
    case 'loading':
      // Loading verification iframe
      showLoadingSpinner();
      break;
    case 'ready':
      // Verification in progress
      hideLoadingSpinner();
      break;
    case 'error':
      // Error occurred
      showError(error);
      break;
  }
};

// Check current state
console.log(DiditSdk.shared.state);

// Check if verification is presented
console.log(DiditSdk.shared.isPresented);

API Reference

DiditSdk.shared

The singleton SDK instance.

Methods

| Method | Description | |--------|-------------| | startVerification(options) | Start the verification flow | | close() | Programmatically close the verification modal | | destroy() | Destroy the SDK instance and clean up |

Properties

| Property | Type | Description | |----------|------|-------------| | state | DiditSdkState | Current SDK state | | configuration | DiditSdkConfiguration | Current configuration | | isPresented | boolean | Whether verification modal is open | | errorMessage | string | Error message (when in error state) |

Callbacks

| Callback | Parameters | Description | |----------|------------|-------------| | onComplete | (result: VerificationResult) | Called when verification finishes | | onStateChange | (state: DiditSdkState, error?: string) | Called on state changes | | onEvent | (event: VerificationEvent) | Called on granular verification events |

Granular Events

Track verification progress with the onEvent callback:

DiditSdk.shared.onEvent = (event) => {
  console.log('Event:', event.type, event.data);
};

Event Reference

| Event | Description | Data Payload | |-------|-------------|--------------| | didit:ready | The page is ready and the sessionId is available | { sessionId } | | didit:started | User started verification | { sessionId? } | | didit:step_started | A verification step began | { step, sessionId? } | | didit:step_completed | A step finished successfully | { step, nextStep?, sessionId? } | | didit:step_changed | Current step changed | { step, previousStep?, sessionId? } | | didit:media_started | Camera/media capture started | { step, mediaType } | | didit:media_captured | Photo/video captured | { step, isAuto } | | didit:document_selected | User selected document type and country | { documentType, country } | | didit:verification_submitted | Data submitted for processing | { step, sessionId? } | | didit:code_sent | OTP code sent | { step, channel?, codeSize?, sessionId? } | | didit:code_verified | OTP code verified | { step, sessionId? } | | didit:status_updated | Session status changed | { status, previousStep?, sessionId? } | | didit:completed | Verification flow completed | { sessionId?, status?, country?, documentType? } | | didit:cancelled | User cancelled verification | { sessionId? } | | didit:error | An error occurred | { error, step?, sessionId? } | | didit:close_request | User requested to close modal | (no data) |

Step Values

The step field can be one of:

• document_selection - Document type selection
• document_front - Front side of document
• document_back - Back side of document
• face - Face/liveness verification
• email - Email verification
• phone - Phone verification
• poa - Proof of address
• questionnaire - Questionnaire step

Channel Values

The channel field in code_sent can be:

• email - Code sent via email
• sms - Code sent via SMS
• whatsapp - Code sent via WhatsApp

Code Size

The codeSize field in code_sent indicates the OTP code length (e.g., 4 or 6 digits).

Browser Support

• Chrome 70+
• Firefox 65+
• Safari 12+
• Edge 79+

License

Copyright © 2026 Didit. All rights reserved.