शुरू करें
इंटीग्रेट करें / SDK
उपयोगकर्ता सत्यापन
व्यवसाय सत्यापन
लेन-देन निगरानी
चेंजलॉगcurl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}webhook कॉन्फ़िगरेशन अपडेट API
Didit में application-level webhook बदलें, secret रोटेट करें, डेटा और बायोमेट्रिक टेम्पलेट प्रतिधारण सेट करें, और Digital ID वॉलेट रिटर्न होस्ट जोड़ें।
curl -X PATCH 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.update_config(
face_retention_policy="retain_until_user_deleted",
face_retention_days=365,
biometric_consent_mode="auto",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.updateConfig({
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto",
});
console.log(result);import me.didit.Didit;
import me.didit.types.WebhooksUpdateConfigParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder()
.faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted"))
.faceRetentionDays(365L)
.biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->updateConfig([
'face_retention_policy' => 'retain_until_user_deleted',
'face_retention_days' => 365,
'biometric_consent_mode' => 'auto',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.update_config(
face_retention_policy: "retain_until_user_deleted",
face_retention_days: 365,
biometric_consent_mode: "auto"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams
{
FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"),
FaceRetentionDays = 365,
BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"),
});
Console.WriteLine(JsonSerializer.Serialize(result));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/webhook/"
payload := strings.NewReader("{\n \"face_retention_policy\": \"retain_until_user_deleted\",\n \"face_retention_days\": 365,\n \"biometric_consent_mode\": \"auto\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"webhook_url": "https://yourapp.com/webhooks/didit",
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA",
"capture_method": "MOBILE",
"data_retention_months": 24,
"face_retention_policy": "retain_until_user_deleted",
"face_retention_days": 365,
"biometric_consent_mode": "auto",
"available_events": [
{
"value": "status.updated",
"label": "Session status updated"
},
{
"value": "data.updated",
"label": "Session data updated"
},
{
"value": "user.status.updated",
"label": "User status updated"
},
{
"value": "user.data.updated",
"label": "User data updated"
},
{
"value": "business.status.updated",
"label": "Business status updated"
},
{
"value": "business.data.updated",
"label": "Business data updated"
},
{
"value": "activity.created",
"label": "Activity created"
},
{
"value": "transaction.created",
"label": "Transaction created"
},
{
"value": "transaction.status.updated",
"label": "Transaction status updated"
},
{
"value": "travel_rule.status.updated",
"label": "Travel Rule Status Updated"
},
{
"value": "workflow.compliance_changed",
"label": "Workflow Compliance Changed"
}
],
"allowed_return_hosts": [
"shop.example.com"
],
"endpoints": [
{
"uuid": "11111111-2222-3333-4444-555555555555",
"label": "Production session webhooks",
"url": "https://yourapp.com/webhooks/didit",
"enabled": true,
"webhook_version": "v3",
"secret_shared_key": "dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA",
"subscribed_events": [
"status.updated",
"data.updated"
],
"created_at": "2026-01-04T08:00:00.000000Z",
"updated_at": "2026-04-22T14:09:11.523671Z"
}
]
}rotate_secret_key केवल एप्लिकेशन-स्तर के सीक्रेट को रोटेट करता है, जो लीगेसी webhook_url पर भेजी गई डिलीवरी पर हस्ताक्षर करता है। हर webhook गंतव्य अपने secret_shared_key से हस्ताक्षर करता है, और यह कॉल उसे नहीं बदलती।allowed_return_hosts का वर्णन अपना रिटर्न गंतव्य पंजीकृत करें में किया गया है।
biometric_consent_mode (auto, always या never) यह तय करता है कि सत्यापन फ़्लो चेहरा कैप्चर करने से पहले स्पष्ट बायोमेट्रिक सहमति कब माँगे। देखें बायोमेट्रिक सहमति।
मौजूदा मान पहले पढ़ने के लिए, Webhook कॉन्फ़िगरेशन प्राप्त करें को कॉल करें।प्राधिकरण
आपकी एप्लिकेशन की 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।
बॉडी
केवल वे फ़ील्ड भेजें जिन्हें बदलना है। गंतव्यों का प्रबंधन यहाँ नहीं किया जाता है।
लीगेसी एप्लिकेशन-स्तरीय webhook URL। Didit इसका उपयोग केवल तब करता है जब एप्लिकेशन का कोई सक्षम गंतव्य न हो, और तब केवल status.updated और data.updated के लिए। यह कोई गंतव्य नहीं बनाता है, और किसी गंतव्य का अगला निर्माण, अद्यतन या विलोपन इसे बदल देता है। webhook प्राप्त करने के लिए, इसके बजाय POST /v3/webhook/destinations/ के साथ एक गंतव्य बनाएँ।
2000लेगसी webhook_url का payload संस्करण।
v1, v2, v3 true एप्लिकेशन-स्तरीय secret_shared_key को तुरंत एक नए यादृच्छिक मान से बदल देता है; नया मान रिस्पॉन्स में होता है। गंतव्य सीक्रेट नहीं बदले जाते हैं। true के साथ प्रत्येक कॉल एक नया सीक्रेट उत्पन्न करती है, इसलिए यह आइडेम्पोटेंट नहीं है।
लीगेसी एप्लिकेशन सेटिंग। सत्यापन फ़्लो इसे नहीं पढ़ता है।
MOBILE, MOBILE_AND_DESKTOP महीनों में स्वचालित विलोपन विंडो (एक महीने को 30 दिन माना जाता है), या स्वचालित विलोपन न होने के लिए null। यह बदलाव मौजूदा सत्रों पर भी लागू होता है: नई विंडो से अधिक पुराना प्रत्येक उपयोगकर्ता सत्यापन सत्र स्वचालित रूप से हटा दिया जाता है, और वह विलोपन अपरिवर्तनीय है।
1 <= x <= 120सत्र हटाए जाने पर सत्र के फ़ेस एम्बेडिंग का क्या होता है। retain_until_user_deleted के लिए उसी अनुरोध में face_retention_days की आवश्यकता होती है या यह पहले से सेट होना चाहिए। कोई भी परिवर्तन इसके बाद होने वाले सत्र विलोपन पर लागू होता है; यह किसी भी मौजूदा बायोमेट्रिक टेम्पलेट को नहीं बनाता या पर्ज नहीं करता है।
delete_with_session, retain_until_user_deleted retain_until_user_deleted के तहत बायोमेट्रिक टेम्पलेट्स की डेटा प्रतिधारण अवधि, दिनों में।
1 <= x <= 3650होस्टेड फ़्लो और नेटिव SDK चेहरा कैप्चर करने से पहले व्यक्ति से स्पष्ट बायोमेट्रिक सहमति कब मांगते हैं। auto (डिफ़ॉल्ट) केवल तभी पूछता है जब कोई ट्रिगर लागू होता है: घोषित राज्य, व्यक्ति का IP, या पहचान दस्तावेज़ का जारीकर्ता Illinois, Texas या Colorado में हो, या व्यक्ति US में प्रतीत होता हो, लेकिन राज्य ज्ञात न हो। always ऐसे प्रत्येक व्यक्ति से पूछता है जिसके वर्कफ़्लो में चेहरा कैप्चर किया जाता है। never कभी भी यह चरण नहीं दिखाता है, और आप सेल्फ़ी से पहले सहमति स्वयं एकत्र करते हैं। प्रत्येक परिवर्तन ऑडिट लॉग में दर्ज किया जाता है। बायोमेट्रिक सहमति देखें।
auto, always, never Digital ID वॉलेट रिटर्न होस्ट्स की पूरी सूची को बदलता है। केवल बेयर होस्टनाम, जैसे कि shop.example.com: कोई स्कीम, पोर्ट, पाथ या वाइल्डकार्ड नहीं। मान लोअरकेस में किए जाते हैं और डुप्लिकेट हटा दिए जाते हैं। सूची को साफ़ करने के लिए [] भेजें।
20253अनुमत ऑरिजिन की पूरी सूची को बदलता है। वे ऑरिजिन (उदाहरण के लिए https://app.example.com; localhost के लिए केवल http) जिनमें होस्टेड सत्यापन फ़्लो एम्बेड किया जा सकता है और सत्र कॉलबैक के साथ उपयोगकर्ता को वापस भेज सकता है। सर्वर-टू-सर्वर कॉल प्रभावित नहीं होती हैं। खाली सूची का अर्थ है कोई प्रतिबंध नहीं। Didit प्रत्येक ऑरिजिन को डिफ़ॉल्ट पोर्ट के बिना लोअरकेस में संग्रहीत करता है। एक अमान्य प्रविष्टि allowed_domains पर 400 के साथ विफल हो जाती है। प्रतिबंध हटाने के लिए [] भेजें।
50300["https://app.example.com"]
प्रतिक्रिया
अपडेट के बाद पूर्ण कॉन्फ़िगरेशन, GET /v3/webhook/ के समान संरचना वाला। जब आपने सीक्रेट को रोटेट किया है, तो रिस्पॉन्स को त्यागने से पहले नई secret_shared_key को संग्रहीत करें।
प्रत्येक webhook गंतव्य के साथ एप्लिकेशन-स्तरीय webhook कॉन्फ़िगरेशन, प्रतिधारण नीति और Digital ID वॉलेट रिटर्न होस्ट।
एप्लिकेशन-स्तरीय (लीगेसी) webhook URL। Didit इस पर केवल तभी भेजता है जब एप्लिकेशन के पास कोई सक्षम गंतव्य न हो, और फिर केवल status.updated और data.updated। किसी गंतव्य का प्रत्येक निर्माण, अपडेट या विलोपन इसे सबसे पुराने सक्षम गंतव्य के URL पर सेट करता है, या सक्षम न होने पर null पर।
लेगसी webhook_url का payload संस्करण। प्रत्येक गंतव्य का अपना webhook_version होता है।
v1, v2, v3 एप्लिकेशन-स्तरीय साइनिंग सीक्रेट (43-वर्णों वाला URL-सुरक्षित token)। यह केवल लीगेसी webhook_url पर डिलीवरी पर हस्ताक्षर करता है; प्रत्येक गंतव्य अपनी secret_shared_key से हस्ताक्षर करता है। API कुंजी का उपयोग करने वाले कॉलकर्ताओं को यह हमेशा पूरी तरह से प्राप्त होता है; बिना read:webhooks वाले कंसोल उपयोगकर्ताओं को एक खाली स्ट्रिंग प्राप्त होती है।
लीगेसी एप्लिकेशन सेटिंग। सत्यापन फ़्लो इसे नहीं पढ़ता है: कैप्चर विकल्प प्रति वर्कफ़्लो कॉन्फ़िगर किए जाते हैं।
MOBILE, MOBILE_AND_DESKTOP स्वचालित विलोपन विंडो। इस संख्या से अधिक महीने पहले बनाए गए उपयोगकर्ता सत्यापन सत्र (एक महीने को 30 दिन गिना जाता है) स्वचालित रूप से हटा दिए जाते हैं, और यह विलोपन अपरिवर्तनीय होता है। null का अर्थ है कि सत्र कभी भी स्वचालित रूप से नहीं हटाए जाते हैं। देखें डेटा प्रतिधारण।
1 <= x <= 120सत्र हटाए जाने पर सत्र के फ़ेस एम्बेडिंग का क्या होता है। delete_with_session (डिफ़ॉल्ट) इसे सत्र के साथ हटा देता है। retain_until_user_deleted ऑप्ट-इन बायोमेट्रिक टेम्पलेट प्रतिधारण है: उपयोगकर्ता से जुड़ा एक छवि-मुक्त बायोमेट्रिक टेम्पलेट तब तक अलग से प्रबंधित किया जाता है जब तक कि इसकी प्रतिधारण अवधि समाप्त न हो जाए, उपयोगकर्ता हटा न दिया जाए, या आप इसे पर्ज न कर दें।
delete_with_session, retain_until_user_deleted retain_until_user_deleted के तहत बायोमेट्रिक टेम्पलेट्स की डेटा प्रतिधारण अवधि, दिनों में। यह नीति सेट होने पर आवश्यक है।
1 <= x <= 3650प्रत्येक इवेंट प्रकार जिसे एक गंतव्य सब्सक्राइब कर सकता है, एक डिस्प्ले लेबल के साथ।
Show child attributes
Show child attributes
होस्टनाम (सटीक मिलान, केवल HTTPS) जिन पर स्टैंडअलोन डिजिटल ID वॉलेट सत्यापन उपयोगकर्ता को अपने return_url के साथ वापस भेज सकता है। आपका व्हाइट लेबल डोमेन भी हमेशा अनुमत है। देखें अपना वापसी गंतव्य पंजीकृत करें।
20253एप्लिकेशन का प्रत्येक webhook गंतव्य, सबसे पुराना पहले, प्रत्येक अपने हस्ताक्षर सीक्रेट के साथ। यहाँ केवल पढ़ने के लिए: /v3/webhook/destinations/ endpoints के साथ गंतव्यों का प्रबंधन करें।
Show child attributes
Show child attributes
होस्टेड फ़्लो और नेटिव SDK चेहरा कैप्चर करने से पहले व्यक्ति से स्पष्ट बायोमेट्रिक सहमति कब मांगते हैं। auto (डिफ़ॉल्ट) केवल तभी पूछता है जब कोई ट्रिगर लागू होता है: घोषित राज्य, व्यक्ति का IP, या पहचान दस्तावेज़ का जारीकर्ता Illinois, Texas या Colorado में हो, या व्यक्ति US में प्रतीत होता हो, लेकिन राज्य ज्ञात न हो। always ऐसे प्रत्येक व्यक्ति से पूछता है जिसके वर्कफ़्लो में चेहरा कैप्चर किया जाता है। never कभी भी यह चरण नहीं दिखाता है, और आप सेल्फ़ी से पहले सहमति स्वयं एकत्र करते हैं। प्रत्येक परिवर्तन ऑडिट लॉग में दर्ज किया जाता है। बायोमेट्रिक सहमति देखें।
auto, always, never ऑरिजिन (उदाहरण के लिए https://app.example.com; केवल localhost के लिए http) जिनमें होस्टेड सत्यापन प्रवाह को एम्बेड किया जा सकता है और जो सत्र कॉलबैक के साथ उपयोगकर्ता को वापस भेज सकते हैं। सर्वर-टू-सर्वर कॉल प्रभावित नहीं होती हैं। एक खाली सूची का अर्थ है कोई प्रतिबंध नहीं। Didit प्रत्येक ऑरिजिन को बिना डिफ़ॉल्ट पोर्ट के लोअरकेस में संग्रहीत करता है। अमान्य प्रविष्टि allowed_domains पर 400 के साथ विफल हो जाती है।
50300["https://app.example.com"]