डेवलपर

GET/v3/documents

पंजीकरण प्रोफ़ाइलों की सूची प्राप्त करें

पुराने प्रारूप के सीमित फ़ील्ड चयन का उपयोग करके खाते की सक्रिय स्थानीय प्रोफ़ाइलें खोजें।

इस पृष्ठ पर
  1. मौजूदा पंजीकरण प्रोफ़ाइलें खोजें
  2. सूची प्राप्त करने का अनुरोध
  3. प्रतिक्रिया की सूची
  4. लौटाए गए प्रोफ़ाइल फ़ील्ड
  5. अगले चरण

मौजूदा पंजीकरण प्रोफ़ाइलें खोजें

अपने API खाते से जुड़ी उन सक्रिय स्थानीय पंजीकरण प्रोफ़ाइलों की सूची प्राप्त करें जिन्हें हटाया नहीं गया है। किसी प्रोफ़ाइल को खोलने से पहले उसका UUID खोजने के लिए इस सूची का उपयोग करें। उसे खोलने का फ़ंक्शन है get_document। इस सूची का उपयोग यह निर्धारित करने के लिए न करें कि उसके प्रमाणों या नंबर के पंजीकरण को मंज़ूरी मिली थी या नहीं।

सूची प्राप्त करने का अनुरोध

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/documents

इस हैंडलर में अनुरोध बॉडी, पृष्ठांकन या फ़िल्टर पैरामीटर लागू नहीं किए गए हैं। यह संबंधित खाते की संग्रहीत प्रोफ़ाइलें लौटाता है; किसी विशेष क्रम की अपेक्षा न करें। बड़े खातों के लिए बार-बार पूरी सूची माँगने से बचें।

प्रतिक्रिया की सूची

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

कोई मेल खाती सक्रिय प्रोफ़ाइल न होने पर हैंडलर API कोड 200 और प्रतिक्रिया में एक खाली सूची लौटाता है। response[].id स्थानीय प्रोफ़ाइल का UUID है, जो बनाते समय uuid के रूप में लौटाया जाता है; यह पहचान का ID या पते का ID नहीं है।

लौटाए गए प्रोफ़ाइल फ़ील्ड

इस फ़ील्ड चयन में शामिल हैं: id, first_name, last_name, phone_number, id_number, birth_date, company_name, company_reg_number, vat_id, personal_tax_id, description, identity_type, postal_code, city, address, signature और date_created।

संग्रहीत डेटा के अनुसार वैकल्पिक मान खाली या null हो सकते हैं। पुराने प्रारूप के इस फ़ील्ड चयन में email, देश चुनने वाले फ़ील्ड, identity_id, address_id, अपलोड की गई फ़ाइलों के संदर्भ, प्रमाणों की सूचियाँ और सत्यापन की स्थिति शामिल नहीं हैं। यह प्रमाणों की स्थिति या पंजीकरण की मंज़ूरी जानने का एंडपॉइंट नहीं है। लौटाए गए पहचान, संपर्क और हस्ताक्षर संबंधी डेटा को निजी मानें।

अगले चरण

बाद में संलग्न करने के लिए इकाइयों के ID सहेजें। ये ID मूल create_document प्रतिक्रिया से लें। यदि वह प्रतिक्रिया खो गई थी, तो इस सूची से उन ID को वापस प्राप्त नहीं किया जा सकता। प्रोफ़ाइल यहाँ देखें: पोर्टल या अपने-आप डुप्लिकेट प्रोफ़ाइल बनाने के बजाय सहायता टीम से संपर्क करें।