Download audit trail

get/v1/document/downloadAuditLog

Returns the audit log for the completed document in PDF format for the specified document Id. This audit trail document will contain information about the different actions performed by the recipients with time stamp along with hash of the digitally signed document, which can be used to determine if the signed document is modified.

When the document is created on behalf of a particular sender email, then the download audit trail 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/downloadAuditLog?documentId=949ebf20-45a8-4a3e-91a9-68e9540e0020' \
     -H 'accept: application/json' \
     -H 'X-API-KEY: {your-api-key}'

var documentId = "949ebf20-45a8-4a3e-91a9-68e9540e0020";
ApiClient apiClient = new ApiClient("https://api.boldsign.com", "your API key");
DocumentClient documentClient = new DocumentClient(apiClient);
var documentStream = await documentClient.DownloadAuditLog(documentId).ConfigureAwait(false);

import boldsign

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

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

<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$document_api = new BoldSign\Api\DocumentApi($config);
$download_audit_log_response = $document_api->downloadAuditLog($document_id = 'YOUR_DOCUMENT_ID');

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
        
DocumentApi documentApi = new DocumentApi(client); 
File downloadAuditLogResponse = documentApi.downloadAuditLog("YOUR_DOCUMENT_ID", null);

import { DocumentApi } from "@boldsign/node-sdk";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

documentApi.downloadAuditLog("YOUR_DOCUMENT_ID");

Query parameters

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

Example response

200 Success

Contains the audit PDF document