ڈیولپرز

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لازمی دستخط کا ڈیٹا۔ موجودہ پورٹل Base64 PNG تصویر کے بائٹس data:image/png;base64, سابقے کے بغیر فراہم کرتا ہے۔ اختتامی صارف کے دستخط اپنے مجاز ورک فلو کے ذریعے حاصل کریں؛ غیر خالی پلیس ہولڈر بامعنی دستخط نہیں ہے۔
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 سے واپس کردہ IDs کی اریز کے طور پر فراہم کر سکتے ہیں۔ متعلقہ اینٹیٹی زمرے کے لیے ثبوت کی قسم استعمال کرتے ہوئے اپ لوڈ کریں، پھر فائل ریفرنس کی تقریباً 20 منٹ کی میعاد ختم ہونے سے پہلے جمع کرائیں۔ تخلیقی ہینڈلر ہر فراہم کردہ ریفرنس کے اکاؤنٹ، زمرے اور میعاد کی جانچ کرتا ہے۔

ان فیلڈز کے نام بعد کے اٹیچمنٹ اینڈ پوائنٹ کے encrypted_file_ids سے مختلف ہیں۔ تخلیق کے دوران ہر فائل ایک الگ ثبوت کی درخواست کے طور پر بھیجی جاتی ہے، چاہے کئی فائلیں ایک ہی ثبوت کی قسم میں شامل ہوں۔ ایسے شناختی ثبوت کے لیے جس میں کئی فائلیں ایک ساتھ ہونی چاہئیں، بعد کی create_proof درخواست ایک ہی اری کے ساتھ استعمال کریں۔ محض کامیاب پروفائل تخلیق انفرادی ثبوت کی منظوری کے نتائج فراہم نہیں کرتی۔

اگر نئے بنائے گئے پتے کے لیے بعد میں پتے کا ثبوت مسترد ہو جائے تو اس کی جگہ پروفائل کا UUID استعمال نہ کریں اور نہ ہی بار بار شناخت دوبارہ بنائیں۔ رک جائیں اور پورٹل میں یا سپورٹ کے ذریعے پروفائل چیک کریں۔ پتے کے ثبوت کو واپس پڑھنے/تلاش کرنے کا راستہ ابھی جائزے کی ایک حد ہے۔

ناکامیاں اور جزوی تخلیق

API کوڈ 400 فیلڈ کی توثیق، کیریئر پر تخلیق کی ناکامیوں اور مقامی محفوظ کرنے کی ناکامیوں کا احاطہ کرتا ہے۔ توثیق کی غلطیاں response میں فیلڈ کے نام والی اندراجات کے طور پر ظاہر ہو سکتی ہیں۔ کوڈ 500 غیر دستیاب/غلط رجسٹریشن ملک کے لیے استعمال ہوتا ہے، اور کوڈ 404 گمشدہ یا میعاد ختم شدہ پہلے سے اپ لوڈ کردہ ریفرنسز کے لیے۔ کوڈ کے ساتھ ساتھ status.msg بھی پڑھیں۔

مقامی پروفائل اور اپ اسٹریم کیریئر کی کارروائیاں ایک ایٹمی ٹرانزیکشن نہیں ہیں۔ ناکام درخواست اپ اسٹریم حالت چھوڑ سکتی ہے چاہے کوئی مقامی پروفائل فہرست میں نہ ہو۔ کوئی کلائنٹ آئیڈیمپوٹینسی کلید فراہم نہیں کی گئی۔ ٹائم آؤٹ یا غیر یقینی ناکامی کے بعد، تخلیق دہرانے سے پہلے موجودہ پروفائلز کا معائنہ کریں اور سپورٹ سے رابطہ کریں؛ خالی documents فہرست اس بات کا ثبوت نہیں کہ اپ اسٹریم کچھ نہیں بنا۔