מפתחים

GET/v3/documents

הצגת רשימת פרופילי רישום

איתור הפרופילים המקומיים הפעילים של החשבון באמצעות מבחר השדות המצומצם מהמערכת הוותיקה.

בעמוד זה
  1. איתור פרופילי רישום קיימים
  2. בקשה לקבלת הרשימה
  3. הרשימה בתגובה
  4. שדות הפרופיל המוחזרים
  5. השלבים הבאים

איתור פרופילי רישום קיימים

הציגו את רשימת פרופילי הרישום המקומיים הפעילים שלא נמחקו ומשויכים לחשבון ה-API שלכם. השתמשו ברשימה כדי לאתר את ה-UUID של פרופיל לפני פתיחתו באמצעות get_document, ולא כדי לקבוע אם האסמכתאות שלו או רישום המספר אושרו.

בקשה לקבלת הרשימה

הזדהו באמצעות חשבון ה-API הפעיל שלכם ב-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"
    }
  ]
}

כאשר אין פרופילים פעילים תואמים, רכיב הטיפול בבקשה מחזיר קוד API 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 המקורית לצורך צירופים בהמשך. אם התגובה הזו אבדה, לא ניתן לשחזר את המזהים באמצעות רשימה זו. עיינו בפרופיל דרך הפורטל או פנו לתמיכה במקום ליצור כפילות באופן אוטומטי.