How to enable individual document downloads using the BoldSign API

To configure BoldSign to allow downloading each document individually when multiple files are uploaded for signing, you need to set the DocumentDownloadOption parameter to Individually in the API request. This feature is available only for users on a paid plan.

Steps to Enable Individual Document Downloads:

1. Set the DocumentDownloadOption Parameter:

   • When sending a document via the BoldSign API, include the DocumentDownloadOption parameter with value as Individually in your API request.

2. Sample cURL Code:
   Here’s a sample cURL request for setting the document download option:

   curl -X 'POST' \ 'https://api.boldsign.com/v1/document/send' \
        -H 'accept: application/json' \
        -H 'X-API-KEY:{Your API Key}' \ # Replace with your API Key
        -H 'Content-Type: multipart/form-data' \
        -F 'Message=Please sign this' \
        -F 'DocumentDownloadOption=Individually' \
        -F 'Signers={
           "name": "[Signer Name]",
           "emailAddress": "[Signer Email]",
           "signerType": "Signer",
           "formFields": [
              {
                   "id": "sign1",
                   "name": "sign",
                   "fieldType": "Signature",
                   "pageNumber": 1,
                   "bounds": {
                     "x": 50,
                     "y": 50,
                     "width": 100,
                     "height": 100
                      },
         "isRequired": true
       }
     ],
     "locale": "EN"
   }' \
     -F 'Files=@{your file}' \
     -F 'Title=Test document' \
   

3. Outcome:

   • If DocumentDownloadOption is set to Individually:
     • For multiple attached documents, each file can be downloaded separately.
     • For a single attached document, the signed document will be downloaded as a ZIP folder containing that individual document.
   • If DocumentDownloadOption is set to Combined, all attached documents will be merged into a single combined PDF upon download.

Additional Notes:

• Ensure you are on a paid BoldSign plan to access this feature.
• Replace placeholders in the cURL request (e.g., {Your API Key}, @{your file}, [Signer Name], [Signer Email]) with actual values…

By following the above steps, you can effectively manage document download preferences using the BoldSign API.