طلبات التوقيع

أرسل قالبًا للتوقيع، واستطلع حالته، ونزّل المستند الموقّع.

طلب التوقيع يرسل قالبًا منشورًا إلى أطرافه الموقّعة ويتابعه حتى الاكتمال.

الإرسال للتوقيع

curl -X POST https://api.instaspace.ai/api/v1/esign/submissions \
  -H "Authorization: Bearer isk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "0b9f6f2e-…",
    "submitters": [
      { "role": "First Party", "name": "Dana Client", "email": "dana@client.com" },
      { "role": "Second Party", "name": "Sami Counsel", "email": "sami@yourfirm.com" }
    ],
    "values": { "client_name": "Client Co. LLC" },
    "message": "Please sign before Friday.",
    "sendEmail": true,
    "idempotencyKey": "crm-deal-4821"
  }'

submitters — مستلم واحد بالضبط لكل دور يعرّفه القالب (حتى 10).
values — اختياري. مفاتيحه هي مفاتيح المتغيّرات (قوالب flow) أو أسماء الحقول (قوالب coordinate)؛ راجع قراءة بنية القالب.
message — مذكّرة اختيارية تُحمَل في بريد التوقيع، لذا فهي تنطبق فقط حين تكون sendEmail مفعّلة.
sendEmail — قيمته الافتراضية true. وحين تكون false، لا يُراسَل الموقّعون بالبريد؛ فتشارك روابط التوقيع بنفسك.
idempotencyKey — اختياري لكنه مُوصى به. فإعادة إرسال طلب بمفتاح استُخدم من قبل تعيد طلب التوقيع الأصلي بدلًا من إرسال جولة بريد مكرّرة، ولا تُحتسَب من حصتك الشهرية مرة أخرى.

والاستجابة هي طلب التوقيع:

{
  "id": "7c1d34…",
  "templateId": "0b9f6f2e-…",
  "templateName": "Mutual NDA",
  "status": "pending",
  "submitters": [
    {
      "role": "First Party",
      "name": "Dana Client",
      "email": "dana@client.com",
      "status": "awaiting",
      "completedAt": null
    }
  ],
  "hasSignedDocument": false,
  "createdAt": "2026-08-06T12:00:00.000Z",
  "completedAt": null
}

استطلاع الحالة

curl https://api.instaspace.ai/api/v1/esign/submissions/{id} \
  -H "Authorization: Bearer isk_live_..."

تنتقل حالة الطلب status عبر pending ← opened ← completed، أو تنتهي بـdeclined أو expired أو voided. ويحمل كل موقّع حالته الخاصة (awaiting، opened، completed، declined).

تنزيل المستند الموقّع

بمجرّد أن تصبح hasSignedDocument مفعّلة:

curl -L -o signed.pdf \
  https://api.instaspace.ai/api/v1/esign/submissions/{id}/document \
  -H "Authorization: Bearer isk_live_..."

ويُسجَّل التنزيل في سجلّ تدقيق مساحة العمل بهوية مفتاح الواجهة لديك.

لا توجد حتى الآن خطّافات ويب صادرة — فاستطلع نقطة نهاية الحالة للحصول على التحديثات. والطلب المكتمل يُشعر مساحة العمل داخل إنستاسبيس كالمعتاد كذلك.

الإرسال للتوقيع

استطلاع الحالة

تنزيل المستند الموقّع

في هذه الصفحة