प्रोसेस दस्तावेज़ सेट करेंPOST

बिना दस्तावेज़ के एक प्रोसेस बनाएँ, यूज़र को कैप्चर पूरा करने दें, फिर अपने बैकएंड से दस्तावेज़ भेजें। इसके बाद प्रोसेस पूरी हो जाती है।

MarkdownChatGPTClaude

लाइफ़साइकिल

1. आपका बैकएंड प्रोसेस बनाएं के ज़रिए person.duiType और person.duiValue के बिना प्रोसेस बनाता है। Flow को वैकल्पिक दस्तावेज़ की अनुमति देनी चाहिए। प्रोसेस PROCESS_STATE_CREATED स्थिति में शुरू होती है।
2. यूज़र जर्नी चलाता है और कैप्चर करता है।
3. Unico API प्रोसेस को AWAITING_FOR_DOCUMENT में ले जाती है, यह वह स्थिति है जो प्रोसेस प्राप्त करें तब लौटाता है जब प्रोसेस दस्तावेज़ की प्रतीक्षा कर रही होती है। आप उन क्षमताओं के आंशिक रिज़ल्ट पहले से पढ़ सकते हैं जो duiValue पर निर्भर नहीं करतीं।
4. आपका बैकएंड URL में प्रोसेस ID और बॉडी में दस्तावेज़ के साथ इस एंडपॉइंट को कॉल करता है। इसके बाद Unico API प्रोसेस को पूरा करती है, और वह PROCESS_STATE_FINISHED में चली जाती है।

रिस्पॉन्स में अंतिम रिज़ल्ट नहीं होता

अंतिम स्थिति और रिज़ल्ट प्रोसेस प्राप्त करें से पढ़ें, या webhook की प्रतीक्षा करें।

एंडपॉइंट

एनवायरनमेंट	URL
Production	POST https://api.idcloud.unico.app/client/v1/process/{processId}/document
Sandbox	POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

रिक्वेस्ट

हेडर

हेडर	वैल्यू
Authorization	Bearer <access_token> (देखें प्रमाणीकरण)
Content-Type	application/json

क्रेडेंशियल्स के पास वही अनुमति होनी चाहिए जिसका उपयोग प्रोसेस बनाएं को कॉल करने के लिए किया जाता है।

पाथ पैरामीटर

पैरामीटर	टाइप	आवश्यक	विवरण
processId	string (UUID)	हाँ	प्रोसेस बनाएं द्वारा लौटाया गया प्रोसेस आइडेंटिफ़ायर।

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

फ़ील्ड	टाइप	आवश्यक	विवरण
duiType	enum	हाँ	दस्तावेज़ का प्रकार। DUI_TYPE_UNSPECIFIED अस्वीकार कर दिया जाता है। नीचे duiType वैल्यू देखें।
duiValue	string	हाँ	दस्तावेज़ संख्या, बिना फ़ॉर्मेटिंग के। अधिकतम 320 वर्ण।

duiType मान

