डेवलपर

POST/v3/create_encrypt_files

पंजीकरण के प्रमाण की फ़ाइलें अपलोड करें

पहचान/पते के प्रमाण या सहायक दस्तावेज़ के टेम्पलेट के लिए फ़ाइलें अपलोड करें, फिर लौटाए गए अल्पकालिक संदर्भों को संलग्न करें।

इस पृष्ठ पर
  1. संलग्न करने से पहले अपलोड करें
  2. अपलोड अनुरोध
  3. फ़ाइलों की सीमाएँ
  4. लौटाई गई हर फ़ाइल की जाँच करें
  5. तुरंत संलग्न करें
  6. त्रुटियाँ और पुनः प्रयास

संलग्न करने से पहले अपलोड करें

किसी एक प्रमाण या सहायक दस्तावेज़ की श्रेणी की फ़ाइलें अपलोड करें, फिर लौटाए गए फ़ाइल ID संलग्न करने के लिए create_proof या create_supporting_document का उपयोग करें। केवल अपलोड करने से पहचान, पता या प्रमाण का रिकॉर्ड नहीं बनता और न ही नंबर का पंजीकरण पूरा होता है। शुरुआत के लिए वर्तमान आवश्यकताओं और कैटलॉग के ID का उपयोग करें।

ठीक एक चयनकर्ता दें: proof_type_id पहचान/पते के प्रमाण के लिए, या supporting_template_id सहायक दस्तावेज़ के लिए। दोनों न भेजें। संबंधित MultiTEL कैटलॉग से लौटाए गए ID का उपयोग करें; इन्हें ऐसे पहचानकर्ता मानें जिनकी आंतरिक संरचना से कोई अर्थ नहीं निकाला जाना चाहिए।

अपलोड अनुरोध

सक्रिय MultiTEL API खाते और उसके लिए अनुमत IP पते का उपयोग करें। उदाहरणों में परिवेश चरों से लिए गए HTTP Basic क्रेडेंशियल का उपयोग किया गया है; अपने खाते के प्रकार के लिए लागू प्रमाणीकरण पद्धति का पालन करें। अनुरोध HTTPS पर भेजें। HTTP प्रतिक्रिया के साथ-साथ JSON में दिए गए इस फ़ील्ड की भी जाँच करें: status.code; एप्लिकेशन की त्रुटियाँ HTTP 200 के साथ भी आ सकती हैं। नीचे दिए गए उदाहरण काल्पनिक हैं।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string "proof_type_id=$PROOF_TYPE_ID" \
  --form-string 'description=Identity proof' \
  --form 'files[0]=@./identity-proof.pdf' \
  https://api.multitel.net/v3/create_encrypt_files
अनुरोध के फ़ील्ड
फ़ील्डअर्थ
files[0] … files[4]एक से पाँच अपलोड की गई फ़ाइलें। मल्टीपार्ट फ़ॉर्म डेटा का उपयोग करें और curl को उसकी Content-Type बाउंड्री बनाने दें। इन फ़ील्ड में फ़ाइल के बाइट होते हैं, URL या JSON Base64 नहीं।
proof_type_idप्रमाण अपलोड करने के लिए आवश्यक है; लौटाए गए इस पहचानकर्ता का उपयोग करें: प्रमाण के प्रकार का ID। supporting_template_id न भेजें।
supporting_template_idसहायक फ़ाइलों के लिए proof_type_id के बजाय यह आवश्यक है; लौटाए गए इस पहचानकर्ता का उपयोग करें: टेम्पलेट का ID।
descriptionअनुरोध भेजने वाले द्वारा दिया जाने वाला वैकल्पिक विवरण, अधिकतम 100 वर्ण। सहायक दस्तावेज़ अपलोड करते समय विवरण न दिए जाने पर टेम्पलेट का नाम इस्तेमाल किया जा सकता है।

फ़ाइलों की सीमाएँ

यह हैंडलर अधिकतम पाँच फ़ाइलें स्वीकार करता है, जिनका कुल आकार 20,000,000 बाइट से अधिक नहीं होना चाहिए। यह दशमलव पद्धति में बाइट की सीमा है, 20 MiB नहीं। बुनियादी ढाँचे या MIME सत्यापन के कारण अतिरिक्त सीमाएँ लागू हो सकती हैं।

