प्रोसेस बनाएंPOST

अपने बैकएंड से एक Human Token प्रोसेस बनाएं और data.humanToken में humanToken प्राप्त करें।

Markdown

Human Token, Human API के POST /client/v1/process endpoint पर चलता है। API Only flows (api+humantoken, api+liveness+humantoken और api+liveness+humantoken+revalidation) के साथ, प्रोसेस एक ही कॉल में बनाई और पूरी की जाती है: रिस्पॉन्स में परिणाम पहले से ही data.humanToken में मौजूद होता है। Human Token Journey flows (humantoken और humantoken+revalidation) के साथ, रिस्पॉन्स में प्रोसेस का id, एक token और जर्नी का link होता है, और यूज़र के जर्नी पूरी करने के बाद परिणाम उपलब्ध होता है। +revalidation flows के लिए पुनर्सत्यापन हेतु पहले प्राप्त किए गए humanToken के साथ एक references array आवश्यक है।

Flows

Human Token दो इंटीग्रेशन मॉडल में चलता है:

• API Only — आपका बैकएंड सेल्फी को imageBase64 में भेजता है।
• Human Token Journey — यूज़र Web पर Unico जर्नी से गुज़रता है और आपके callbackUri पर वापस लौटता है।

Flow	Capabilities	Possible result	Integration components required	Example
api+humantoken	Human Token	PROCESS_STATE_FINISHEDPROCESS_STATE_FAILED	API
api+liveness+humantoken	LivenessHuman Token	PROCESS_STATE_FINISHEDPROCESS_STATE_FAILED	API
api+liveness+humantoken+revalidation	LivenessHuman TokenRevalidation	PROCESS_STATE_FINISHEDPROCESS_STATE_FAILED	API
humantoken	LivenessHuman Token	PROCESS_STATE_CREATEDPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDPROCESS_STATE_CANCELED	APIWeb
humantoken+revalidation	LivenessHuman TokenRevalidation	PROCESS_STATE_CREATEDPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDPROCESS_STATE_CANCELED	APIWeb

Endpoint

एनवायरनमेंट	URL
प्रोडक्शन	POST https://humantoken.unico.app/client/v1/process

रिक्वेस्ट

हेडर

Header	मान
x-unico-accesskey	<your_access_key> (देखें ऑथेंटिकेशन)
Content-Type	application/json

बॉडी पैरामीटर

फ़ील्ड	प्रकार	आवश्यक	विवरण
flow	string	हाँ	Human Token flow: api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation (API Only) या humantoken, humantoken+revalidation (Human Token Journey)। देखें Flows।
imageBase64	string	API Only	सेल्फी, जिसे आपका फ्रंटएंड कैप्चर करता है और सीधे base64 में भेजता है। PNG, JPEG या WebP, अधिकतम 800 KB। Capture Standard का पालन करें।
callbackUri	string	Human Token Journey	वह URL जिस पर जर्नी खत्म होने के बाद यूज़र को रीडायरेक्ट किया जाता है।
companyBranchId	string	नहीं	ब्रांच पहचानकर्ता। जब प्रदान किया जाता है, तो प्रक्रिया निर्दिष्ट ब्रांच की कॉन्फ़िगरेशन का उपयोग करती है।
references	array	पुनर्सत्यापन flows	संदर्भ ऑब्जेक्ट का array। +revalidation flows के लिए आवश्यक। प्रत्येक ऑब्जेक्ट में referenceType (REFERENCE_TYPE_HUMAN_TOKEN) और referenceContent (पहले प्राप्त किया गया humanToken मान) होता है।

रिस्पॉन्स

200 OK

फ़ील्ड	प्रकार	विवरण
id	string (UUID)	प्रोसेस आइडेंटिफ़ायर। प्रोसेस प्राप्त करें के ज़रिए प्रोसेस को दोबारा प्राप्त करने के लिए इसका उपयोग करें।
state	string	प्रोसेस की स्थिति — देखें परिणाम की व्याख्या। केवल API Only flows में।
token	string	बनाई गई प्रक्रिया का टोकन, आप इसका उपयोग Journey SDK अनुभव खोलने के लिए कर सकते हैं। केवल Human Token Journey प्रवाहों (humantoken, humantoken+revalidation) में।
link	string	Human Token Journey का URL: यूज़र को इस पर भेजें। केवल Human Token Journey flows (humantoken, humantoken+revalidation) में।
data.​humanToken.​value	string	चेहरे का स्थिर, अपारदर्शी आइडेंटिफ़ायर (100 वर्णों तक)। एक ही व्यक्ति हमेशा एक ही मान पर resolve होता है। केवल API Only flows में (बिना पुनर्सत्यापन के)।
data.​humanTokenMatch	string	"true" यदि सेल्फी संदर्भित humanToken से मेल खाती है, अन्यथा "false"। केवल +revalidation API Only flow में।

परिणाम की व्याख्या