देश	मान	विवरण
AR	DUI_TYPE_AR_PASSPORT	अर्जेंटीना पासपोर्ट
AR	DUI_TYPE_AR_DNI	अर्जेंटीना DNI
AR	DUI_TYPE_AR_LNC	अर्जेंटीना ड्राइविंग लाइसेंस (Licencia Nacional de Conducir)
AT	DUI_TYPE_AT_STNR	ऑस्ट्रियाई टैक्स नंबर (STNR)
BE	DUI_TYPE_BE_NN	बेल्जियन नेशनल नंबर (NN)
BR	DUI_TYPE_BR_CPF	ब्राज़ीलियाई CPF
BR	DUI_TYPE_BR_PASSPORT	ब्राज़ीलियाई पासपोर्ट
BR	DUI_TYPE_BR_CNPJ	ब्राज़ीलियाई CNPJ
CA	DUI_TYPE_CA_SIN	कनाडाई SIN
CH	DUI_TYPE_CH_AHV	स्विस AHV/AVS नंबर
CL	DUI_TYPE_CL_RUN	चिली RUN
CL	DUI_TYPE_CL_PASSPORT	चिली पासपोर्ट
CL	DUI_TYPE_CL_LICENCIA_CONDUCIR	चिली ड्राइविंग लाइसेंस (Licencia de Conducir)
CO	DUI_TYPE_CO_NIT	कोलंबियाई NIT
CO	DUI_TYPE_CO_PASSPORT	कोलंबियाई पासपोर्ट
CO	DUI_TYPE_CO_LICENCIA_CONDUCCION	कोलंबियाई ड्राइविंग लाइसेंस (Licencia de Conducción)
CO	DUI_TYPE_CO_CC	कोलंबियाई सिटिज़नशिप कार्ड (Cédula de Ciudadanía)
DE	DUI_TYPE_DE_IDNR	जर्मन टैक्स आइडेंटिफिकेशन नंबर (IdNr)
DK	DUI_TYPE_DK_CPR	डेनिश CPR
EC	DUI_TYPE_EC_NI	इक्वाडोर NI
ES	DUI_TYPE_ES_NIE	स्पैनिश फ़ॉरेनर आइडेंटिटी नंबर (NIE)
ES	DUI_TYPE_ES_DNI	स्पैनिश नेशनल आइडेंटिटी डॉक्यूमेंट (DNI)
FI	DUI_TYPE_FI_HETU	फ़िनिश पर्सनल आइडेंटिटी कोड (HETU)
FR	DUI_TYPE_FR_SPI	फ़्रेंच टैक्स रेफ़रेंस नंबर (SPI)
GB	DUI_TYPE_GB_NINO	ब्रिटिश नेशनल इंश्योरेंस नंबर (NINO)
GT	DUI_TYPE_GT_CUI	ग्वाटेमाला CUI
ID	DUI_TYPE_ID_NIK	इंडोनेशियाई NIK
IE	DUI_TYPE_IE_PPSN	आयरिश पर्सनल पब्लिक सर्विस नंबर (PPSN)
IT	DUI_TYPE_IT_CF	इटालियन Codice Fiscale (CF)
LK	DUI_TYPE_LK_NIC	श्रीलंका NIC
LU	DUI_TYPE_LU_MATRICULE	लक्ज़मबर्ग नेशनल आइडेंटिफिकेशन नंबर (Matricule)
MX	DUI_TYPE_MX_CURP	मैक्सिकन CURP
MX	DUI_TYPE_MX_RFC_PERSONA_FISICA	मैक्सिकन RFC (Persona Física)
MX	DUI_TYPE_MX_LICENCIA_CONDUCIR	मैक्सिकन ड्राइविंग लाइसेंस (Licencia de Conducir)
NG	DUI_TYPE_NG_NIN	नाइजीरियाई NIN
NG	DUI_TYPE_NG_BVN	नाइजीरियाई बैंक सत्यापन संख्या (BVN)
NG	DUI_TYPE_NG_BVN_TOKEN	नाइजीरियाई BVN टोकन (hashed)
NG	DUI_TYPE_NG_NIN_TOKEN	नाइजीरियाई NIN टोकन (hashed)
NL	DUI_TYPE_NL_BSN	डच सिटीज़न सर्विस नंबर (BSN)
NO	DUI_TYPE_NO_FNR	नॉर्वेजियन नेशनल आइडेंटिटी नंबर (Fødselsnummer)
PE	DUI_TYPE_PE_RUC	पेरू RUC
PE	DUI_TYPE_PE_DNI	पेरू DNI
PE	DUI_TYPE_PE_PASSPORT	पेरू पासपोर्ट
PL	DUI_TYPE_PL_PESEL	पोलिश PESEL
PT	DUI_TYPE_PT_NIF	पुर्तगाली टैक्स आइडेंटिफिकेशन नंबर (NIF)
SE	DUI_TYPE_SE_PNR	स्वीडिश पर्सनल नंबर (PNR)
SE	DUI_TYPE_SE_SAMORDNINGSNUMMER	स्वीडिश कोऑर्डिनेशन नंबर (Samordningsnummer)
TR	DUI_TYPE_TR_TCKN	तुर्की पहचान संख्या (TCKN)
US	DUI_TYPE_US_SSN	संयुक्त राज्य अमेरिका SSN
US	DUI_TYPE_US_PASSPORT	संयुक्त राज्य अमेरिका पासपोर्ट
US	DUI_TYPE_US_DRIVER_LICENSE	संयुक्त राज्य अमेरिका ड्राइविंग लाइसेंस
US	DUI_TYPE_US_PASSPORT_CARD	संयुक्त राज्य अमेरिका पासपोर्ट कार्ड
US	DUI_TYPE_US_POLYCARBONATE_PASSPORT	संयुक्त राज्य अमेरिका पॉलीकार्बोनेट पासपोर्ट
US	DUI_TYPE_US_ID_CARD	संयुक्त राज्य अमेरिका आईडी कार्ड
UY	DUI_TYPE_UY_CI	उरुग्वे CI
ZZ	DUI_TYPE_ZZ_EMAIL	ईमेल पता
ZZ	DUI_TYPE_ZZ_PHONE_NUMBER	फ़ोन नंबर

