الانتقال إلى المحتوى الرئيسي
POST
curl
أنشئ قالب رأس goAML قابلًا لإعادة الاستخدام. يجب أن يجتاز القالب التحقق من الحقول الإلزامية (rentity_id وsubmission_code وcurrency_code_local) ليُحفظ، سواء عند الإنشاء أو عند كل تعديل لاحق. أما حقول الرأس الخاصة بكل تقرير، مثل action وsubmission_date، فتُطبَّق عند التحقق من التقرير نفسه أو إنهائه، ولا تُطبَّق على القالب.

ذات صلة

التفويضات

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.

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

organization_id
string<uuid>
مطلوب

UUID الخاص بالمؤسسة.

application_id
string<uuid>
مطلوب

معرّف UUID للتطبيق.

الجسم

application/json
name
string
مطلوب
jurisdiction
string
مطلوب

رمز الدولة وفقاً لـ ISO 3166-1 alpha-2، يتم تحويله إلى أحرف كبيرة عند الحفظ.

Required string length: 2
report_type
enum<string>
مطلوب
الخيارات المتاحة:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
field_config
object

القيم الافتراضية القابلة لإعادة الاستخدام لرأس goAML. الحقول الإلزامية على مستوى القالب: rentity_id، وsubmission_code، وcurrency_code_local (من 3 أحرف). الحقول الاختيارية: enabled_fields (أقسام التقرير الاختيارية المطلوب تضمينها) بالإضافة إلى القيم الافتراضية لكل من reporting_person، وlocation، وreason، وaction. يتم فرض حقول الرأس الخاصة بكل ملف تقديم (action، وsubmission_date، وtransactions، وjurisdiction) عند التحقق من صحة التقرير أو إتمامه نهائياً، وليس على مستوى القالب.

الاستجابة

تم إنشاء القالب.

uuid
string<uuid>
name
string
jurisdiction
string

رمز الدولة وفقاً لـ ISO 3166-1 alpha-2.

Required string length: 2
report_type
enum<string>
الخيارات المتاحة:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
report_type_display
string
field_config
object

القيم الافتراضية القابلة لإعادة الاستخدام لرأس goAML. الحقول الإلزامية على مستوى القالب: rentity_id، وsubmission_code، وcurrency_code_local (من 3 أحرف). الحقول الاختيارية: enabled_fields (أقسام التقرير الاختيارية المطلوب تضمينها) بالإضافة إلى القيم الافتراضية لكل من reporting_person، وlocation، وreason، وaction. يتم فرض حقول الرأس الخاصة بكل ملف تقديم (action، وsubmission_date، وtransactions، وjurisdiction) عند التحقق من صحة التقرير أو إتمامه نهائياً، وليس على مستوى القالب.

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