cURL

curl -X POST 'https://verification.didit.me/v3/session/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "workflow_id": "11111111-2222-3333-4444-555555555555",
    "vendor_data": "user-123",
    "callback": "https://example.com/verification/callback",
    "callback_method": "both",
    "metadata": {"user_type": "premium", "account_id": "ABC123"},
    "language": "en",
    "contact_details": {
      "email": "john.doe@example.com",
      "send_notification_emails": true,
      "email_lang": "en",
      "phone": "+14155552671"
    },
    "expected_details": {
      "first_name": "John",
      "last_name": "Doe",
      "date_of_birth": "1990-05-15",
      "id_country": "USA",
      "expected_document_types": ["P", "ID"]
    }
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.create(
    workflow_id="11111111-2222-3333-4444-555555555555",
    vendor_data="user-123",
    callback="https://example.com/verification/callback",
    callback_method="both",
    metadata={"user_type": "premium", "account_id": "ABC123"},
    language="en",
    contact_details={
        "email": "john.doe@example.com",
        "send_notification_emails": True,
        "email_lang": "en",
        "phone": "+14155552671",
    },
    expected_details={
        "first_name": "John",
        "last_name": "Doe",
        "date_of_birth": "1990-05-15",
        "nationality": "USA",
        "id_country": "USA",
        "expected_document_types": ["P", "ID"],
    },
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.create({
  workflow_id: "11111111-2222-3333-4444-555555555555",
  vendor_data: "user-123",
  callback: "https://example.com/verification/callback",
  callback_method: "both",
  metadata: { user_type: "premium", account_id: "ABC123" },
  language: "en",
  contact_details: {
    email: "john.doe@example.com",
    send_notification_emails: true,
    email_lang: "en",
    phone: "+14155552671",
  },
  expected_details: {
    first_name: "John",
    last_name: "Doe",
    date_of_birth: "1990-05-15",
    nationality: "USA",
    id_country: "USA",
    expected_document_types: ["P", "ID"],
  },
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.Create(ctx, didit.SessionsCreateParams{
	WorkflowID:     "11111111-2222-3333-4444-555555555555",
	VendorData:     didit.String("user-123"),
	Callback:       didit.String("https://example.com/verification/callback"),
	CallbackMethod: didit.Some(didit.SessionsCreateParamsCallbackMethod("both")),
	Metadata:       didit.Some[any](map[string]any{"user_type": "premium", "account_id": "ABC123"}),
	Language:       didit.Some(didit.SessionsCreateParamsLanguage("en")),
	ContactDetails: didit.Some(didit.SessionsCreateParamsContactDetails{
		Email:                  didit.String("john.doe@example.com"),
		SendNotificationEmails: didit.Bool(true),
		EmailLang:              didit.Some(didit.SessionsCreateParamsContactDetailsEmailLang("en")),
		Phone:                  didit.String("+14155552671"),
	}),
	ExpectedDetails: didit.Some(didit.SessionsCreateParamsExpectedDetails{
		FirstName:             didit.String("John"),
		LastName:              didit.String("Doe"),
		DateOfBirth:           didit.String("1990-05-15"),
		Nationality:           didit.String("USA"),
		IDCountry:             didit.String("USA"),
		ExpectedDocumentTypes: didit.Some([]didit.SessionsCreateParamsExpectedDetailsExpectedDocumentTypes{"P", "ID"}),
	}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.time.LocalDate;
import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.SessionsCreateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().create(SessionsCreateParams.builder()
        .workflowId("11111111-2222-3333-4444-555555555555")
        .vendorData("user-123")
        .callback("https://example.com/verification/callback")
        .callbackMethod(SessionsCreateParams.CallbackMethod.of("both"))
        .metadata(Map.of("user_type", "premium", "account_id", "ABC123"))
        .language(SessionsCreateParams.Language.of("en"))
        .contactDetails(SessionsCreateParams.ContactDetails.builder()
                .email("john.doe@example.com")
                .sendNotificationEmails(true)
                .emailLang(SessionsCreateParams.ContactDetails.EmailLang.of("en"))
                .phone("+14155552671")
                .build())
        .expectedDetails(SessionsCreateParams.ExpectedDetails.builder()
                .firstName("John")
                .lastName("Doe")
                .dateOfBirth(LocalDate.parse("1990-05-15"))
                .nationality("USA")
                .idCountry("USA")
                .expectedDocumentTypes(List.of(SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of("P"), SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of("ID")))
                .build())
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->create([
    'workflow_id' => '11111111-2222-3333-4444-555555555555',
    'vendor_data' => 'user-123',
    'callback' => 'https://example.com/verification/callback',
    'callback_method' => 'both',
    'metadata' => ['user_type' => 'premium', 'account_id' => 'ABC123'],
    'language' => 'en',
    'contact_details' => [
        'email' => 'john.doe@example.com',
        'send_notification_emails' => true,
        'email_lang' => 'en',
        'phone' => '+14155552671',
    ],
    'expected_details' => [
        'first_name' => 'John',
        'last_name' => 'Doe',
        'date_of_birth' => '1990-05-15',
        'nationality' => 'USA',
        'id_country' => 'USA',
        'expected_document_types' => ['P', 'ID'],
    ],
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.sessions.create(
  workflow_id: "11111111-2222-3333-4444-555555555555",
  vendor_data: "user-123",
  callback: "https://example.com/verification/callback",
  callback_method: "both",
  metadata: { user_type: "premium", account_id: "ABC123" },
  language: "en",
  contact_details: {
    email: "john.doe@example.com",
    send_notification_emails: true,
    email_lang: "en",
    phone: "+14155552671",
  },
  expected_details: {
    first_name: "John",
    last_name: "Doe",
    date_of_birth: "1990-05-15",
    nationality: "USA",
    id_country: "USA",
    expected_document_types: ["P", "ID"],
  }
)
puts result.to_h

using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.CreateAsync(new SessionsCreateParams
{
    WorkflowId = "11111111-2222-3333-4444-555555555555",
    VendorData = "user-123",
    Callback = "https://example.com/verification/callback",
    CallbackMethod = new SessionsCreateParamsCallbackMethod("both"),
    Metadata = new Dictionary<string, object> { ["user_type"] = "premium", ["account_id"] = "ABC123" },
    Language = new SessionsCreateParamsLanguage("en"),
    ContactDetails = new SessionsCreateParamsContactDetails
    {
        Email = "john.doe@example.com",
        SendNotificationEmails = true,
        EmailLang = new SessionsCreateParamsContactDetailsEmailLang("en"),
        Phone = "+14155552671",
    },
    ExpectedDetails = new SessionsCreateParamsExpectedDetails
    {
        FirstName = "John",
        LastName = "Doe",
        DateOfBirth = "1990-05-15",
        Nationality = "USA",
        IdCountry = "USA",
        ExpectedDocumentTypes = new SessionsCreateParamsExpectedDetailsExpectedDocumentTypes[] { "P", "ID" },
    },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "session_id": "11111111-2222-3333-4444-555555555555",
  "session_number": 43762,
  "session_token": "3FaJ9wLqX2Mz",
  "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz",
  "vendor_data": "user-123",
  "metadata": {
    "user_type": "premium",
    "account_id": "ABC123"
  },
  "status": "Not Started",
  "workflow_id": "11111111-2222-3333-4444-555555555555",
  "workflow_version": 3,
  "callback": "https://example.com/verification/callback"
}

उपयोगकर्ता और व्यवसाय सत्यापन

सत्र बनाएं API: KYC या KYB सत्यापन शुरू करें

Didit का POST /v3/session/ सत्यापन सत्र शुरू करता है। एकीकृत KYC + KYB, प्रति उपयोग मूल्य निर्धारण, 2s से कम अनुमान, $10 मासिक निःशुल्क क्रेडिट।

POST

session

cURL

curl -X POST 'https://verification.didit.me/v3/session/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "workflow_id": "11111111-2222-3333-4444-555555555555",
    "vendor_data": "user-123",
    "callback": "https://example.com/verification/callback",
    "callback_method": "both",
    "metadata": {"user_type": "premium", "account_id": "ABC123"},
    "language": "en",
    "contact_details": {
      "email": "john.doe@example.com",
      "send_notification_emails": true,
      "email_lang": "en",
      "phone": "+14155552671"
    },
    "expected_details": {
      "first_name": "John",
      "last_name": "Doe",
      "date_of_birth": "1990-05-15",
      "id_country": "USA",
      "expected_document_types": ["P", "ID"]
    }
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.create(
    workflow_id="11111111-2222-3333-4444-555555555555",
    vendor_data="user-123",
    callback="https://example.com/verification/callback",
    callback_method="both",
    metadata={"user_type": "premium", "account_id": "ABC123"},
    language="en",
    contact_details={
        "email": "john.doe@example.com",
        "send_notification_emails": True,
        "email_lang": "en",
        "phone": "+14155552671",
    },
    expected_details={
        "first_name": "John",
        "last_name": "Doe",
        "date_of_birth": "1990-05-15",
        "nationality": "USA",
        "id_country": "USA",
        "expected_document_types": ["P", "ID"],
    },
)
print(result)

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.create({
  workflow_id: "11111111-2222-3333-4444-555555555555",
  vendor_data: "user-123",
  callback: "https://example.com/verification/callback",
  callback_method: "both",
  metadata: { user_type: "premium", account_id: "ABC123" },
  language: "en",
  contact_details: {
    email: "john.doe@example.com",
    send_notification_emails: true,
    email_lang: "en",
    phone: "+14155552671",
  },
  expected_details: {
    first_name: "John",
    last_name: "Doe",
    date_of_birth: "1990-05-15",
    nationality: "USA",
    id_country: "USA",
    expected_document_types: ["P", "ID"],
  },
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.Create(ctx, didit.SessionsCreateParams{
	WorkflowID:     "11111111-2222-3333-4444-555555555555",
	VendorData:     didit.String("user-123"),
	Callback:       didit.String("https://example.com/verification/callback"),
	CallbackMethod: didit.Some(didit.SessionsCreateParamsCallbackMethod("both")),
	Metadata:       didit.Some[any](map[string]any{"user_type": "premium", "account_id": "ABC123"}),
	Language:       didit.Some(didit.SessionsCreateParamsLanguage("en")),
	ContactDetails: didit.Some(didit.SessionsCreateParamsContactDetails{
		Email:                  didit.String("john.doe@example.com"),
		SendNotificationEmails: didit.Bool(true),
		EmailLang:              didit.Some(didit.SessionsCreateParamsContactDetailsEmailLang("en")),
		Phone:                  didit.String("+14155552671"),
	}),
	ExpectedDetails: didit.Some(didit.SessionsCreateParamsExpectedDetails{
		FirstName:             didit.String("John"),
		LastName:              didit.String("Doe"),
		DateOfBirth:           didit.String("1990-05-15"),
		Nationality:           didit.String("USA"),
		IDCountry:             didit.String("USA"),
		ExpectedDocumentTypes: didit.Some([]didit.SessionsCreateParamsExpectedDetailsExpectedDocumentTypes{"P", "ID"}),
	}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.time.LocalDate;
import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.SessionsCreateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().create(SessionsCreateParams.builder()
        .workflowId("11111111-2222-3333-4444-555555555555")
        .vendorData("user-123")
        .callback("https://example.com/verification/callback")
        .callbackMethod(SessionsCreateParams.CallbackMethod.of("both"))
        .metadata(Map.of("user_type", "premium", "account_id", "ABC123"))
        .language(SessionsCreateParams.Language.of("en"))
        .contactDetails(SessionsCreateParams.ContactDetails.builder()
                .email("john.doe@example.com")
                .sendNotificationEmails(true)
                .emailLang(SessionsCreateParams.ContactDetails.EmailLang.of("en"))
                .phone("+14155552671")
                .build())
        .expectedDetails(SessionsCreateParams.ExpectedDetails.builder()
                .firstName("John")
                .lastName("Doe")
                .dateOfBirth(LocalDate.parse("1990-05-15"))
                .nationality("USA")
                .idCountry("USA")
                .expectedDocumentTypes(List.of(SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of("P"), SessionsCreateParams.ExpectedDetails.ExpectedDocumentTypes.of("ID")))
                .build())
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->create([
    'workflow_id' => '11111111-2222-3333-4444-555555555555',
    'vendor_data' => 'user-123',
    'callback' => 'https://example.com/verification/callback',
    'callback_method' => 'both',
    'metadata' => ['user_type' => 'premium', 'account_id' => 'ABC123'],
    'language' => 'en',
    'contact_details' => [
        'email' => 'john.doe@example.com',
        'send_notification_emails' => true,
        'email_lang' => 'en',
        'phone' => '+14155552671',
    ],
    'expected_details' => [
        'first_name' => 'John',
        'last_name' => 'Doe',
        'date_of_birth' => '1990-05-15',
        'nationality' => 'USA',
        'id_country' => 'USA',
        'expected_document_types' => ['P', 'ID'],
    ],
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.sessions.create(
  workflow_id: "11111111-2222-3333-4444-555555555555",
  vendor_data: "user-123",
  callback: "https://example.com/verification/callback",
  callback_method: "both",
  metadata: { user_type: "premium", account_id: "ABC123" },
  language: "en",
  contact_details: {
    email: "john.doe@example.com",
    send_notification_emails: true,
    email_lang: "en",
    phone: "+14155552671",
  },
  expected_details: {
    first_name: "John",
    last_name: "Doe",
    date_of_birth: "1990-05-15",
    nationality: "USA",
    id_country: "USA",
    expected_document_types: ["P", "ID"],
  }
)
puts result.to_h

using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.CreateAsync(new SessionsCreateParams
{
    WorkflowId = "11111111-2222-3333-4444-555555555555",
    VendorData = "user-123",
    Callback = "https://example.com/verification/callback",
    CallbackMethod = new SessionsCreateParamsCallbackMethod("both"),
    Metadata = new Dictionary<string, object> { ["user_type"] = "premium", ["account_id"] = "ABC123" },
    Language = new SessionsCreateParamsLanguage("en"),
    ContactDetails = new SessionsCreateParamsContactDetails
    {
        Email = "john.doe@example.com",
        SendNotificationEmails = true,
        EmailLang = new SessionsCreateParamsContactDetailsEmailLang("en"),
        Phone = "+14155552671",
    },
    ExpectedDetails = new SessionsCreateParamsExpectedDetails
    {
        FirstName = "John",
        LastName = "Doe",
        DateOfBirth = "1990-05-15",
        Nationality = "USA",
        IdCountry = "USA",
        ExpectedDocumentTypes = new SessionsCreateParamsExpectedDetailsExpectedDocumentTypes[] { "P", "ID" },
    },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "session_id": "11111111-2222-3333-4444-555555555555",
  "session_number": 43762,
  "session_token": "3FaJ9wLqX2Mz",
  "url": "https://verify.didit.me/en/session/3FaJ9wLqX2Mz",
  "vendor_data": "user-123",
  "metadata": {
    "user_type": "premium",
    "account_id": "ABC123"
  },
  "status": "Not Started",
  "workflow_id": "11111111-2222-3333-4444-555555555555",
  "workflow_version": 3,
  "callback": "https://example.com/verification/callback"
}

KYC और KYB सहायता

एक ही एंडपॉइंट से उपयोगकर्ता सत्यापन और व्यवसाय सत्यापन, दोनों प्रकार के सत्र बनते हैं। वर्कफ़्लो का प्रकार तय करता है कि कौन-सा सत्र बनेगा:

KYC वर्कफ़्लो का workflow_id पास करें → उपयोगकर्ता सत्यापन (KYC) सत्र बनता है। रिस्पॉन्स में session_kind: "user" आता है।
KYB वर्कफ़्लो का workflow_id पास करें → व्यवसाय सत्यापन (KYB) सत्र बनता है। रिस्पॉन्स में session_kind: "business" आता है।

कंसोल में Workflows → Create workflow पर जाकर वर्कफ़्लो कॉन्फ़िगर करें। वर्कफ़्लो बनाते समय वह या तो KYC होता है या KYB; बाद में आप उसका प्रकार नहीं बदल सकते।

उदाहरण

उपयोगकर्ता सत्यापन (KYC)
व्यवसाय सत्यापन (KYB)

curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "YOUR_KYC_WORKFLOW_ID",
    "vendor_data": "user-42",
    "callback": "https://yourapp.com/callback"
  }'

रिस्पॉन्स (201 Created):

{
  "session_id": "4c5c7f3a-1f82-4f3b-8d8e-1a8d2d2f9b7a",
  "session_kind": "user",
  "session_number": 1024,
  "session_token": "...",
  "url": "https://verify.didit.me/session/...",
  "status": "Not Started",
  "workflow_id": "YOUR_KYC_WORKFLOW_ID",
  "vendor_data": "user-42"
}

curl -X POST https://verification.didit.me/v3/session/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_id": "YOUR_KYB_WORKFLOW_ID",
    "vendor_data": "biz-acme-001",
    "callback": "https://yourapp.com/callback"
  }'

रिस्पॉन्स (201 Created):

{
  "session_id": "bs-01HJX1...",
  "session_kind": "business",
  "session_number": 89,
  "session_token": "...",
  "url": "https://verify.didit.me/session/...",
  "status": "Not Started",
  "workflow_id": "YOUR_KYB_WORKFLOW_ID",
  "vendor_data": "biz-acme-001"
}

ई-हस्ताक्षर दस्तावेज़

जब वर्कफ़्लो में कोई ई-हस्ताक्षर चरण हो जो सत्र से दस्तावेज़ लेता है (signature_documents_source को session या both पर सेट किया गया हो), तो उन्हें sign.documents में भेजें। हर दस्तावेज़ base64 में एन्कोड की गई फ़ाइल होता है, इसलिए Didit को कभी किसी URL से फ़ाइल लाने की ज़रूरत नहीं पड़ती।

{
  "workflow_id": "YOUR_WORKFLOW_ID",
  "vendor_data": "user-42",
  "sign": {
    "documents": [
      {
        "title": "Loan agreement",
        "file_name": "loan-agreement.pdf",
        "content_base64": "JVBERi0xLjcKJc...",
        "fields": [
          { "key": "borrower_signature", "type": "signature", "label": "Borrower signature", "page": 3, "x": 0.1, "y": 0.78, "width": 0.32, "height": 0.06 },
          { "key": "date_signed", "type": "date_signed", "label": "Date", "page": 3, "x": 0.6, "y": 0.8, "width": 0.2, "height": 0.03, "date_format": "DD/MM/YYYY" },
          { "key": "loan_amount", "type": "data", "label": "Loan amount", "page": 1, "x": 0.34, "y": 0.31, "width": 0.3, "height": 0.03, "prefill": "api.loan_amount" },
          { "key": "initials", "type": "initials", "anchor": { "text": "[[initials]]", "occurrence": "all", "offset_x": 0, "offset_y": -0.005, "width": 0.12, "height": 0.04 } }
        ]
      }
    ],
    "field_values": { "loan_amount": "12,000 EUR" }
  }
}

फ़ील्ड	नियम
`title`	साइनर को दिखाया जाता है। 1 से 255 अक्षर। डिफ़ॉल्ट रूप से `file_name` लिया जाता है।
`file_name`	अनिवार्य। `.pdf` या `.docx` पर समाप्त होना चाहिए। 1 से 255 अक्षर।
`content_base64`	अनिवार्य। PDF में अधिकतम 20 MB और 100 पेज हो सकते हैं, बिना पासवर्ड, स्क्रिप्ट या संलग्न फ़ाइलों के। Word फ़ाइल अधिकतम 20 MB की हो सकती है और अनुरोध के दौरान PDF में बदली जाती है, जिसमें अधिकतम 25 सेकंड लगते हैं; उसके बाद PDF पर भी वही सीमाएँ लागू होती हैं। हर सत्र में अधिकतम 5 Word फ़ाइलें।
`fields`	वैकल्पिक। दस्तावेज़ पर रखे जाने वाले अधिकतम 200 फ़ील्ड, `id` के बिना फ़ील्ड के प्रारूप में। हर फ़ील्ड को `key` और `type` चाहिए, और या तो एक स्थिति (`page`, `x`, `y`, `width` और `height`) या एक `anchor`। `role` डिफ़ॉल्ट रूप से चरण के साइनर का होता है, और `required` व `label` प्रकार से डिफ़ॉल्ट होते हैं। Didit `position` को फ़ील्ड की जगह से सेट करता है। पेज और स्थितियाँ PDF के संदर्भ में होती हैं, या Word फ़ाइल के मामले में बदली गई PDF के संदर्भ में।

fields के बिना, साइनर दस्तावेज़ पढ़कर उससे सहमति देता है।

एंकर टेक्स्ट से फ़ील्ड लगाएँ

स्थिति देने के बजाय, फ़ील्ड में anchor दिया जा सकता है: दस्तावेज़ में मौजूद एक टेक्स्ट जो बताता है कि फ़ील्ड कहाँ जाएगा। एंकर उन दस्तावेज़ों के लिए ठीक हैं जिन्हें हर सत्र के लिए बनाया जाता है, जैसे Word टेम्पलेट से। वर्कफ़्लो दस्तावेज़ों के लिए फ़ील्ड कंसोल में लगाएँ।

`anchor` प्रॉपर्टी	नियम
`text`	1 से 64 अक्षर, जिन्हें दस्तावेज़ के टेक्स्ट में खोजा जाता है। Word फ़ाइल के लिए, बदली गई PDF में।
`occurrence`	`first` (डिफ़ॉल्ट) पहले मिलान पर एक फ़ील्ड लगाता है। `all` हर मिलान पर एक फ़ील्ड लगाता है, और पहले के बाद वाली keys को `_2`, `_3` आदि मिलते हैं।
`offset_x`, `offset_y`	पेज के अंश। फ़ील्ड का ऊपर-बायाँ कोना, एंकर टेक्स्ट के ऊपर-बाएँ कोने में इन ऑफ़सेट को जोड़कर बनता है।
`width`, `height`	फ़ील्ड का आकार, पेज के अंश के रूप में।

जब टेक्स्ट दस्तावेज़ में नहीं मिलता, तो कॉल 400 के साथ field_anchor_not_found और फ़ील्ड की key लौटाती है। Didit PDF से एंकर टेक्स्ट नहीं हटाता, इसलिए उसे पेज के बैकग्राउंड जैसे रंग में लिखें।

फ़ील्ड मान

sign.field_values हर उस फ़ील्ड का मान सेट करता है जिसका prefill api.<key> है, चाहे वह वर्कफ़्लो दस्तावेज़ पर हो या सत्र दस्तावेज़ पर। यह एक ऑब्जेक्ट है, जिसकी keys ये <key> नाम होते हैं। text और data फ़ील्ड के लिए मान 1 से 500 अक्षरों की स्ट्रिंग होते हैं, और checkbox के लिए बूलियन।

{
  "workflow_id": "YOUR_WORKFLOW_ID",
  "vendor_data": "user-42",
  "sign": {
    "field_values": { "credit_limit": "3,000 EUR", "monthly_fee": "4.90 EUR" }
  }
}

त्रुटि (`400`)	कब
`field_value_unknown`	ऐसी key जिसका कोई फ़ील्ड उपयोग नहीं करता।
`field_value_missing`	एक अनिवार्य फ़ील्ड जिसके `api.<key>` का कोई मान नहीं है।
`field_value_invalid`	ऐसा मान जो अपने फ़ील्ड के वैलिडेशन में असफल होता है।

त्रुटियाँ और दोहराई गई कॉल

एक सत्र में कुल मिलाकर अधिकतम 20 दस्तावेज़ और 50 MB हो सकते हैं। कॉल sign त्रुटि के साथ 400 लौटाती है जब:

वर्कफ़्लो में कोई ई-हस्ताक्षर चरण नहीं है।
आपने sign.documents भेजा, जबकि चरण केवल वर्कफ़्लो दस्तावेज़ लेता है।
चरण केवल सत्र दस्तावेज़ लेता है और आपने कोई नहीं भेजा, या उसमें वर्कफ़्लो दस्तावेज़ नहीं हैं और आपने कोई नहीं भेजा।
कोई दस्तावेज़ बहुत बड़ा है, वैध base64 नहीं है, या समर्थित फ़ाइल नहीं है।
कोई Word फ़ाइल signature_document_not_supported के साथ अस्वीकार हो जाती है, या बदली नहीं जा सकती और signature_document_conversion_failed लौटाती है, हर एक के साथ वह reason जो समर्थित फ़ाइलें में दिया गया है।
कोई फ़ील्ड अमान्य है, उसका एंकर नहीं मिलता (field_anchor_not_found), या कोई फ़ील्ड मान अस्वीकार होता है।

उसी workflow_id और vendor_data के साथ सत्र बनाने के लिए फिर से कॉल करने पर लंबित सत्र लौटता है। यदि वह कॉल sign भेजती है, तो उसके दस्तावेज़, फ़ील्ड और फ़ील्ड मान पहली कॉल जैसे ही होने चाहिए (वही क्रम, शीर्षक, फ़ाइल नाम, सामग्री, फ़ील्ड और मान)। किसी भी अंतर पर {"sign": "signature_document_changed"} के साथ 400 लौटता है: या तो अलग vendor_data उपयोग करें, या लंबित सत्र पूरा होने तक प्रतीक्षा करें।

सैंडबॉक्स परिदृश्यों से परीक्षण

सैंडबॉक्स मोड वाले एप्लिकेशन पर, sandbox_scenario पास करें ताकि असली प्रदाताओं या आपके बैलेंस को छुए बिना एक निश्चित परिणाम (स्वीकृति, कोई विशिष्ट अस्वीकृति, या समीक्षाधीन परिदृश्य) पहले से लोड हो जाए:

{
  "workflow_id": "YOUR_SANDBOX_WORKFLOW_ID",
  "sandbox_scenario": "decline_document_expired"
}

लाइव एप्लिकेशन पर sandbox_scenario को 400 के साथ अस्वीकार किया जाता है। यदि सत्र बनाते समय आपको परिणाम पता नहीं है, तो उसे बाद में POST /v3/session/{session_id}/sandbox/arm/ से सेट (या दोबारा सेट) करें, बशर्ते सत्र अभी भी Not Started हो: होस्टेड फ़्लो का प्री-फ़्लो परिदृश्य चुनने वाला टूल भी इसी एंडपॉइंट का उपयोग करता है। पूरी परिदृश्य सूची, मैजिक-वैल्यू रजिस्ट्री और आर्म करने वाला endpoint का रिक्वेस्ट/रिस्पॉन्स ढाँचा जानने के लिए सैंडबॉक्स और परीक्षण डेटा देखें।

`vendor_data` सत्र को एक इकाई से जोड़ता है

KYC वर्कफ़्लो के लिए: यह एक उपयोगकर्ता इकाई से जुड़ता है। यदि उपयोगकर्ता मौजूद नहीं है, तो वह अपने-आप बन जाता है।
KYB वर्कफ़्लो के लिए: यह एक व्यवसाय इकाई से जुड़ता है। नई होने पर अपने-आप बन जाती है।

अधिक जानने के लिए vendor_data लिंकिंग देखें।

इलिनॉय, टेक्सास और कोलोराडो में बायोमेट्रिक सहमति

होस्टेड फ़्लो और नेटिव SDK 4.10.0 या उसके बाद के संस्करण में, एप्लिकेशन के सहमति मोड और व्यक्ति के स्थान के आधार पर, पहली बार चेहरा कैप्चर करने से पहले एक स्पष्ट बायोमेट्रिक सहमति चरण दिखाया जा सकता है। इस निर्णय में दो वैकल्पिक फ़ील्ड मदद करते हैं:

user_state: व्यक्ति कहाँ रहता है, जब आपको पता हो कि व्यक्ति कहाँ रहता है (US-IL, IL या Illinois)। Auto मोड में, कवरेज वाले राज्य में होने पर फ़्लो सहमति माँगता है।
biometric_consent: given_at और text_version वाला एक ऑब्जेक्ट, उस सहमति के लिए जो आपने पहले ही ले ली है। फ़्लो दोबारा नहीं पूछता।

4.10.0 से पहले के नेटिव SDK यह चरण नहीं दिखा सकते: उनके सत्र पहले की तरह चलते हैं और निर्णय में सहमति को एकत्र न की गई के रूप में दर्शाया जाता है। देखें बायोमेट्रिक सहमति।

महत्वपूर्ण: प्रकटीकरण और सहमति अब भी आपके प्रोडक्ट में होते हैं

Create Session एक सत्यापन URL और सत्र टोकन बनाता है। यह अपने आप यह सिद्ध नहीं करता कि आपने उपयोगकर्ता को प्रकटीकरण दिखाए हैं या आपके विशिष्ट उपयोग के मामले के लिए आवश्यक सहमति ली है। यदि आप अपने एप्लिकेशन, वेबसाइट, SDK रैपर या व्हाइट लेबल फ़्लो से Didit सत्र शुरू करते हैं, तो उपयोगकर्ता द्वारा कैप्चर शुरू करने से पहले आपको कानूनी पहलू अपने ही UX में संभालना चाहिए।

सत्यापन से पहले की अनुशंसित चेकलिस्ट

उपयोगकर्ता को बताएँ कि यह सत्यापन आपकी कंपनी द्वारा माँगा जा रहा है और इस फ़्लो को Didit सत्यापन प्रदाता / प्रोसेसर के रूप में चला रहा है।
आपकी गोपनीयता सूचना और इस प्रक्रिया पर लागू होने वाली किसी भी नियंत्रक-पक्ष कानूनी शर्त से लिंक करें।
Didit की पहचान सत्यापन गोपनीयता सूचना और पहचान सत्यापन के लिए अंतिम उपयोगकर्ता की शर्तों से लिंक करें।
यदि आपके वर्कफ़्लो में दस्तावेज़ कैप्चर, सेल्फ़ी कैप्चर, लाइवनेस या बायोमेट्रिक्स शामिल हैं, तो जहाँ लागू कानून या आपकी कानूनी स्थिति इसकी माँग करती है, वहाँ स्पष्ट सकारात्मक सहमति लें।
यदि आप कस्टम UI, कस्टम डोमेन या केवल-API प्रक्रिया का उपयोग करते हैं, तो उपयोगकर्ता को Didit फ़्लो में भेजने से पहले ये प्रकटीकरण अपने प्रोडक्ट में प्रदर्शित करें।
यदि आपकी कानूनी टीम ऑडिट ट्रेल चाहती है, तो सूचना / सहमति के पाठ, समय-मुहर और संबंधित मेटाडेटा का अपना रिकॉर्ड रखें।

कानूनी आवश्यकताएँ क्षेत्राधिकार के अनुसार अलग-अलग होती हैं। व्हाइट लेबल ब्रांडिंग सत्यापन फ़्लो में Didit की भूमिका को समाप्त नहीं करती। यदि आप बायोमेट्रिक-विशिष्ट नियमों वाले क्षेत्राधिकारों में संचालन करते हैं, तो लॉन्च से पहले अपने कार्यान्वयन की समीक्षा कानूनी सलाहकार से करवाएँ।

प्राधिकरण

x-api-key

string

header

आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json

workflow_id

string<uuid>

आवश्यक

वर्कफ़्लो का स्थिर पहचानकर्ता जो परिभाषित करता है कि सत्र कौन से सत्यापन चरणों को चलाएगा। वर्कफ़्लो कंसोल के Workflows पृष्ठ में बनाए और प्रबंधित किए जाते हैं। workflow_id अप्रत्यक्ष रूप से यह भी चुनता है कि सत्र KYC है या KYB।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

vendor_data

string

सत्यापित किए जा रहे उपयोगकर्ता के लिए एक विशिष्ट पहचानकर्ता, जैसे UUID, ईमेल या आंतरिक उपयोगकर्ता ID। इस फ़ील्ड का उपयोग इसके लिए किया जाता है: (1) उपयोगकर्ता समूहीकरण — समान vendor_data वाले सत्र Users टैब में समान उपयोगकर्ता प्रोफ़ाइल से लिंक होते हैं। (2) क्रॉस-सत्र डुप्लिकेट डिटेक्शन — डुप्लिकेट चेहरों, दस्तावेज़ों, फ़ोन नंबरों, ईमेल, IP पतों या डिवाइस फ़िंगरप्रिंट की जाँच करते समय, समान vendor_data वाले सत्रों को एक ही उपयोगकर्ता माना जाता है और मिलानों से बाहर रखा जाता है। vendor_data के बिना, प्रत्येक सत्र को एक अद्वितीय उपयोगकर्ता माना जाता है और सभी संभावित डुप्लिकेट सामने लाए जाते हैं। हम डुप्लिकेट डिटेक्शन में अनावश्यक डेटा कम करने के लिए हमेशा vendor_data प्रदान करने की पुरज़ोर अनुशंसा करते हैं।

उदाहरण:

"user-123"

multi_account_segment

string

आपके संगठन के भीतर वैकल्पिक डुप्लिकेट-डिटेक्शन क्षेत्र। डुप्लिकेट चेहरा जांच इस सत्र की तुलना केवल उसी सेगमेंट वाले अन्य सत्रों से करती है, ताकि अलग-अलग खाता आधार (व्यक्तिगत और व्यावसायिक खाते, या प्रति B2B सब-क्लाइंट एक) ऐसे व्यक्ति को फ़्लैग न करें जिसके पास वैध रूप से दोनों में एक-एक खाता है। एकल डिफ़ॉल्ट क्षेत्र का उपयोग करने के लिए इसे छोड़ दें, जिसका उपयोग आज प्रत्येक सत्र करता है। ब्लॉकलिस्ट और अनुमति सूची मिलान इस फ़ील्ड को अनदेखा करते हैं।

Maximum string length: 64

उदाहरण:

"business-accounts"

callback

string

सत्यापन पूरा होने के बाद उपयोगकर्ता को रीडायरेक्ट करने का URL। Didit स्वचालित रूप से क्वेरी पैरामीटर के रूप में verificationSessionId और status (Approved, Declined, In Review) जोड़ता है। मोबाइल कॉलबैक के लिए कस्टम URL स्कीम्स (जैसे myapp://) समर्थित हैं। यदि छोड़ दिया जाता है, तो वर्कफ़्लो के डिफ़ॉल्ट callback_url का उपयोग किया जाता है। जब एप्लिकेशन में अनुमत डोमेन (PATCH /v3/webhook/ पर allowed_domains) होते हैं, तो एक http या https कॉलबैक उन ऑरिजिनों में से एक पर होना चाहिए (समान स्कीम, होस्ट और पोर्ट), अन्यथा callback पर 400 के साथ अनुरोध विफल हो जाता है: callback must be on one of the application's allowed domains: https://app.example.com। कस्टम URL स्कीम्स हमेशा स्वीकार किए जाते हैं।

उदाहरण:

"https://example.com/verification/callback"

callback_method

enum<string>

डिफ़ॉल्ट:initiator

निर्धारित करता है कि प्रदान किए गए कॉलबैक URL पर रीडायरेक्ट को किस डिवाइस को संभालना चाहिए। केवल उस डिवाइस को रीडायरेक्ट करने के लिए initiator का उपयोग करें जिसने प्रवाह शुरू किया था, इसे पूरा करने वाले डिवाइस के लिए completer, या किसी भी डिवाइस को कॉलबैक ट्रिगर करने की अनुमति देने के लिए both का उपयोग करें। यदि आप कभी देखते हैं कि कॉलबैक विश्वसनीय रूप से ट्रिगर नहीं हो रहा है, तो हम इस मान को both पर सेट करने की अनुशंसा करते हैं।

उपलब्ध विकल्प:

initiator,

completer,

both

उदाहरण:

"both"

metadata

any

सत्र के साथ संग्रहीत मनमाना JSON जो रिस्पॉन्स और webhooks में वापस लौटाया जाता है। कोई भी JSON मान स्वीकार किया जाता है (ऑब्जेक्ट, स्ट्रिंग, संख्या, ऐरे), लेकिन key/value युग्मों के एक JSON ऑब्जेक्ट की अनुशंसा की जाती है। अंतिम उपयोगकर्ता को नहीं दिखाया जाता। अपनी स्वयं की कोरिलेशन IDs, A/B वेरिएंट, या व्यावसायिक संदर्भ पास करने के लिए इसका उपयोग करें।

उदाहरण:

{
  "user_type": "premium",
  "account_id": "ABC123"
}

प्रतिक्रिया

सत्र बनाया गया (या वापस लौटाया गया, यदि वर्कफ़्लो के नवीनतम प्रकाशित संस्करण पर समान vendor_data वाला कोई अधूरा सत्र पहले से मौजूद है)। रिस्पॉन्स सीरियलाइज़ किया गया सत्र है, जिसमें उपयोगकर्ता को रीडायरेक्ट करने के लिए होस्टेड सत्यापन url शामिल है।

session_id

string<uuid>

आवश्यक

सत्यापन सत्र का विशिष्ट पहचानकर्ता। GET /v3/session/{sessionId}/decision/ को कॉल करते समय इस id का उपयोग करें।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

session_number

integer

आवश्यक

आपके एप्लिकेशन के अंदर सत्र को सौंपी गई अनुक्रमिक, आसानी से पढ़ी जाने वाली संख्या। सहायता और डैशबोर्ड के लिए उपयोगी।

उदाहरण:

43762

session_token

string

आवश्यक

12-वर्ण का URL-सुरक्षित token जो अंतिम उपयोगकर्ता को url पर होस्ट किए गए सत्यापन प्रवाह तक पहुँचने के लिए अधिकृत करता है। सत्र समाप्त होने तक मान्य। इसे एक सीक्रेट की तरह मानें — इसे रखने वाला कोई भी व्यक्ति इस सत्र के लिए सत्यापन प्रवाह खोल सकता है।

उदाहरण:

"3FaJ9wLqX2Mz"

url

string<uri>

आवश्यक

अंतिम उपयोगकर्ता को रीडायरेक्ट करने के लिए होस्टेड सत्यापन URL। URL में session_token एम्बेड होता है और, यदि कॉन्फ़िगर किया गया है, तो यह आपके व्हाइट लेबल डोमेन का उपयोग करता है। जब अनुरोध में language शामिल होता है, तो URL में एक भाषा पथ खंड होता है — https://verify.didit.me/{language}/session/{session_token} (उदा. /es/session/...); बिना language के, यह खंड छोड़ दिया जाता है।

उदाहरण:

"https://verify.didit.me/session/3FaJ9wLqX2Mz"

vendor_data

string | null

आवश्यक

वह पहचानकर्ता जिसे आपने सत्र को अपने सिस्टम में किसी उपयोगकर्ता या व्यवसाय से जोड़ने के लिए अनुरोध में पास किया था। ज्यों का त्यों वापस भेजा जाता है। प्रदान न किए जाने पर Null।

उदाहरण:

"user-123"

metadata

any

आवश्यक

सत्र निर्माण के समय संग्रहीत किया गया आपका मनमाना JSON payload। जैसा भेजा गया था वैसा ही वापस दोहराया जाता है — आपके द्वारा भेजा गया कोई भी JSON मान (ऑब्जेक्ट, स्ट्रिंग, संख्या, ऐरे) यथावत लौटाया जाता है, हालांकि एक JSON ऑब्जेक्ट की अनुशंसा की जाती है। अंतिम उपयोगकर्ता को नहीं दिखाया जाता। रिस्पॉन्स में हमेशा मौजूद रहता है; निर्माण के समय प्रदान न किए जाने पर null होता है।

उदाहरण:

{
  "user_type": "premium",
  "account_id": "ABC123"
}

status

enum<string>

आवश्यक

सत्र की वर्तमान स्थिति। नए बनाए गए सत्र Not Started लौटाते हैं। यदि वर्कफ़्लो के नवीनतम प्रकाशित संस्करण पर उसी vendor_data के लिए कोई गैर-समाप्त सत्र पहले से मौजूद था, तो लौटाई गई स्थिति उस मौजूदा सत्र को दर्शाती है।

उपलब्ध विकल्प:

Not Started,

In Progress,

Approved,

Declined,

In Review,

Expired,

Abandoned,

Kyc Expired,

Resubmitted,

Awaiting User

उदाहरण:

"Not Started"

callback

string<uri> | null

आवश्यक

फ़्लो पूरा करने के बाद उपयोगकर्ता को भेजा जाने वाला अंतिम रीडायरेक्ट URL। Didit इस URL में ?verificationSessionId={session_id}&status={status} जोड़ता है। अनुरोध में प्रदान न किए जाने पर वर्कफ़्लो के कॉन्फ़िगर किए गए कॉलबैक URL पर फ़ॉलबैक करता है; दोनों सेट न होने पर null। जब एप्लिकेशन में अनुमत डोमेन होते हैं और यह URL उनके बाहर का कोई वेब URL होता है (उदाहरण के लिए सूची बदलने से पहले सेट किया गया वर्कफ़्लो डिफ़ॉल्ट), तो होस्टेड फ़्लो उपयोगकर्ता को उस पर रीडायरेक्ट नहीं करता है।

उदाहरण:

"https://example.com/verification/callback"

workflow_id

string<uuid>

आवश्यक

उस वर्कफ़्लो का स्थिर पहचानकर्ता जिस पर यह सत्र चलता है। हमेशा वर्कफ़्लो का स्थिर समूह पहचानकर्ता — भले ही आपने अनुरोध में किसी विशिष्ट वर्कफ़्लो संस्करण UUID का संदर्भ दिया हो (बैकवर्ड-कम्पैटिबल लुकअप), रिस्पॉन्स में स्थिर workflow_id शामिल होता है। कंसोल में आपके द्वारा कॉन्फ़िगर किए गए वर्कफ़्लो के साथ सत्र को सहसंबंधित करने के लिए इसका उपयोग करें।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

workflow_version

integer

आवश्यक

प्रकाशित वर्कफ़्लो संस्करण की संस्करण संख्या जिस पर निर्माण के समय सत्र को पिन किया गया था। सत्र बनाए जाने पर Didit workflow_id को वर्कफ़्लो के नवीनतम प्रकाशित संस्करण में हल करता है, और वर्कफ़्लो को बाद में पुनः प्रकाशित किए जाने पर भी सत्र उसी संस्करण को चलाता रहता है।

उदाहरण:

3

​KYC और KYB सहायता

​उदाहरण

​ई-हस्ताक्षर दस्तावेज़

​एंकर टेक्स्ट से फ़ील्ड लगाएँ

​फ़ील्ड मान

​त्रुटियाँ और दोहराई गई कॉल

​सैंडबॉक्स परिदृश्यों से परीक्षण

​vendor_data सत्र को एक इकाई से जोड़ता है

​इलिनॉय, टेक्सास और कोलोराडो में बायोमेट्रिक सहमति

​महत्वपूर्ण: प्रकटीकरण और सहमति अब भी आपके प्रोडक्ट में होते हैं

​सत्यापन से पहले की अनुशंसित चेकलिस्ट

प्राधिकरण

बॉडी

प्रतिक्रिया

KYC और KYB सहायता

उदाहरण

ई-हस्ताक्षर दस्तावेज़

एंकर टेक्स्ट से फ़ील्ड लगाएँ

फ़ील्ड मान

त्रुटियाँ और दोहराई गई कॉल

सैंडबॉक्स परिदृश्यों से परीक्षण

`vendor_data` सत्र को एक इकाई से जोड़ता है

इलिनॉय, टेक्सास और कोलोराडो में बायोमेट्रिक सहमति

महत्वपूर्ण: प्रकटीकरण और सहमति अब भी आपके प्रोडक्ट में होते हैं

सत्यापन से पहले की अनुशंसित चेकलिस्ट