Download document

get/v1/document/download

Returns the PDF document for the specified documentId. When the document is created on behalf of a particular sender email, then the download operation can be performed on the same account by specifying the email in onBehalfOf.

Code snippet

curl -X GET 'https://api.boldsign.com/v1/document/download?documentId=949ebf20-45a8-4a3e-91a9-68e9540e0020' \
-H 'accept: application/json' \
-H 'X-API-KEY: {your-api-key}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your API-KEY");
var documentClient = new DocumentClient(apiClient);
var documentStream = documentClient.DownloadDocument("949ebf20-45a8-4a3e-91a9-68e9540e0020");

import requests

url = "https://api.boldsign.com/v1/document/download?documentId=949ebf20-45a8-4a3e-91a9-68e9540e0020"

payload={}
headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your API key}'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
const response = await axios.get('https://api.boldsign.com/v1/document/download', {
    params: {
        'documentId': '949ebf20-45a8-4a3e-91a9-68e9540e0020'
    },
    headers: {
        'accept': 'application/json',
        'X-API-KEY': '{your API key}'
    }
});

Request body

titledescription
documentIdstringRequiredThe unique document id of the document.
onBehalfOfstringThe on behalf email address of the sender.

Example response

200 Success

Contains the PDF document