v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB

ccRecipients - Actions

Obtain observer link

Obtain a secure link to be used for a ccRecipient who has a special role as OBSERVER or OBSERVER_ONLY. This link can be embedded using an iframe or used directly via the browser. The package must be awaiting signing or is signing status (i.e. DRAFT, DECLINED, CANCELLED, or COMPLETED).

post/e-signature-packages/{eSignaturePackageId}/cc-recipients/{id}/actions/obtain-observer-link

Request body

durationstring required

Time span expressed as vercel/ms, with only string values accepted. There is a minimum of 5 mins and maximum of 1 year. (E.g. "2 days", "10h", "7d", without an time units, the default is milliseconds, i.e. "120" equals "120ms" )

joinWithoutVideoboolean

Specify whether the signer of the LIVE package should join the signing session without video

Example request

{
  "duration": "3 days"
}

Response

Secure link for observing that is particular to the specified user

urlstring required

shortUrlstring required