मुख्य सामग्री पर जाएं
PATCH
curl

अवलोकन

उपयोगकर्ता इकाई के परिवर्तनीय फ़ील्ड अपडेट करता है। उपयोगकर्ता सत्यापन (KYC) सत्रों से प्रसारित होने वाले फ़ील्ड (full_name, date_of_birth, portrait_image, कुल काउंटर, features) केवल-पठन हैं।

इसका उपयोग कब करें

  • अपना मेटाडेटा अपडेट करें: उपयोगकर्ता को किसी दूसरे स्तर में ले जाएँ, टैग बदलें, या आंतरिक नोट दर्ज करें।
  • नाम बदलें: आंतरिक-उपयोग वाले कंसोल दृश्यों के लिए बेहतर display_name सेट करें।
  • सत्यापित डेटा को ओवरराइड करें (सावधानी से): मैन्युअल ओवरराइड की अनुमति है, लेकिन वे ऑडिट ट्रेल में दर्ज होते हैं।

नोट्स

  • इस endpoint से URL में दिया गया vendor_data नहीं बदला जा सकता। यदि आपको कुंजी बदलनी है, तो नया उपयोगकर्ता बनाएँ और पुराना हटा दें।
  • changed_fields ऐरे के साथ user.data.updated webhook भेजा जाता है, ताकि उपभोक्ता कुशलतापूर्वक सिंक कर सकें।
  • यहाँ किया गया status बदलाव उपयोगकर्ता स्टेटस अपडेट करें की तरह काम करता है। यह व्यक्ति की गतिविधि में दर्ज होता है, और वैकल्पिक reason (अधिकतम 1000 अक्षर) इसकी टिप्पणी बनता है। BLOCKED स्थिति vendor_data को सिस्टम ब्लॉकलिस्ट में जोड़ देती है। user.status.updated webhook में reason शामिल नहीं होता।
  • यदि आप किसी ऐसे फ़ील्ड पर PATCH करते हैं जो इस समय किसी सत्यापित सत्र द्वारा प्रबंधित है, तो ओवरराइड स्वीकार कर लिया जाएगा, लेकिन उसे ऑडिट लॉग में चिह्नित किया जाएगा।

अनुमतियाँ

प्राथमिक सीक्रेट और पूर्ण-एक्सेस API कुंजियाँ इस endpoint को हमेशा कॉल कर सकती हैं। कस्टम एक्सेस वाली कुंजी को लोग (users) पर लिखने की अनुमति चाहिए। जो कुंजी केवल कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित है, वह इस endpoint तक नहीं पहुँच सकती। कंसोल की भूमिकाएँ और अनुमतियाँ तय करती हैं कि कोई टीम सदस्य कंसोल में क्या कर सकता है। API कुंजी के अनुरोधों के लिए इनका मूल्यांकन नहीं किया जाता।

संबंधित

प्राधिकरण

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।

पथ पैरामीटर

vendor_data
string
आवश्यक

उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (मुक्त-रूप स्ट्रिंग, UUID नहीं)।

बॉडी

application/json
full_name
string | null

उपयोगकर्ता का पूरा नाम

Maximum string length: 512
display_name
string | null

इस उपयोगकर्ता के लिए कस्टम प्रदर्शन नाम

date_of_birth
string<date> | null

YYYY-MM-DD प्रारूप में जन्म तिथि

status
enum<string>

उपयोगकर्ता जीवनचक्र स्थिति। परिवर्तन को STATUS_CHANGED गतिविधि के रूप में रिकॉर्ड किया जाता है, और BLOCKED सिस्टम ब्लॉकलिस्ट में vendor_data जोड़ता है (BLOCKED से हटने पर वह प्रविष्टि हट जाती है)।

उपलब्ध विकल्प:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

उपयोगकर्ता से जुड़ा आपका मनमाना JSON ऑब्जेक्ट। अपडेट करने पर मौजूदा मेटाडेटा को पूरी तरह से बदल देता है — यदि आप केवल कुंजियाँ जोड़ना चाहते हैं तो क्लाइंट-साइड मर्ज करें।

approved_emails
string[]

इस उपयोगकर्ता के लिए सत्यापित ईमेल पते, उदा. ["john@example.com"]। संग्रहीत सूची को पूरी तरह से बदल देता है।

approved_phones
string[]

इस उपयोगकर्ता के लिए सत्यापित फ़ोन नंबर। संग्रहीत सूची को पूरी तरह से बदल देता है।

issuing_states
string[]

जारीकर्ता देश (ISO 3166-1 alpha-3), उदाहरण के लिए ["USA"]। संग्रहीत सूची को पूरी तरह से बदल देता है।

reason
string | null

