डेवलपर

POST/v3/create_document

पंजीकरण प्रोफ़ाइल बनाएँ

एक पहचान/पता प्रोफ़ाइल बनाएँ और उसके अलग-अलग प्रोफ़ाइल और इकाई पहचानकर्ताओं को सुरक्षित रखें।

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

प्रोफ़ाइल केवल एक बार बनाएँ

यह अनुरोध कैरियर पहचान और पता रिकॉर्ड के साथ एक स्थानीय पंजीकरण प्रोफ़ाइल बनाता है। वर्तमान पंजीकरण देश, नंबर प्रकार और आवश्यकताओं से शुरू करें। आवश्यकताएँ उस देश और नंबर के प्रकार पर निर्भर करती हैं जिसे आप पंजीकृत करने की योजना बना रहे हैं।

सफल निर्माण प्रतिक्रिया नियामक अनुमोदन या नंबर सक्रियण नहीं है। दस्तावेज़ UUID, पहचान ID और पता ID को अलग-अलग सहेजें: इनके उद्देश्य अलग-अलग हैं। यह अनुरोध खाता डेटा बदलता है और केवल-सत्यापन वाला ऑपरेशन नहीं है।

निर्माण अनुरोध

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile.json \
  https://api.multitel.net/v3/create_document
{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

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

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

यह प्रत्यक्ष v3 हैंडलर पता फ़ील्ड की आवश्यकता रखता है और एक पता बनाता है। यह न मानें कि पोर्टल का पता-स्थगित करने का विकल्प इसके माध्यम से उपलब्ध है।

तीनों पहचानकर्ता सुरक्षित रखें

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

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}
  • response.uuid स्थानीय प्रोफ़ाइल की पहचान करता है। इसे get_document के साथ उपयोग करें। documents और get_document प्रतिक्रियाओं में, उसी प्रोफ़ाइल पहचानकर्ता का नाम id है।
  • response.identity_id उस पहचान को इंगित करता है जिसका उपयोग बाद के पहचान प्रमाणों और सहायक दस्तावेज़ों के लिए किया जाता है।
  • response.address_id बनाए गए पते की पहचान करता है। इसे अलग रखें; स्थानीय प्रोफ़ाइल UUID कोई पता ID नहीं है। नए बनाए गए प्रोफ़ाइल के लिए बाद में पता-प्रमाण संलग्न करने की संगतता अभी समीक्षाधीन है।

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

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

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

इन फ़ील्ड के नाम बाद के संलग्नक एंडपॉइंट के encrypted_file_ids से भिन्न हैं। निर्माण के दौरान, प्रत्येक फ़ाइल एक अलग प्रमाण अनुरोध के रूप में भेजी जाती है, भले ही कई फ़ाइलें एक ही प्रमाण प्रकार साझा करती हों। ऐसे पहचान प्रमाण के लिए जिसमें कई फ़ाइलें एक साथ होनी चाहिए, बाद के create_proof अनुरोध का उपयोग एक सरणी के साथ करें। केवल सफल प्रोफ़ाइल निर्माण से अलग-अलग प्रमाण अनुमोदन के परिणाम प्राप्त नहीं होते।

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

विफलताएँ और आंशिक निर्माण

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

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