تخطَّ إلى المحتوى

Signing

Hosted and external signing session orchestration.

v1 · 2026-01-15

POST/signing/client-sessionsيتطلب مصادقة

Create client-side signing session (advanced/enterprise)

جسم الطلب

  • contractIdstringمطلوب
  • participantIdstringمطلوب
  • providerKeystringمطلوب
  • providerTypestring
  • channelstring
  • sessionTtlMinutesinteger

الاستجابات

  • 201Session created
  • defaultStandardized API error
GET/signing/client-sessions/{sessionId}يتطلب مصادقة

Get client signing session (advanced/enterprise)

المعاملات

الاسمالموضعالنوعمطلوب
sessionIdpathstringنعم

الاستجابات

  • 200Session details
  • defaultStandardized API error
POST/signing/client-sessions/{sessionId}/cancelيتطلب مصادقة

Cancel client signing session (advanced/enterprise)

المعاملات

الاسمالموضعالنوعمطلوب
sessionIdpathstringنعم

جسم الطلب

  • reasonstring

الاستجابات

  • 200Session cancelled
  • defaultStandardized API error
POST/signing/client-sessions/{sessionId}/completeيتطلب مصادقة

Submit signed artifact to complete client signing (advanced/enterprise)

المعاملات

الاسمالموضعالنوعمطلوب
sessionIdpathstringنعم

جسم الطلب

  • sessionNoncestringمطلوب
  • inputHashEchostringمطلوب
  • artifactobjectمطلوب
  • providerReceiptobject

الاستجابات

  • 200Completion accepted
  • defaultStandardized API error
GET/signing/client-sessions/{sessionId}/packageيتطلب مصادقة

Retrieve source signing package (advanced/enterprise)

المعاملات

الاسمالموضعالنوعمطلوب
sessionIdpathstringنعم
modequerystringلا

الاستجابات

  • 200Signing source package
  • defaultStandardized API error
POST/signing/contracts/{contractId}/external/dispatchيتطلب مصادقة

Trigger external organization signing dispatch (advanced)

المعاملات

الاسمالموضعالنوعمطلوب
contractIdpathstringنعم

جسم الطلب

  • forceDispatchboolean

الاستجابات

  • 200Dispatch result
  • defaultStandardized API error
GET/signing/contracts/{contractId}/external/requestsيتطلب مصادقة

List external signing requests for contract (advanced)

المعاملات

الاسمالموضعالنوعمطلوب
contractIdpathstringنعم

الاستجابات

  • 200Request list
  • defaultStandardized API error
POST/signing/contracts/{contractId}/participants/{participantId}/accessيتطلب مصادقة

Create hosted signer access payload (only public hosted signing access endpoint)

Primary hosted signing access endpoint for external integrators. Returns the hosted signing URL and session token for a contract participant. This route is valid only for signer participants with: - `action="sign"` - `executionChannel="platform_hosted"` **Requires the `contracts:send` scope.** It previously accepted `contracts:read` OR `contracts:send`, so a read-only key could mint a signing link. The token this returns authenticates the participant and produces a binding signature — issuing it is not a read. A key without `contracts:send` receives `403 PERMISSION_DENIED`.

المعاملات

الاسمالموضعالنوعمطلوب
contractIdpathstringنعم
participantIdpathstringنعم

الاستجابات

  • 200Hosted signer access
  • defaultStandardized API error
GET/signing/external/providersيتطلب مصادقة

List external signing providers

الاستجابات

  • 200External provider list
  • defaultStandardized API error
GET/signing/external/requests/{requestId}يتطلب مصادقة

Get external signing request details (advanced)

المعاملات

الاسمالموضعالنوعمطلوب
requestIdpathstringنعم

الاستجابات

  • 200Request details
  • defaultStandardized API error
POST/signing/external/requests/{requestId}/retryيتطلب مصادقة

Retry external signing request dispatch (advanced)

المعاملات

الاسمالموضعالنوعمطلوب
requestIdpathstringنعم

جسم الطلب

  • forceDispatchboolean

الاستجابات

  • 200Retry result
  • defaultStandardized API error
GET/signing/providersيتطلب مصادقة

List client signing providers from registry

المعاملات

الاسمالموضعالنوعمطلوب
providerTypequerystringلا

الاستجابات

  • 200Provider list
  • defaultStandardized API error