PApactima
Actions

Obtain a download link

Create a link to download the eSignature package. This only provides access to the signed portion of the package, it does not include attachments, audit trials, etc.

post/e-signature-packages/{eSignaturePackageId}/actions/download

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/e-signature-packages/{eSignaturePackageId}/actions/download
  • Auth
    HTTP bearer

Request body multipart/form-data

format'DEFAULT' | 'DEFAULT_WITH_CUSTOM_PKI_CERTIFICATE' | 'UNSIGNED' | 'HEADERLESS' | 'SEPARATE' | 'SEPARATE_HEADERLESS'
durationstring

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" )

customPkiCertificateIdstring

Id of the PKI certificate that belongs to the owner the eSignature package

idHeaderLocation'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT'
isAsyncboolean

If true, will send an email to the participant once the download is ready

Example request

{
  "duration": "3 days"
}

Response

Details of the download

idstring required
namestring required
typestring required
signedUrlstring

Changes

No recorded changes to this operation across all 2 revisions of this API.