API Reference
Didit Console
Start typing to search…

Quick Start

Welcome to Didit's Identity Verification solution! This guide will walk you through the process of setting up your account and integrating our powerful verification tools into your service or application.

📘

Before You Begin
Ensure you have a business email address. During setup, you'll be asked for basic information about your company to create your organization's account.

Part 1: Account Setup & Configuration

This section covers the initial setup within the Didit Business Console. In just a few steps, you'll have a live account, access to your API keys, and a configured workflow ready for integration.

1. Create Your Free Didit Account

Your free account is your gateway to the entire Didit V2 platform, including a full-featured sandbox environment.

  1. Go to the ->Didit Business Console.
  2. Sign Up: Use your business email and you will receive a login link to your email.
  3. Create Your Organization: Follow the prompts to set up your company's workspace. This is where your team will collaborate, manage verifications, and access settings.

2. Configure Your First Workflow

A Workflow is a sequence of verification steps you want your users to complete. You can design custom journeys for different needs.

  1. From your Console dashboard, navigate to the "Verifications" section and click the Workflows icon in the top right corner to access the workflow builder.
  2. Click "Create New Workflow" or use the existing ones.
  3. Select a template based on your primary use case:
    • KYC: The standard flow for onboarding new customers, starting with ID verification.
    • Adaptive Age Verification: A low-friction flow to estimate a user's age from a selfie, with an optional ID check as a fallback.
    • Biometric Authentication: A fast way to re-verify returning users with just a selfie.
    • Address Verification: A flow focused on verifying a user's residential address.
  4. Customize Your Workflow: Use the intuitive visual editor to add, remove, and configure verification checks. You can enable powerful features like Liveness Detection, Face Match, NFC Verification, AML Screening, and more, configuring each one to your exact risk and compliance requirements.

3. Set Up Your Webhooks & API Key

To receive real-time results and integrate programmatically, you need to configure your webhook endpoint and get your API key.

  1. In the Console settings, navigate to the "Verifications" section and click the Settings icon in the top right corner.
  2. Enter your Webhook URL. This is the endpoint on your server where Didit will send real-time updates for every verification status change.
  3. Locate and securely copy your API Key.
🚧

Important: Keep Your API Key Secure
Your API key grants access to your Didit account. Treat it like a password. Never share it publicly or expose it in any client-side code (e.g., in a mobile or web frontend).

Part 2: Integration - Choose Your Path

Didit V2 offers two flexible paths for initiating a verification session. Choose the one that best fits your technical needs and desired speed to market.

Option A: Verification Links (The No-Code & Low-Code Path)

This is the easiest and fastest way to verify users. You create a unique, secure link that directs a user to a verification flow hosted by Didit.

How it Works:

  1. Configure Your Flow in the Console: Use the workflow you created in Part 1.
  2. Generate the Link: You can do this in two ways:
    • No-Code (via Console): In the "Verifications" section, click the + icon, select your workflow, and instantly generate a shareable link and QR code. You can even send it directly to a user's email from our console.
    • Low-Code (via API): To start a verification, send a single POST request to our /v2/session/ endpoint using your API key. You only need to provide the workflow_id you want to use.
  3. Get the Response & Share: The API response will contain a unique url for that session.
  4. Share the Link Anywhere: Send this verification url to your user via any channel—email, SMS, or embed it as a link or iframe in your app or website for a seamless experience.
  5. Get Real-Time Updates: From the moment the verification is created to the final result, we'll send a webhook to your server for every status change, keeping your backend perfectly in sync without any polling.

Best For:

  • Teams who want to go live immediately with no frontend development.
  • Sending verification requests via email or SMS.
  • Simple, yet powerful, integrations where Didit handles the UI.

➡️ See the ->Create Session API Reference

Option B: Direct Standalone APIs (The Full Control Path)

This path is for developers who need granular control and want to integrate individual verification services directly into their custom applications and backend processes.

How it Works:

  1. Choose Your Service: Pick from our suite of powerful standalone services, like ID Verification, Face Match, or AML Screening.
  2. Make a Direct API Request: Send a direct API request to the specific service endpoint with the required data (e.g., an image of a document for verification, or a name for an AML check).
  3. Get an Instant, Synchronous Response: You'll receive an immediate JSON response with the complete results, ready to be consumed by your application's logic. No webhooks are required for this method.

Best For:

  • Building fully custom user experiences.
  • Augmenting an existing onboarding flow with a specific check.
  • Performing backend verifications where no user UI is needed.
  • Developers who require maximum control over every request and response.

Part 3: Management & Support

1. Monitor and Manage Verifications

Use the Didit Console as your central hub to stay on top of all verification processes.

  • Check Status: View the real-time status of ongoing verifications.
  • Review Results: Access detailed reports for all completed verifications.
  • Manage Data: Edit verification details or trigger data deletion as needed.

2. Get Support

We are here to help you succeed. If you need assistance with integration, encounter an issue, or have suggestions, please contact us.

Our team will direct your query to the appropriate specialists to ensure a swift resolution.

Next Steps

Congratulations! You've successfully set up Didit Identity Verification. Here are some resources to help you make the most of our platform:

Download user's verification reports

Learn how you can download PDFs reports about your user's verification sessions to stay compliant.

Blocklist faces and ID documents

Automatically decline verification sessions that match previously identified documents or faces that should be rejected.