الانتقال إلى المحتوى الرئيسي
POST
curl

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

transaction_id
string<uuid>
مطلوب

معرّف UUID الثابت للمعاملة من Didit التي تملك التحويل.

الجسم

أرسل كـ JSON، أو كـ multipart/form-data مع وضع المرفقات في files.

kind
enum<string>
افتراضي:MESSAGE
الخيارات المتاحة:
MESSAGE,
DOCUMENT_REQUEST
body
string

مطلوب لـ MESSAGE ما لم يتم إرفاق ملف.

Maximum string length: 5000
requested_documents
string[]

مطلوب (واحد على الأقل) لـ DOCUMENT_REQUEST، ومسموح به هناك فقط.

Maximum array length: 10
Maximum string length: 255
reply_to
string<uuid> | null

رسالة خاصة بالتحويل نفسه. الرد الذي يتضمن مستنداً يلبي طلب المستند الذي يجيب عليه.

files
file[]

للطلبات متعددة الأجزاء فقط. ما يصل إلى 5 ملفات بحجم 10 ميغابايت لكل منها.

Maximum array length: 5

الاستجابة

الرسالة المخزنة.

id
string<uuid>
kind
enum<string>
الخيارات المتاحة:
MESSAGE,
DOCUMENT_REQUEST
direction
enum<string>

OUTBOUND هو ما أرسله طرف القارئ نفسه. في بوابة الاستلام، يكون الاتجاه من جانب الطرف المقابل.

الخيارات المتاحة:
INBOUND,
OUTBOUND
author
string

من كتبه من جانبه: البريد الإلكتروني لمستخدم لوحة التحكم أو تسمية مفتاح API، أو اسم VASP الآخر.

body
string
requested_documents
string[]

ما يطلبه DOCUMENT_REQUEST، بكلمات صاحب الطلب.

reply_to
string<uuid> | null
fulfilled_at
string<date-time> | null

يُعيَّن على DOCUMENT_REQUEST بمجرد أن يتضمن الرد عليه مستنداً.

attachment
object | null

المستند المرفق بالرسالة، والمخزن مثل أي مستند معاملة آخر.

created_at
string<date-time>
آخر تعديل في ٧ نوفمبر ٢٠٢٦