المطوّرون

GET/v3/documents

سرد ملفات التسجيل

اعثر على ملفات التسجيل المحلية النشطة للحساب باستخدام مجموعة الحقول المحدودة التي يعيدها النظام القديم.

في هذه الصفحة
  1. العثور على ملفات التسجيل الموجودة
  2. طلب سرد الملفات
  3. قائمة الاستجابة
  4. حقول ملف التسجيل المُعادة
  5. الخطوات التالية

العثور على ملفات التسجيل الموجودة

اسرد ملفات التسجيل المحلية النشطة وغير المحذوفة المرتبطة بحسابك في واجهة برمجة التطبيقات. استخدم هذه القائمة للعثور على المعرّف الفريد العام (UUID) لملف التسجيل قبل فتحه باستخدام get_document، وليس لتحديد ما إذا كانت مستنداته الإثباتية أو تسجيل الرقم قد حظيت بالموافقة.

طلب سرد الملفات

صادِق باستخدام حسابك المفعّل في واجهة برمجة تطبيقات MultiTEL وعنوان 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"
    }
  ]
}

عند عدم وجود ملفات تسجيل نشطة مطابقة، يعيد المعالج رمز واجهة برمجة التطبيقات 200 وقائمة استجابة فارغة. response[].id هو المعرّف الفريد العام (UUID) لملف التسجيل المحلي، الذي يُعاد باسم uuid عند الإنشاء؛ وليس معرّف هوية أو معرّف عنوان.

حقول ملف التسجيل المُعادة

تتضمن مجموعة الحقول المُعادة 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، أو مراجع الملفات المرفوعة، أو قوائم المستندات الإثباتية، أو حالة التحقق. وليست هذه نقطة نهاية للاستعلام عن حالة المستندات الإثباتية أو الموافقة على التسجيل. تعامل مع بيانات الهوية والاتصال والتوقيع المُعادة باعتبارها بيانات خاصة.

الخطوات التالية

احفظ معرّفات الكيانات الواردة في الاستجابة الأصلية لطلب create_document لاستخدامها في عمليات الإرفاق اللاحقة. إذا فُقدت تلك الاستجابة، فلا يمكن استعادة هذه المعرّفات من هذه القائمة. افحص ملف التسجيل في البوابة أو تواصل مع الدعم بدلًا من إنشاء نسخة مكررة تلقائيًا.