---
title: "Obtain a download link"
method: POST
path: "/e-signature-packages/{eSignaturePackageId}/actions/download"
tags: ["Actions"]
---

# Obtain a download link

`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

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.

## Request body `multipart/form-data`

- object
  - `format` 'DEFAULT' | 'DEFAULT_WITH_CUSTOM_PKI_CERTIFICATE' | 'UNSIGNED' | 'HEADERLESS' | 'SEPARATE' | 'SEPARATE_HEADERLESS'
  - `duration` string: Time span expressed as [vercel/ms](https://github.com/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" )
  - `customPkiCertificateId` string: Id of the PKI certificate that belongs to the owner the eSignature package
  - `idHeaderLocation` 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT'
  - `isAsync` boolean: If true, will send an email to the participant once the download is ready

## Response `200`

Details of the download

- FileDownloadResponse
  - `id` string, required
  - `name` string, required
  - `type` string, required
  - `signedUrl` string

---

[API](https://skmtc.dev/pactima/apis/esignature-packages-api.md) - [All operations](https://skmtc.dev/pactima/apis/esignature-packages-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pactima/apis/esignature-packages-api/revisions/263938e87b8b?raw)