Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Actions

Start the signing session

Start the signing session for LIVE eSignature packages in the SCHEDULED status moving it to the LIVE status; moves the IN_PERSON eSignature package from PREPARED to ACTIVE

post/e-signature-packages/{eSignaturePackageId}/actions/start-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