Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Actions

End a signing session

For LIVE eSignature packages that have been completed, the signing session can be ended to terminate the video conference (and move participants to the exit workflow if applicable).

post/e-signature-packages/{eSignaturePackageId}/actions/end-signing-session

Request body

object required

Response

Returns the eSignature package object if the action was successfully performed.

idstring required
isTestModeboolean
titlestring required
descriptionstring
orderedSignersboolean

Signers are sent by order

status'ACTIVE' | 'CANCELLED' | 'COMPLETED' | 'DECLINED' | 'DRAFT' | 'LIVE' | 'LIVE_EDITING' | 'PREPARED' | 'PROCESSING' | 'SENT' | 'SCHEDULING' | 'SCHEDULED' | 'LOCKED_FOR_REVIEW'
kind'IN_PERSON' | 'LIVE' | 'STANDARD'
recordedLiveESignatureboolean
packageFolderIdstring

Package folder that the esp is part of

eNotaryPackageIdstring

Id of the applicable eNotaryPackage

customBrandItemIdstring

Id of the applicable custom brand item to apply to this eSignature package