अनुमत फ़ाइल एक्सटेंशन हैं: pdf, png, jpg, jpeg, gif, tiff, bmp, doc, docx, xls, xlsx, txt, rtf और csv। किसी फ़ाइल का एक्सटेंशन अनुमत होने से यह सिद्ध नहीं होता कि वह चुनी गई पंजीकरण आवश्यकता को पूरा करती है। विशेष रूप से, tif इस अनुमत सूची में शामिल नहीं है।

लौटाई गई हर फ़ाइल की जाँच करें

{
  "status": {
    "code": 200,
    "msg": "Encrypt file has been created successfully"
  },
  "response": {
    "entity_type": "identities",
    "document_category": "proof",
    "proof_type": "11111111111111111111111111111111",
    "ids": [
      {
        "id": "22222222222222222222222222222222",
        "name": "identity-proof.pdf",
        "expired_at": "2026-10-23 16:20:00"
      }
    ]
  }
}

हर response.ids[].id को संलग्न करने के अनुरोध के लिए सुरक्षित रखें। name लौटाई गई मूल फ़ाइल का नाम बताता है। अलग-अलग फ़ाइल नाम रखें और लौटाई गई फ़ाइलों का मिलान अपेक्षित फ़ाइलों के समूह से करें: कोड 200 आंशिक रूप से सफल बैच को भी दर्शा सकता है। ऐसा समूह संलग्न न करें जिसमें आवश्यक फ़ाइलें गायब हों।

entity_type का मान identities या addresses होता है जब अपलोड प्रमाण के लिए हो, और supporting_documents होता है जब अपलोड सहायक दस्तावेज़ के लिए हो। document_category का मान है: proof या supporting। सामान्य नाम वाला proof_type प्रतिक्रिया फ़ील्ड सहायक दस्तावेज़ों के अपलोड के लिए टेम्पलेट का संदर्भ भी रखता है; संलग्न करने के लिए अपना मूल supporting_template_id सुरक्षित रखें।

तुरंत संलग्न करें

सेवा, अपलोड की गई फ़ाइल को स्थानीय रूप से संग्रहीत करने के लगभग 20 मिनट बाद का समाप्ति समय निर्धारित करती है। संलग्न करते समय जाँच होती है कि फ़ाइल उसी खाते की है, उसे समयसीमा समाप्त के रूप में चिह्नित नहीं किया गया है, उसका समाप्ति समय अभी नहीं आया है और उसकी इकाई श्रेणी सही है। expired_at में इस प्रतिक्रिया के भीतर समय क्षेत्र का ऑफ़सेट नहीं दिया गया है; इसे UTC न मानें। समाप्ति समय के आसपास काम निर्धारित करने के बजाय तुरंत संलग्न करें।

अपलोड संदर्भ का समाप्ति समय इस बात की गारंटी नहीं है कि उस समय दस्तावेज़ की सभी संग्रहीत प्रतियाँ मिटा दी जाएँगी। सेवा दूरसंचार प्रदाता को अपलोड करने के लिए फ़ाइलों को एन्क्रिप्ट करती है और दस्तावेज़ कार्यप्रवाह के लिए मूल बाइट सुरक्षित रखती है; इसे केवल क्लाइंट पर होने वाला एन्क्रिप्शन या डेटा संग्रहीत न रखने वाली सेवा न मानें। ID, फ़ाइल नाम और प्रतिक्रियाएँ सार्वजनिक लॉग में न रखें।

त्रुटियाँ और पुनः प्रयास

वर्तमान हैंडलर दस्तावेज़ की कोई फ़ाइल न दिए जाने पर API कोड 404 का उपयोग करता है। विवरण के सत्यापन, चयनकर्ता गायब होने या उनमें टकराव होने, प्रमाण/टेम्पलेट के अमान्य ID, फ़ाइल संख्या या कुल आकार की सीमा, भंडारण संबंधी समस्याओं या अपलोड विफल होने की स्थिति में कोड 500 का उपयोग करता है। यह फ़ील्ड पढ़ें: status.msg; अमान्य इनपुट को हमेशा कोड 400 से नहीं दर्शाया जाता।

यहाँ क्लाइंट की ओर से दी जाने वाली कोई इडेम्पोटेंसी कुंजी उपलब्ध नहीं है। यदि प्रतिक्रिया खो जाए, तो अपलोड दोहराने से पहले दस्तावेज़ कार्यप्रवाह की जाँच करें; दूसरा अनुरोध नए फ़ाइल संदर्भ बना सकता है। इन उदाहरणों को ग्राहकों के पहचान दस्तावेज़ों पर चलाकर नहीं देखा गया है।