المطوّرون

GET/v3/get_proof_types

سرد فئات المستندات الثبوتية

اعثر على معرّفات فئات المستندات الثبوتية وأنواع الكيانات قبل إعداد مستندات إثبات الهوية أو العنوان.

في هذه الصفحة
  1. اختر فئة للمستندات الثبوتية
  2. التزم بالمتطلبات الفعلية
  3. الطلب
  4. الاستجابة
  5. الأخطاء
  6. التوفّر والآثار الجانبية

اختر فئة للمستندات الثبوتية

استخدم الفئة ونوع الكيان المُعادين عند إعداد المستندات الثبوتية المطلوبة لهوية ما. تصف هذه القائمة الفئات، ولا تسرد ملفاتك المرفوعة ولا تعني الموافقة على أي مستند ثبوتي.

التزم بالمتطلبات الفعلية

لا يعني إدراج فئة في القائمة أنها تستوفي المتطلبات الخاصة بكل بلد أو نوع رقم أو هوية عميل. اقرأ المتطلبات المنطبقة قبل رفع المستندات الثبوتية، وتعامل مع المعرّفات المُعادة كقيم معتمة لا تستنتج معناها من بنيتها.

الطلب

استخدم بيانات اعتماد حساب واجهة برمجة التطبيقات المُفعّل لديك عبر HTTPS. تُدعم المصادقة الأساسية ورموز المصادقة لحاملها المُفعّلة لحساب واجهة برمجة التطبيقات؛ وتُطبّق قيود الحساب.

GET مع أي معامل موثّق في مسار عنوان URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

الاستجابة

تحقّق من status.code في متن JSON، وكذلك من حالة HTTP. يمثّل response مصفوفة من الكائنات التي تتضمن الحقول id وname وentity_type. تأتي هذه القيم من الكتالوج الحالي للمستندات الثبوتية. المعرّفات قيم معتمة؛ انسخها بدلاً من إنشاء معرّف أو توليده باستخدام التجزئة. يمكن إرجاع كتالوج فارغ بنجاح. لا تُضمّن في الشيفرة تعداداً ثابتاً وشاملاً لأنواع الكيانات استناداً إلى هذا المثال.

بنية استجابة توضيحية؛ لا تمثّل بيانات حساب مباشرة أو عرض سعر حالي.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

الأخطاء

  • تحقّق من status.code وstatus.msg لرصد أخطاء المصادقة أو الخدمة. لا يعني إرجاع كتالوج فارغ بنجاح الموافقة على مستند أو الإعفاء من التسجيل.

التوفّر والآثار الجانبية

  • لا يؤدي هذا الاستعلام عن الكتالوج والمتطلبات إلى إنشاء هوية أو رفع مستند ثبوتي أو تسجيل رقم أو تقديم طلب شراء.
  • لا تعني الاستجابة الناجحة للكتالوج الموافقة على مستنداتك أو تأكيد إمكانية تفعيل رقم محدّد.