डेवलपर

POST/v3/update_document/{uuid}

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

प्रोफ़ाइल के संपादन योग्य विवरण पूरे भेजें और सफलता के पुराने प्रतिक्रिया प्रारूप को संभालें।

इस पृष्ठ पर
  1. प्रोफ़ाइल के संपादन योग्य विवरण बदलें
  2. अपडेट अनुरोध
  3. उन्नत: पहले से अपलोड किए गए प्रमाण जोड़ें
  4. सफलता और विफलता की पुराने प्रारूप वाली प्रतिक्रियाएँ
  5. अपडेट की वर्तमान सीमाएँ और विफलता के बाद सुधार

प्रोफ़ाइल के संपादन योग्य विवरण बदलें

खाते के स्वामित्व वाली मौजूदा पंजीकरण प्रोफ़ाइल अपडेट करने के लिए उसके स्थानीय UUID का उपयोग करें, जिसे आप यहाँ से प्राप्त कर सकते हैं: create_document या documents। यह कार्रवाई खाते और अपस्ट्रीम दूरसंचार प्रदाता के डेटा को बदलती है। यह संग्रहीत Personal/Business पहचान प्रकार को नहीं बदलती और केवल कुछ फ़ील्ड बदलने वाला PATCH अनुरोध नहीं है।

अपडेट अनुरोध

अनुमत IP पते से अपने सक्षम MultiTEL API खाते के साथ प्रमाणीकरण करें। उदाहरणों में परिवेश चरों में रखे प्रमाणीकरण विवरण और काल्पनिक डेटा का उपयोग किया गया है। HTTP प्रतिक्रिया के साथ JSON में status.code और status.msg भी पढ़ें।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

उदाहरण में Personal प्रोफ़ाइल दिखाई गई है; इसकी जगह अंतिम उपयोगकर्ता के सभी इच्छित विवरण और अधिकृत हस्ताक्षर दें। डेटा को बनाए रखने के लिए नमूना हस्ताक्षर या खाली मान न भेजें। JSON और फ़ॉर्म-एन्कोडेड इनपुट समर्थित हैं।

अपडेट के लिए फ़ील्ड संबंधी आवश्यकताएँ
फ़ील्डव्यवहार
first_name, last_name, city, postal_code, addressअनिवार्य; प्रत्येक में अधिकतम 64 वर्ण हो सकते हैं।
phone_numberकम से कम आठ वर्णों वाला संख्यात्मक मान अनिवार्य है; देश कोड सहित अंतरराष्ट्रीय अंकों का उपयोग करें।
signatureअनिवार्य। पोर्टल डेटा URL उपसर्ग के बिना Base64 में एन्कोड किए गए PNG बाइट प्रदान करता है।
countryपंजीकरण सूची से पते के देश का ISO कोड दें। हैंडलर इस कोड से संबंधित देश निर्धारित करता है, हालाँकि समीक्षित पता अपडेट देश के साथ संबंध को नहीं बदलता।
nationalityमौजूदा Personal प्रोफ़ाइल के लिए देश का ISO कोड अनिवार्य है।
company_name, incorporation_countryमौजूदा Business प्रोफ़ाइल के लिए अनिवार्य; कंपनी के नाम में अधिकतम 64 वर्ण हो सकते हैं और कंपनी के निगमन देश का मान ISO कोड होना चाहिए।
emailअधिकतम 254 वर्णों वाला मान्य ईमेल पता वैकल्पिक है। संग्रहीत संपर्क ईमेल बनाए रखने के लिए इसे छोड़ दें; इसे स्थानीय रूप से मिटाने के लिए खाली मान भेजें।
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idइच्छित वर्तमान मान भेजें। छोड़े गए मान डिफ़ॉल्ट रूप से खाली हो जाते हैं और मौजूदा संग्रहीत मानों को अधिलेखित कर सकते हैं।

देश-विशिष्ट पंजीकरण नियमों के अनुसार अतिरिक्त जानकारी या विशेष प्रारूपों की आवश्यकता हो सकती है। पूरा अपडेट दोबारा तैयार करने के लिए केवल get_document पर निर्भर न रहें: इसकी सीमित प्रतिक्रिया में देश चयनकर्ता, email और इकाई ID शामिल नहीं होते। अपना अधिकृत स्रोत डेटा सुरक्षित रखें या पोर्टल के दस्तावेज़ संपादक का उपयोग करें।

उन्नत: पहले से अपलोड किए गए प्रमाण जोड़ें

वैकल्पिक identity_encryptfiles और address_encryptfiles ऐरे सक्रिय, खाते के स्वामित्व वाले संदर्भ स्वीकार करते हैं, जो यहाँ से मिलते हैं: create_encrypt_files। अपलोड की इकाई श्रेणी से मिलान करें और संदर्भ की वैधता समाप्त होने से पहले सबमिट करें। प्रत्येक फ़ाइल अलग प्रमाण अनुरोध में संलग्न होती है, भले ही कई फ़ाइलों का प्रमाण प्रकार समान हो। कई फ़ाइलों वाले पहचान प्रमाण के लिए बाद के चरण में प्रमाण संलग्न करने के कार्यप्रवाह का उपयोग एक ही ऐरे के साथ करें।

यदि नए बनाए गए पते के लिए बाद का पता प्रमाण अस्वीकार हो जाता है, तो उसके स्थान पर प्रोफ़ाइल UUID न दें और न ही पहचान को बार-बार फिर से बनाएँ। रुकें और पोर्टल में या सहायता के साथ प्रोफ़ाइल की जाँच करें। पता-प्रमाण रीडबैक/लुकअप पथ अभी भी एक समीक्षा सीमा बना हुआ है।

सफलता और विफलता की पुराने प्रारूप वाली प्रतिक्रियाएँ

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

इस एंडपॉइंट का सामान्य सफलता कोड यह स्ट्रिंग है: success; यह संख्यात्मक 200 नहीं है। सामान्य अपस्ट्रीम या स्थानीय विफलता में इस स्ट्रिंग का उपयोग हो सकता है: error। संख्यात्मक 400 अमान्य फ़ील्ड या प्रमाण संबंधी विफलताओं को दर्शाता है, 404 प्रोफ़ाइल न मिलने या अपलोड की गई फ़ाइल का संदर्भ अमान्य होने को, और 500 अनुरोध का मुख्य भाग खाली होने या देश निर्धारित न हो पाने को दर्शाता है। संदेश और सत्यापन संबंधी सभी प्रविष्टियाँ पढ़ें; केवल HTTP 200 को सफलता न मानें।

अपडेट की वर्तमान सीमाएँ और विफलता के बाद सुधार

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

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