state	अर्थ	क्या करें
PROCESS_STATE_FINISHED	data.humanToken.value भरा हुआ: Human Token के साथ वास्तविक व्यक्ति।	अपने रिकॉर्ड में value खोजें: अगर यह मौजूद है, तो यह लौटकर आया यूज़र या संभावित डुप्लिकेट है; अगर नहीं, तो यह एक नया व्यक्ति है।
PROCESS_STATE_FINISHED	data.humanToken नहीं है, या value खाली है: अनिर्णायक।	इसे अनिर्णायक मानें। खाली value को कभी स्टोर या मैच न करें; अपने बिज़नेस नियमों के अनुसार प्रोसेस दोबारा चलाएँ या अस्वीकार करें।
PROCESS_STATE_FAILED	पहचान प्रोसेस विफल हुई।	अपने बिज़नेस नियमों के अनुसार प्रोसेस दोबारा करें या अस्वीकार करें।
PROCESS_STATE_CREATED	प्रोसेस बनाई गई।	प्रतीक्षा करें। बाद में प्रोसेस प्राप्त करें से परिणाम प्राप्त करें।
PROCESS_STATE_CANCELED	प्रोसेस रद्द कर दी गई।	अगर यूज़र को अभी भी सत्यापित करना ज़रूरी है, तो नई प्रोसेस बनाएँ।

चेतावनी

data.humanToken.value का उपयोग करने से पहले हमेशा जाँचें कि यह खाली नहीं है।

एरर कोड

नोट

x-unico-accesskey हेडर में access key अनुपस्थित या अमान्य होने पर लौटाए जाने वाले HTTP status की अभी पुष्टि की जा रही है। देखें ऑथेंटिकेशन।

400 Bad Request

कोड	Message	विवरण
3	invalid flow	जब निर्दिष्ट flow मौजूद नहीं होता।
3	INVALID_IMAGE	जब छवि वैध base64 नहीं होती, या इंजेक्शन प्रयास जैसी दिखती है।
3	IMAGE_TOO_LARGE	जब छवि 800 KB के अधिकतम आकार से अधिक होती है।
3	UNSUPPORTED_IMAGE_FORMAT	जब छवि का फ़ॉर्मेट PNG, JPEG या WebP नहीं होता।
3	MISSING_IMAGE	जब इस flow के लिए छवि आवश्यक है और भेजी नहीं गई।
3	INVALID_REQUEST	जब रिक्वेस्ट बॉडी null होती है या उसकी व्याख्या नहीं की जा सकती।
9	monthly process limit of <monthly_limit> reached for this tenant	जब मासिक उपयोग सीमा पूरी हो गई हो।
9	PROCESS_FAILED	जब प्रोसेस बनाए जाते समय एक अंतिम विफलता पर पहुँच गई।

403 Forbidden

कोड	Message	विवरण
7	PERMISSION_DENIED	जब क्रेडेंशियल वैध हैं लेकिन इस कार्रवाई के लिए अधिकृत नहीं हैं।

429 Too Many Requests

रेट लिमिट पूरी हो गई। जब आपका सिस्टम HTTP 429 त्रुटि प्राप्त करता है, तो आपको कैस्केडिंग विफलताओं को रोकने और प्रतिबंध को बढ़ने से बचाने के लिए तंत्र लागू करने होंगे।

सर्वोत्तम प्रथाएं:

• कूल-डाउन अवधि (backoff): अपने सिस्टम से आने वाले बाद के अनुरोधों को तुरंत रोकें या कम करें। विफल अनुरोधों को लगातार एक तंग लूप में पुनः प्रयास न करें।
• कतार और थ्रॉटलिंग (Queueing & throttling): ट्रैफ़िक प्रवाह को नियंत्रित करने के लिए अपनी तरफ से आउटगोइंग अनुरोधों को बफ़र या कतार में रखें और फिर उन्हें पुनः भेजें।
• एक्सपोनेंशियल बैकऑफ़ विद जिटर (Exponential backoff with jitter): पुनः प्रयास करते समय, प्रयासों के बीच प्रतीक्षा समय को तेजी से बढ़ाएं (उदा., 1 s, 2 s, 4 s, 8 s) और एक छोटा यादृच्छिक विलंब ("jitter") जोड़ें ताकि हर्ड इफ़ेक्ट से बचा जा सके जहां सभी कतार में रखे गए अनुरोध ठीक उसी मिलीसेकंड पर पुनः प्रयास करते हैं।

चेतावनी

बैकऑफ़ लागू किए बिना रेट-लिमिटेड एंडपॉइंट को लगातार हिट करना प्रतिबंध अवधि को बढ़ा सकता है और आपके सिस्टम के परिचालन थ्रूपुट को गंभीर रूप से प्रभावित कर सकता है। अपनी तरफ से अनुरोधों को ठीक से थ्रॉटल करना एक सहज और अधिक लचीला एकीकरण सुनिश्चित करता है।

डिफ़ॉल्ट सीमाओं, अनुरोध बढ़ाने और अतिरिक्त विवरण के लिए, देखें रेट लिमिट।

500 Internal Server Error

कोड	Message	विवरण
13	Internal failure! Try again later	जब कोई आंतरिक त्रुटि होती है।

इस endpoint के कोड की पूरी सूची के लिए, Human API का प्रोसेस बनाएं संदर्भ देखें।

आगे क्या

• बाद के Human Token कॉल पर उसी व्यक्ति को पहचानने के लिए humanToken मान को अपने यूज़र रिकॉर्ड के साथ संग्रहीत करें।
• ऑडिट या सपोर्ट के लिए प्रोसेस को दोबारा प्राप्त करने हेतु, प्रोसेस प्राप्त करें का उपयोग करें।