कॉल कब स्वीकार की जाती है

• प्रोसेस AWAITING_FOR_DOCUMENT में है: यूज़र ने कैप्चर पहले ही पूरा कर लिया है।
• प्रोसेस की अवधि समाप्त नहीं हुई है।
• Flow वैकल्पिक दस्तावेज़ की अनुमति देता है।

दस्तावेज़ अपरिवर्तनीय है। दूसरी कॉल विफल हो जाती है, क्योंकि प्रोसेस अब दस्तावेज़ की प्रतीक्षा नहीं कर रही होती।

उदाहरण

cURL

curl -X POST https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/document \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "12345678909"
  }'

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.idcloud.unico.app/client/v1/process/${processId}/document`,
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${accessToken}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      duiType: 'DUI_TYPE_BR_CPF',
      duiValue: '12345678909',
    }),
  }
);
const { processId: id, duiType, duiValue } = await res.json();

रिस्पॉन्स

200 OK

{
  "processId": "3116552c-6a3e-4c1f-9d2b-8f0e7a5b4c21",
  "duiType": "DUI_TYPE_BR_CPF",
  "duiValue": "12345678909"
}

फ़ील्ड	टाइप	विवरण
processId	string (UUID)	प्रोसेस आइडेंटिफ़ायर।
duiType	enum	प्रोसेस के लिए रजिस्टर किया गया दस्तावेज़ प्रकार।
duiValue	string	प्रोसेस के लिए रजिस्टर की गई दस्तावेज़ संख्या।

उदाहरण की वैल्यू केवल प्लेसहोल्डर हैं।

त्रुटि कोड

400 Bad Request

कोड	विवरण
3	processId मौजूद नहीं है या अमान्य है, duiType निर्दिष्ट नहीं है, या duiValue खाली है या 320 वर्णों से लंबा है।
9	प्रोसेस दस्तावेज़ की प्रतीक्षा नहीं कर रही है (इसमें पहले से सेट किया गया दस्तावेज़ भी शामिल है), उसकी अवधि समाप्त हो गई है या वह पूरी हो चुकी है, या flow वैकल्पिक दस्तावेज़ की अनुमति नहीं देता।

401 Unauthorized

कोड	मैसेज	विवरण
—	Jwt header is an invalid JSON	जब इस्तेमाल किए गए access token में गलत वर्ण मौजूद हों।
—	Jwt is expired	जब इस्तेमाल किया गया access token एक्सपायर हो गया हो।

403 Forbidden

कोड	विवरण
7	क्रेडेंशियल्स के पास प्रोसेस बनाएं के लिए आवश्यक अनुमति नहीं है।

404 Not Found

कोड	विवरण
5	प्रोसेस मौजूद नहीं है, या आपकी कंपनी से संबंधित नहीं है।

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

कोड	विवरण
13	दस्तावेज़ सेव नहीं किया जा सका।

नोट

दस्तावेज़ को स्टोर करने से पहले आइडेंटिटी सर्विस में रजिस्टर किया जाता है। अगर यह रजिस्ट्रेशन विफल होता है, तो कॉल उसी विफलता का स्टेटस लौटाती है।

आगे क्या

• अंतिम स्थिति और रिज़ल्ट पढ़ने के लिए, देखें प्रोसेस प्राप्त करें।
• प्रोसेस पूरी होने पर सूचना पाने के लिए, देखें Webhooks और इवेंट्स।