Signing

Hosted and external signing session orchestration.

v1 · 2026-01-15

POST/signing/client-sessionsRequires authentication

Create client-side signing session (advanced/enterprise)

Request body

contractIdstringrequired
participantIdstringrequired
providerKeystringrequired
providerTypestring
channelstring
sessionTtlMinutesinteger

Responses

201Session created
defaultStandardized API error

GET/signing/client-sessions/{sessionId}Requires authentication

Get client signing session (advanced/enterprise)

Parameters

Name	In	Type	Required
sessionId	path	string	Yes

Responses

200Session details
defaultStandardized API error

POST/signing/client-sessions/{sessionId}/cancelRequires authentication

Cancel client signing session (advanced/enterprise)

Parameters

Name	In	Type	Required
sessionId	path	string	Yes

Request body

reasonstring

Responses

200Session cancelled
defaultStandardized API error

POST/signing/client-sessions/{sessionId}/completeRequires authentication

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

Parameters

Name	In	Type	Required
sessionId	path	string	Yes

Request body

sessionNoncestringrequired
inputHashEchostringrequired
artifactobjectrequired
providerReceiptobject

Responses

200Completion accepted
defaultStandardized API error

GET/signing/client-sessions/{sessionId}/packageRequires authentication

Retrieve source signing package (advanced/enterprise)

Parameters

Name	In	Type	Required
sessionId	path	string	Yes
mode	query	string	No

Responses

200Signing source package
defaultStandardized API error

POST/signing/contracts/{contractId}/external/dispatchRequires authentication

Trigger external organization signing dispatch (advanced)

Parameters

Name	In	Type	Required
contractId	path	string	Yes

Request body

forceDispatchboolean

Responses

200Dispatch result
defaultStandardized API error

GET/signing/contracts/{contractId}/external/requestsRequires authentication

List external signing requests for contract (advanced)

Parameters

Name	In	Type	Required
contractId	path	string	Yes

Responses

200Request list
defaultStandardized API error

POST/signing/contracts/{contractId}/participants/{participantId}/accessRequires authentication

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`.

Parameters

Name	In	Type	Required
contractId	path	string	Yes
participantId	path	string	Yes

Responses

200Hosted signer access
defaultStandardized API error

GET/signing/external/providersRequires authentication

List external signing providers

Responses

200External provider list
defaultStandardized API error

GET/signing/external/requests/{requestId}Requires authentication

Get external signing request details (advanced)

Parameters

Name	In	Type	Required
requestId	path	string	Yes

Responses

200Request details
defaultStandardized API error

POST/signing/external/requests/{requestId}/retryRequires authentication

Retry external signing request dispatch (advanced)

Parameters

Name	In	Type	Required
requestId	path	string	Yes

Request body

forceDispatchboolean

Responses

200Retry result
defaultStandardized API error

GET/signing/providersRequires authentication

List client signing providers from registry

Parameters

Name	In	Type	Required
providerType	query	string	No

Responses

200Provider list
defaultStandardized API error