מפתחים

GET/v3/get_document/{uuid}

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

קריאת פרופיל פעיל אחד השייך לחשבון לפי ה-UUID של המסמך המקומי שלו.

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

קריאת פרופיל שמור אחד

אחזרו את פרופיל הרישום המקומי הפעיל בחשבונכם לפי ה-UUID שלו. הפעולה מחזירה את אותם שדות פרופיל מוגבלים כמו documents; היא אינה מרעננת את האימות מול ספק התקשורת ואינה מחזירה אסמכתאות מצורפות.

בקשת פרופיל

הזדהו באמצעות חשבון ה-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/get_document/$DOCUMENT_UUID"

הגדירו את DOCUMENT_UUID לערך response.uuid שמתקבל מ-create_document, או לערך response[].id שמתקבל מ-documents. אין להשתמש כאן ב-identity_id, ב-address_id, במזהה אסמכתא או במספר טלפון. אין צורך בגוף בקשה.

תגובת פרופיל

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "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"
  }
}

שדות הפרופיל המוחזרים

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

פרופיל שלא נמצא וניסיונות חוזרים

קוד API 404 עם ההודעה Failed, Not found מציין שלא נמצא פרופיל פעיל תואם לחשבון ול-UUID האלה. בדקו את החשבון, את המזהה והאם הפרופיל נמחק. החיפוש הזה אינו חושף פרופיל של חשבון אחר.

קריאה מוצלחת אינה מעידה על קבלת אסמכתאות או על הפעלת מספר. אם אתם מנסים להתאושש מבקשת יצירה או צירוף שתוצאתה אינה ודאית, בדקו את המסמך בפורטל לפני שליחת בקשה נוספת שמשנה את המצב.