Skip to content
  1. Blog
  2. API

How to Download an Audit Trail PDF Using the BoldSign API

TL;DR: Send one request to GET /v1/document/downloadAuditLog with the documentId of a completed document, and we return its audit trail as a PDF. Add onBehalfOf when the document went out for another sender. The BoldSign eSignature API page covers the rest of the API.

A customer disputes a contract months after signing it. Your team has the signed PDF, but they also need to show who signed, when and from where. That record is the audit trail.

This guide shows how to download audit trail PDFs from your own code with the BoldSign API. It covers regular documents and documents sent on behalf of someone else.

What is an audit trail in BoldSign?

An audit trail is a PDF record of everything that happened to a document during signing. We create one for each document and you download it once signing is complete.

Think of it like the stamped log at a post office counter. The parcel is the signed contract, and the log shows who handed it over and when. Our guide on why e-signature audit trails matter explains the idea in more depth.

What does a BoldSign audit trail include?

Each audit trail lists the document’s details and every step of the signing history. Here is what you will find in it:

  • The document ID, name, sender and signers
  • The internet protocol (IP) address of each signer
  • A timestamp for each action recipients took
  • A hash of the digitally signed document

The hash lets you check that nobody changed the signed file after signing. Our eSignature audit trail page covers audit trails in the web app.

When does downloading audit trails matter most?

Download audit trails from your code when you handle many signed documents and need the proof on hand. These cases come up often:

  • Several departments sign contracts with vendors, clients or staff
  • Your legal team needs signing history for a dispute
  • An auditor asks for proof that a document has not changed
  • Your records policy keeps the audit trail next to each signed file

What do you need before you call the audit trail API?

You need an account, a way to authenticate and the ID of a completed document. Check this list first:

You also need the sender’s email for onBehalfOf when someone else sent the document. The API documentation lists every parameter.

Which authentication header do you send?

Send your key in the X-API-KEY header when you use an API key. Send Authorization: Bearer <access_token> when you use an OAuth 2.0 access token.

Which endpoint do you use to download audit trails?

You use the same endpoint for regular and on-behalf documents. Only the inputs change.

Task Method and path Required inputs Output
Audit trail for a regular document GET /v1/document/downloadAuditLog documentId Audit trail PDF
Audit trail for an on-behalf document GET /v1/document/downloadAuditLog documentId, onBehalfOf Audit trail PDF

How do you download an audit trail for a regular document?

Pass the documentId of the signed document as a query parameter. The samples below call the endpoint from the command line and with each of our software development kits (SDKs).

curl -X GET \
  'https://api.boldsign.com/v1/document/downloadAuditLog?documentId={Your document Id}' \
  -H 'accept: application/pdf' \
  -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.DownloadAuditLog("YOUR_DOCUMENT_ID");
import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
    document_stream = document_api.download_audit_log(document_id="YOUR_DOCUMENT_ID")
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;

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

$documentApi = new DocumentApi($config);
$document_stream = $documentApi->downloadAuditLog($document_id = 'YOUR_DOCUMENT_ID');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(client);
File documentStream = documentApi.downloadAuditLog("YOUR_DOCUMENT_ID", null);
import { DocumentApi } from "boldsign";

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

const documentStream = documentApi.downloadAuditLog("YOUR_DOCUMENT_ID");

Each call returns the PDF as a stream. Write it to a file or to your storage service.

How do you download an audit trail for a document sent on behalf of others?

Add the onBehalfOf parameter with the email address of the sender you acted for. Leave it out for documents you sent from your own address.

Say you sent a contract for a manager from your account. Put the manager’s email address in onBehalfOf, and you can download the audit trail without their login. Our guide on sending documents on behalf of others with the API covers the sending side.

Tip: URL encode the onBehalfOf value when the email address holds special characters such as + or spaces.

curl -X GET \
  'https://api.boldsign.com/v1/document/downloadAuditLog?documentId=YOUR_DOCUMENT_ID&onBehalfOf=ON_BEHALF_EMAIL' \
  -H 'accept: application/pdf' \
  -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.DownloadAuditLog("YOUR_DOCUMENT_ID", "ON_BEHALF_EMAIL");
import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
    document_stream = document_api.download_audit_log(
        document_id="YOUR_DOCUMENT_ID", on_behalf_of="ON_BEHALF_EMAIL"
    )
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;

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

$documentApi = new DocumentApi($config);
$document_stream = $documentApi->downloadAuditLog($document_id = 'YOUR_DOCUMENT_ID', $on_behalf_of = 'ON_BEHALF_EMAIL');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(client);
File documentStream = documentApi.downloadAuditLog("YOUR_DOCUMENT_ID", "ON_BEHALF_EMAIL");
import { DocumentApi } from "boldsign";

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

const documentStream = documentApi.downloadAuditLog("YOUR_DOCUMENT_ID", "ON_BEHALF_EMAIL");

How do teams use audit trail downloads?

Most teams download the audit trail as soon as a document is complete. Two short examples show why.

Example 1: Vendor contracts

A company downloads the audit trail after each completed vendor contract. It stores the file next to the signed PDF, so audit preparation takes less searching.

A dispute comes up over a signed agreement. The legal team pulls the audit trail and checks these details:

  • Who signed, by name and email
  • When each signer acted
  • Which IP address each signer used
  • Whether the document hash still matches

Which BoldSign plan do you need for the audit trail API?

Every BoldSign plan, including the free one, includes sandbox API access for testing. Live API calls need the Enterprise API plan, from $30 a month with 40 envelopes, billed yearly.

Each extra envelope on that plan costs $0.75. Prices are in USD, as of November 2026, and the pricing page lists every plan.

How do you start downloading audit trails with BoldSign?

Try the endpoint in the sandbox first, then move it to production. Here are three next steps:

Frequently asked questions

What details does an audit trail include?

It lists the document ID, name, sender and signers, with internet protocol (IP) addresses, timestamps and each action taken. View audit trail details.

Can I download on-behalf audit trails?

Yes. Add the onBehalfOf parameter with the sender's email address next to the documentId. You then download it from your own account.

When can I download the audit trail of a document?

After every signer has finished signing. The audit trail belongs to completed documents, so a call for a document still out for signature will not return it.

What format is the audit trail download?

You get a PDF file. Save the response stream to disk or to your storage service, next to the signed document.

How do I check that a signed document has not changed?

Use the hash in the audit trail PDF. It belongs to the digitally signed document, so a changed file no longer matches it.

Do I need an API key to download an audit trail?

You need either an API key or an OAuth 2.0 access token. Send the key in the X-API-KEY header, or the token as a bearer token.

Can I test the audit trail API for free?

Yes. A free API sandbox account lets you send test documents, sign them and download their audit trails. Sandbox documents carry a watermark.

Which programming languages can download audit trails?

We offer software development kits (SDKs) for C#, Python, Java, Node.js and more, each with a download audit log method. You can also call the endpoint from the command line.

Ranjitha Vazhivittan

Ranjitha is a skilled software developer with 3 years of experience at BoldSign. Alongside her technical expertise, she has a passion for writing and enjoys sharing thoughtful insights on technology and development. Beyond work, she stays curious by exploring emerging tools and trends, constantly seeking opportunities to learn and grow.

More posts by Ranjitha Vazhivittan
Get started

Sign up for your free trial today!

Start free trial
  • 30-day free trial
  • No credit card required