शुरू करें
इंटीग्रेट करें / SDK
उपयोगकर्ता सत्यापन
व्यवसाय सत्यापन
लेन-देन निगरानी
चेंजलॉगcurl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.create(
vendor_data="user-abc-123",
full_name="John Doe",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.create({
vendor_data: "user-abc-123",
full_name: "John Doe",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.Create(ctx, didit.UsersCreateParams{
VendorData: "user-abc-123",
FullName: didit.String("John Doe"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.UsersCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().create(UsersCreateParams.builder()
.vendorData("user-abc-123")
.fullName("John Doe")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->create([
'vendor_data' => 'user-abc-123',
'full_name' => 'John Doe',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.create(
vendor_data: "user-abc-123",
full_name: "John Doe"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.CreateAsync(new UsersCreateParams
{
VendorData = "user-abc-123",
FullName = "John Doe",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Doe",
"date_of_birth": null,
"effective_name": "John Doe",
"status": "ACTIVE",
"metadata": {},
"portrait_image_url": null,
"session_count": 0,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 0,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {},
"features_list": [],
"last_session_at": null,
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": null,
"tags": [],
"comments": [],
"created_at": "2025-06-15T10:30:00Z",
"updated_at": "2025-06-15T10:30:00Z",
"verification_link": null
}उपयोगकर्ता बनाने का API: विक्रेता उपयोगकर्ता इकाई
Didit में KYC सत्र चलने से पहले विक्रेता User entities पहले से बनाएँ। बाहरी डेटाबेस से बल्क ऑनबोर्ड करें या लेन-देन निगरानी के लिए उपयोगकर्ता पंजीकृत करें।
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.create(
vendor_data="user-abc-123",
full_name="John Doe",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.create({
vendor_data: "user-abc-123",
full_name: "John Doe",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.Create(ctx, didit.UsersCreateParams{
VendorData: "user-abc-123",
FullName: didit.String("John Doe"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.UsersCreateParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().create(UsersCreateParams.builder()
.vendorData("user-abc-123")
.fullName("John Doe")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->create([
'vendor_data' => 'user-abc-123',
'full_name' => 'John Doe',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.create(
vendor_data: "user-abc-123",
full_name: "John Doe"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.CreateAsync(new UsersCreateParams
{
VendorData = "user-abc-123",
FullName = "John Doe",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Doe",
"date_of_birth": null,
"effective_name": "John Doe",
"status": "ACTIVE",
"metadata": {},
"portrait_image_url": null,
"session_count": 0,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 0,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {},
"features_list": [],
"last_session_at": null,
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": null,
"tags": [],
"comments": [],
"created_at": "2025-06-15T10:30:00Z",
"updated_at": "2025-06-15T10:30:00Z",
"verification_link": null
}अवलोकन
सत्र चलने से पहले यह स्पष्ट रूप से उपयोगकर्ता इकाई बनाता है। लौटाई गई इकाई डिफ़ॉल्ट रूप सेACTIVE स्थिति में आती है, जब तक आप अलग से निर्दिष्ट न करें।
वैकल्पिक रूप से, यही कॉल व्यक्ति को सत्यापन लिंक ईमेल भी कर सकती है (देखें सत्यापन लिंक भेजें)।
कब उपयोग करें
- ग्राहक के सत्यापन से पहले मेटाडेटा भरें (स्तर, साइनअप स्रोत, आंतरिक टैग)।
- किसी अन्य वेंडर से माइग्रेट करें: अपनी मौजूदा उपयोगकर्ता सूची को Didit में दोबारा बनाएँ, ताकि इतिहास और एनालिटिक्स एक ज्ञात आधार रेखा से शुरू हों।
- भरोसेमंद प्रोफ़ाइल चेहरों को इंपोर्ट करें: पहले उपयोगकर्ता बनाएँ, फिर लौटाए गए
didit_internal_idके साथ उपयोगकर्ता चेहरा अपलोड करें को कॉल करें। - केवल लेन-देन वाले उपयोग के मामले:
vendor_dataके साथ उपयोगकर्ता पंजीकृत करें, ताकि आप उपयोगकर्ता सत्यापन (KYC) सत्र चलाए बिना लेन-देन सबमिट कर सकें। - किसी को सत्यापन के लिए आमंत्रित करें: एक ही कॉल में व्यक्ति बनाएँ और उसे सत्यापन लिंक ईमेल करें।
संपर्क विवरण
आप व्यक्ति के संपर्क विवरण प्रोफ़ाइल फ़ील्ड्स के साथ भेज सकते हैं। जब आपfull_name न भेजें, तो first_name और last_name एक स्पेस के साथ जुड़कर full_name बनते हैं।
email और phone_number metadata.contact में संग्रहीत होते हैं, और country metadata.address में।
country ISO 3166 कोड लेता है, alpha-2 या alpha-3 (ES या ESP), और इसे बड़े अक्षरों में संग्रहीत किया जाता है।
यदि आपके भेजे गए metadata में पहले से contact या address का कोई मान है जो JSON ऑब्जेक्ट नहीं है, तो Didit उसे अधिलेखित नहीं करता: कॉल उस contact या address फ़ील्ड के लिए 400 लौटाती है जिसमें JSON ऑब्जेक्ट की आवश्यकता थी।
सत्यापन लिंक भेजें
व्यक्ति को उसी कॉल में सत्यापन के लिए आमंत्रित करने हेतुsend_verification_link को true पर सेट करें।
Didit workflow_id में दिए वर्कफ़्लो पर उस व्यक्ति के लिए एक सत्यापन सत्र बनाता है और email पर लिंक भेजता है।
ईमेल की भाषा चुनने के लिए language का उपयोग करें; छोड़ने पर यह अंग्रेज़ी होती है।
curl -X POST https://verification.didit.me/v3/users/create/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"vendor_data": "user-abc-789",
"first_name": "Julia",
"last_name": "Martin",
"email": "julia.martin@example.com",
"send_verification_link": true,
"workflow_id": "YOUR_WORKFLOW_ID",
"language": "es"
}'
- लिंक के साथ
emailऔरworkflow_idअनिवार्य हैं, और वर्कफ़्लो को एक व्यक्ति को सत्यापित करना होगा: व्यवसाय सत्यापन (KYB) वर्कफ़्लो400लौटाता है। - सत्र पर सत्र बनाएँ में बताई गई वही जाँचें लागू होती हैं।
ब्लॉकलिस्ट में शामिल
vendor_dataया अपर्याप्त क्रेडिट400लौटाते हैं। - व्यक्ति और सत्र एक साथ बनते हैं, या बिल्कुल नहीं बनते। किसी भी जाँच के विफल होने पर कुछ भी नहीं लिखा जाता और कोई ईमेल नहीं भेजा जाता।
- रिस्पॉन्स में
verification_linkहोता है, जिसमें सत्र काsession_id,session_number,status,url,workflow_idऔर वहemailशामिल है जिस पर इसे भेजा गया था। लिंक के बिनाverification_linknullहोता है।
नोट्स
vendor_dataअनिवार्य है और हर एप्लिकेशन में अनोखा होना चाहिए। डुप्लिकेट बनाने की कोशिश पर कॉन्फ़्लिक्ट त्रुटि लौटती है: मौजूदा उपयोगकर्ता को अपडेट करने के लिएPATCH /v3/users/{vendor_data}/का उपयोग करें।vendor_dataकी सख़्त सीमा 2000 बाइट्स (UTF-8 एन्कोडेड) है। इस सीमा से अधिक मान स्वीकार होने के बजाय 400 वैलिडेशन त्रुटि लौटाता है।- जो फ़ील्ड सामान्यतः सत्यापित सत्रों से निकलते हैं (
full_name,date_of_birth), उन्हें यहाँ पहले से भरा जा सकता है, पर पहला स्वीकृत उपयोगकर्ता सत्यापन (KYC) सत्र उन्हें अधिलेखित कर सकता है। - इस endpoint पर चेहरे की छवियाँ स्वीकार नहीं होतीं। कोई भरोसेमंद इंपोर्ट किया गया चेहरा जोड़ने के लिए, इस endpoint के
didit_internal_idलौटाने के बादPOST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/का उपयोग करें। - बनाने की प्रक्रिया स्वयं कोई webhook नहीं भेजती। उपयोगकर्ता में बाद के बदलाव
user.data.updatedयाuser.status.updatedभेजते हैं। send_verification_linkके साथ, नया सत्र उसी कॉल में उपयोगकर्ता को अपडेट करता है, जिससेuser.data.updatedभेजा जाता है।
अनुमतियाँ
प्राथमिक सीक्रेट और पूर्ण-पहुँच वाली API कुंजियाँ हमेशा इस endpoint को कॉल कर सकती हैं। कस्टम पहुँच वाली कुंजी को लोग (users) पर लिखने की अनुमति चाहिए।
send_verification_link: true के साथ उसे सत्र पर लिखने की अनुमति भी चाहिए, क्योंकि कॉल सत्र बनाती है और उसका लिंक देती है।
इसके बिना कॉल 403 लौटाती है, संदेश This API key has no write access to sessions. के साथ, और कुछ भी नहीं लिखा जाता।
जो कुंजी कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित है, वह इस endpoint तक नहीं पहुँच सकती।
Console की भूमिकाएँ और अनुमतियाँ तय करती हैं कि कोई टीम सदस्य Console में क्या कर सकता है।
API कुंजी के अनुरोधों के लिए इनका मूल्यांकन नहीं होता।
संबंधित
प्राधिकरण
आपकी एप्लिकेशन की 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।
बॉडी
इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (मुक्त-रूप स्ट्रिंग, UUID नहीं)। एप्लिकेशन के उपयोगकर्ताओं के बीच विशिष्ट होना चाहिए; ठीक वैसे ही मिलान किया जाता है जैसा भेजा गया था।
उपयोगकर्ता का पूरा कानूनी नाम।
512कंसोल में दिखाया जाने वाला मैत्रीपूर्ण डिस्प्ले नाम (UI डिस्प्ले के लिए full_name पर वरीयता लेता है)।
255YYYY-MM-DD प्रारूप में जन्म तिथि।
प्रारंभिक जीवनचक्र स्थिति। डिफ़ॉल्ट रूप से ACTIVE है।
ACTIVE, FLAGGED, BLOCKED उपयोगकर्ता से जुड़ा आपका मनमाना JSON ऑब्जेक्ट। डिफ़ॉल्ट रूप से {} होता है।
इस उपयोगकर्ता के लिए पूर्व-विश्वसनीय ईमेल पते, उदा. ["john@example.com"]।
इस उपयोगकर्ता के लिए पूर्व-विश्वसनीय फ़ोन नंबर, उदा. ["+14155551234"]।
पहले से रिकॉर्ड किए गए जारीकर्ता देश (ISO 3166-1 alpha-3), उदा. ["USA"]।
पहला नाम। जब full_name नहीं भेजा जाता है, तो Didit first_name और last_name को स्पेस के साथ जोड़कर full_name बना देता है। एक अलग फ़ील्ड के रूप में नहीं लौटाया जाता है।
255कुलनाम। full_name न भेजे जाने पर first_name के साथ जोड़कर full_name बनाया जाता है। एक अलग फ़ील्ड के रूप में वापस नहीं किया जाता है।
255संपर्क ईमेल, जो metadata.contact.email में संग्रहीत होता है (यह आपके द्वारा metadata.contact के भीतर भेजे गए email को बदल देता है)। send_verification_link के true होने पर आवश्यक: सत्यापन लिंक इसी पते पर भेजा जाता है। यदि metadata.contact एक JSON ऑब्जेक्ट नहीं है, तो कॉल इस फ़ील्ड के लिए 400 लौटाता है।
संपर्क फ़ोन नंबर, जो metadata.contact.phone_number में संग्रहीत है। यदि metadata.contact एक JSON ऑब्जेक्ट नहीं है, तो कॉल इस फ़ील्ड पर 400 रिस्पॉन्स देती है।
32ISO 3166 कोड के रूप में देश, alpha-2 या alpha-3 (ES या ESP)। metadata.address.country में बड़े अक्षरों में संग्रहीत। यदि metadata.address एक JSON ऑब्जेक्ट नहीं है, तो कॉल इस फ़ील्ड पर 400 उत्तर देता है।
3जब true हो, तो Didit workflow_id पर व्यक्ति के लिए एक सत्यापन सत्र बनाता है और उन्हें email पर लिंक ईमेल करता है। इसके लिए email और workflow_id आवश्यक हैं। एक स्कोप्ड API कुंजी को sessions लिखने की अनुमति की भी आवश्यकता होती है।
सत्यापन सत्र का वर्कफ़्लो। जब send_verification_link true हो तो आवश्यक है। इसे किसी व्यक्ति को सत्यापित करना चाहिए: व्यवसाय सत्यापन (KYB) वर्कफ़्लो अस्वीकार कर दिया जाता है। अन्यथा अनदेखा किया जाता है।
समर्थित भाषा कोड के रूप में सत्यापन ईमेल की भाषा। छोड़े जाने पर अंग्रेज़ी। जब send_verification_link का मान true न हो तो इसे अनदेखा कर दिया जाता है।
10प्रतिक्रिया
उपयोगकर्ता बनाया गया। पूरा उपयोगकर्ता रिकॉर्ड (Get User के समान प्रारूप), साथ ही verification_link: सत्यापन सत्र जिसे Didit ने तब ईमेल किया था जब send_verification_link true था, अन्यथा null।
पूर्ण उपयोगकर्ता विवरण। मेटाडेटा, टिप्पणियों और updated_at के साथ UserListItem का विस्तार करता है।
Didit द्वारा बनाया गया और व्यक्ति को ईमेल किया गया सत्यापन सत्र। हमेशा मौजूद रहता है: null जब send_verification_link true नहीं था।
Show child attributes
Show child attributes
इस उपयोगकर्ता के लिए Didit का स्थायी आंतरिक UUID।
इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह null हो सकता है।
आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम
सत्यापित दस्तावेज़ों से निकाला गया पूरा नाम
सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा full_name
उपयोगकर्ता रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)। ACTIVE डिफ़ॉल्ट है, FLAGGED उपयोगकर्ता को मैन्युअल ध्यान के लिए चिह्नित करता है, BLOCKED इस vendor_data के लिए नए सत्रों को रोकता है।
ACTIVE, FLAGGED, BLOCKED उपयोगकर्ता की पोर्ट्रेट फ़ोटो का प्री-साइन किया गया URL (कुछ घंटों के बाद समाप्त हो जाता है)
इस उपयोगकर्ता के लिए सत्यापन सत्रों की कुल संख्या
स्वीकृत सत्रों की संख्या
अस्वीकृत सत्रों की संख्या
समीक्षाधीन सत्रों की संख्या
इस उपयोगकर्ता के स्वीकृत ID दस्तावेज़ों पर देखे गए जारीकर्ता देशों के ISO 3166-1 alpha-3 कोड, उदा. ["USA", "ESP"]। कोई न होने पर खाली ऐरे।
इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित ईमेल पते, उदा. ["john@example.com"]।
इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित फ़ोन नंबर, उदा. ["+14155551234"]।
इस उपयोगकर्ता के सभी सत्रों में प्रति-सुविधा एकत्रित स्थिति। संभावित कुंजियाँ: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION। संभावित मान: Approved, Declined, In Review, Not Finished, Resub Requested।
features जैसा ही डेटा, {feature, status} ऑब्जेक्ट्स के एक क्रमबद्ध ऐरे के रूप में।
Show child attributes
Show child attributes
सबसे हाल के सत्र का टाइमस्टैम्प
पहले सत्र का टाइमस्टैम्प
इस उपयोगकर्ता की सबसे हाल की गतिविधि का टाइमस्टैम्प (सत्र, लेन-देन, स्थिति परिवर्तन, डेटा संपादन, आदि)।
टैग असाइनमेंट। ध्यान दें: विवरण रिस्पॉन्स पर प्रत्येक प्रविष्टि एक टैग लिंक ऑब्जेक्ट ({uuid, tag: {...}, added_by_email, added_by_name, created_at}) होती है, जो सूची रिस्पॉन्स पर उपयोग किए जाने वाले फ़्लैट {uuid, name, color} आकार से भिन्न है।
Show child attributes
Show child attributes
कस्टम मेटाडेटा JSON जिसे आपने इस उपयोगकर्ता से जोड़ा है। डिफ़ॉल्ट {} है।
इस उपयोगकर्ता के लिए गतिविधि लॉग और टिप्पणियाँ (स्थिति परिवर्तन, प्रोफ़ाइल संपादन, मैन्युअल नोट्स)।
Show child attributes
Show child attributes