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 the 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 boldsign

configuration = boldsign.Configuration(
    api_key = "YOUR_API_KEY"
)

with boldsign.ApiClient(configuration) as api_client:
    
    document_api = boldsign.DocumentApi(api_client)
    
    download_attachment_response = document_api.download_document(
        document_id="YOUR_DOCUMENT_ID"
    )

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

Request body

documentIdstringRequired	The unique document id of the document.
onBehalfOfstring	The on behalf email address of the sender.

Example response

200 Success

Contains the PDF document