स्थिति क्यों बदली। उपयोगकर्ता की गतिविधि की स्थिति-परिवर्तन प्रविष्टि (comments[].comment, और Business Console में Activity) पर रिकॉर्ड किया जाता है, केवल तभी जब स्थिति वास्तव में बदलती है। Webhooks इसे शामिल नहीं करते हैं।

Maximum string length: 1000

प्रतिक्रिया

उपयोगकर्ता अपडेट किया गया। पूरा अपडेट किया गया उपयोगकर्ता रिकॉर्ड (Get User के समान प्रारूप) लौटाया जाता है।

पूर्ण उपयोगकर्ता विवरण। मेटाडेटा, टिप्पणियों और updated_at के साथ UserListItem का विस्तार करता है।

didit_internal_id
string<uuid>

इस उपयोगकर्ता के लिए Didit का स्थायी आंतरिक UUID।

vendor_data
string | null

इस उपयोगकर्ता के लिए आपका विशिष्ट पहचानकर्ता (सत्र बनाते समय पास किया गया)। जब कोई वेंडर पहचानकर्ता प्रदान नहीं किया गया था, तो यह null हो सकता है।

display_name
string | null

आपके द्वारा सेट किया गया कस्टम प्रदर्शन नाम

full_name
string | null

सत्यापित दस्तावेज़ों से निकाला गया पूरा नाम

date_of_birth
string<date> | null
effective_name
string | null

सर्वोत्तम उपलब्ध नाम: यदि सेट है तो display_name, अन्यथा full_name

status
enum<string>

उपयोगकर्ता रिकॉर्ड की लाइफ़साइकिल स्थिति (सत्र स्थिति नहीं)। ACTIVE डिफ़ॉल्ट है, FLAGGED उपयोगकर्ता को मैन्युअल ध्यान के लिए चिह्नित करता है, BLOCKED इस vendor_data के लिए नए सत्रों को रोकता है।

उपलब्ध विकल्प:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

उपयोगकर्ता की पोर्ट्रेट फ़ोटो का प्री-साइन किया गया URL (कुछ घंटों के बाद समाप्त हो जाता है)

session_count
integer

इस उपयोगकर्ता के लिए सत्यापन सत्रों की कुल संख्या

approved_count
integer

स्वीकृत सत्रों की संख्या

declined_count
integer

अस्वीकृत सत्रों की संख्या

in_review_count
integer

समीक्षाधीन सत्रों की संख्या

issuing_states
string[]

इस उपयोगकर्ता के स्वीकृत ID दस्तावेज़ों पर देखे गए जारीकर्ता देशों के ISO 3166-1 alpha-3 कोड, उदा. ["USA", "ESP"]। कोई न होने पर खाली ऐरे।

approved_emails
string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित ईमेल पते, उदा. ["john@example.com"]।

approved_phones
string[]

इस उपयोगकर्ता के स्वीकृत सत्रों से एकत्र किए गए सत्यापित फ़ोन नंबर, उदा. ["+14155551234"]।

features
object

इस उपयोगकर्ता के सभी सत्रों में प्रति-सुविधा एकत्रित स्थिति। संभावित कुंजियाँ: 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_list
object[]

features जैसा ही डेटा, {feature, status} ऑब्जेक्ट्स के एक क्रमबद्ध ऐरे के रूप में।

last_session_at
string<date-time> | null

सबसे हाल के सत्र का टाइमस्टैम्प

first_session_at
string<date-time> | null

पहले सत्र का टाइमस्टैम्प

last_activity_at
string<date-time> | null

इस उपयोगकर्ता की सबसे हाल की गतिविधि का टाइमस्टैम्प (सत्र, लेन-देन, स्थिति परिवर्तन, डेटा संपादन, आदि)।

tags
object[]

टैग असाइनमेंट। ध्यान दें: विवरण रिस्पॉन्स पर प्रत्येक प्रविष्टि एक टैग लिंक ऑब्जेक्ट ({uuid, tag: {...}, added_by_email, added_by_name, created_at}) होती है, जो सूची रिस्पॉन्स पर उपयोग किए जाने वाले फ़्लैट {uuid, name, color} आकार से भिन्न है।

created_at
string<date-time>
metadata
object

कस्टम मेटाडेटा JSON जिसे आपने इस उपयोगकर्ता से जोड़ा है। डिफ़ॉल्ट {} है।

comments
object[]

इस उपयोगकर्ता के लिए गतिविधि लॉग और टिप्पणियाँ (स्थिति परिवर्तन, प्रोफ़ाइल संपादन, मैन्युअल नोट्स)।

updated_at
string<date-time>
अंतिम संशोधन 7 नवंबर 2026