v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB

Signers - Actions

Obtain preview link

Obtain a secure link to be used for previewing the document. This link can be embedded using an iframe or used directly via the browser. The package must be in a valid state for preview access.

post/e-signature-packages/{eSignaturePackageId}/signers/{id}/actions/obtain-preview-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" )

Example request

{
  "duration": "3 days"
}

Response

Secure link for previewing that is particular to the specified user

urlstring required

shortUrlstring required