प्रक्रिया दस्तावेज़ सेट करें

उस प्रक्रिया पर पहचान दस्तावेज़ (CPF, CURP, SSN या अन्य duiType) सेट करता है जो बिना दस्तावेज़ के बनाई गई थी। एक बार सेट होने के बाद, दस्तावेज़ अपरिवर्तनीय होता है।

केवल उन प्रक्रियाओं के लिए उपलब्ध जिनका Custom Flow बिना दस्तावेज़ के निर्माण की अनुमति देता है — यानी, AWAITING_FOR_DOCUMENT स्थिति में प्रक्रियाएं।

एंडपॉइंट

वातावरण	URL
प्रोडक्शन	POST https://api.idcloud.unico.app/client/v1/process/{processId}/document
सैंडबॉक्स	POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

अनुरोध

हेडर

हेडर	मान
Authorization	Bearer <access_token> (देखें Authentication)
Content-Type	application/json

पाथ पैरामीटर

फ़ील्ड	प्रकार	आवश्यक	विवरण
processId	string	हाँ	निर्माण के समय process.id में लौटाया गया प्रक्रिया ID।

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

फ़ील्ड	प्रकार	आवश्यक	विवरण
duiType	enum	हाँ	दस्तावेज़ प्रकार। मान: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN। यह एंडपॉइंट Create Process द्वारा स्वीकृत दस्तावेज़ प्रकारों के एक उपसमूह का समर्थन करता है — Custom Flows जो वैकल्पिक दस्तावेज़ निर्माण की अनुमति देते हैं, वर्तमान में इस संकीर्ण सूची के विरुद्ध मान्य किए जाते हैं।
duiValue	string	हाँ	दस्तावेज़ संख्या, फ़ॉर्मेटिंग के बिना। अधिकतम 320 वर्ण (एन्कोडेड या मिश्रित पहचानकर्ताओं को समायोजित करता है; CPF या CURP जैसे मानक दस्तावेज़ संख्याएं काफी छोटी होती हैं)।

उदाहरण

cURL

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

Node.js

import fetch from 'node-fetch';

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

const { process: proc } = await res.json();
// proc.id, proc.person.duiType, proc.person.duiValue

प्रतिक्रियाएं

200 OK

{
  "process": {
    "id": "abc-123",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678901"
    }
  }
}

फ़ील्ड	प्रकार	विवरण
process.id	string	प्रक्रिया पहचानकर्ता।
process.person.duiType	string	प्रक्रिया पर सेट किया गया दस्तावेज़ प्रकार।
process.person.duiValue	string	प्रक्रिया पर सेट किया गया दस्तावेज़ मान।

त्रुटि कोड

400 Bad Request

कोड	संदेश	विवरण
3	process id is invalid	जब प्रक्रिया ID अमान्य हो।
3	dui_type is required	जब दस्तावेज़ प्रकार प्रदान नहीं किया गया हो।
3	dui_value is required	जब दस्तावेज़ संख्या प्रदान नहीं की गई हो।
3	dui_value exceeds maximum length	जब दस्तावेज़ संख्या अधिकतम वर्ण सीमा से अधिक हो।
9	process is not awaiting for document	जब निर्दिष्ट प्रक्रिया दस्तावेज़ सबमिशन स्वीकार नहीं करती।
9	process expired	जब निर्दिष्ट प्रक्रिया की समय-सीमा समाप्त हो गई हो।
9	document already set, cannot be modified	जब प्रक्रिया में पहले से कोई दस्तावेज़ लिंक हो।
9	process already finished	जब प्रक्रिया पहले से पूरी हो चुकी हो।
9	flow does not allow optional document	जब प्रक्रिया द्वारा निष्पादित फ्लो के लिए दस्तावेज़ अनिवार्य हो।

401 Unauthorized

Bearer टोकन अनुपस्थित, समाप्त, या अमान्य। देखें Authentication।

संदेश	विवरण
Jwt header is an invalid JSON	जब उपयोग किए गए एक्सेस टोकन में गलत वर्ण हों।
Jwt is expired	जब उपयोग किया गया एक्सेस टोकन समाप्त हो गया हो।

404 Not Found

कोड	संदेश	विवरण
5	error getting process: rpc error: code = NotFound desc = process not found	जब प्रक्रिया ID नहीं मिली।

429 Too Many Requests

दर सीमा पहुँच गई। कोई विस्तृत त्रुटि कोड उपलब्ध नहीं — केवल HTTP स्थिति कोड।

500 Internal Server Error

कोड	संदेश	विवरण
99999	Internal failure! Try again later	जब कोई आंतरिक त्रुटि हो।

आगे क्या

• दस्तावेज़ सेट करने के बाद, प्रक्रिया अपनी pipeline जारी रखती है। परिणाम प्राप्त करने के लिए Get Process कॉल करें, या webhook की प्रतीक्षा करें।