Combine audit trail and signed document using API
BoldSign provides the option to combine an audit trail with the signed document using its API.
The following are the detailed instructions on how to effectively combine signed documents with their corresponding audit trails using the API:
Creating a brand with combine audit trail option
To initiate the process, you need to create a brand with Combine Audit Trail
option enabled. This configuration will ensure that both the audit trail and the signed document are combined in the final output.
Here are example codes that can be used to do this:
Code snippet
curl -X 'POST' \ 'https://api.boldsign.com/v1/brand/create' \
-H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
-H 'X-API-KEY: {your API key}' \
-F 'CombineAuditTrail=true' \
-F 'BrandLogo={Your logo file}' \
-F 'BrandName={Your brand Name}' \
In the provided example, the crucial step is setting the CombineAuditTrail
parameter to true, enabling the combination of the audit trail and the signed document. Ensure that you input the necessary details, such as BrandName
and BrandLogo
. The brand logo must be in formats like JPG, JPEG, or PNG. Execute the above to create a brand with the Combine Audit Trail
option enabled.
Send document with the brand with combine audit trail
Once you have a brand with the combine audit trail option enabled, proceed to create a document using the API. Associate the brand with the desired combination of the audit trail and the signed document.
Code snippet to create a document with combine audit trail and signed document
curl -X 'POST' \ 'https://api.boldsign.com/v1/document/send' \
-H 'accept: application/json' \
-H 'X-API-KEY: {your API key}' \
-H 'Content-Type: multipart/form-data' \
-F 'BrandId= {your brand ID}' \
-F 'Message=' \
-F 'Signers={
"name": "Hanky",
"emailAddress": "hankyWhites@cubeflakes.com",
"signerType": "Signer",
"formFields": [
{
"id": "string",
"name": "string",
"fieldType": "Signature",
"pageNumber": 1,
"bounds": {
"x": 50,
"y": 50,
"width": 1,
"height": 1
},
"isRequired": true
}
],
"locale": "EN"
}' \
In the provided example, replace BrandId
with the actual brand id in which the combine audit trail option is enabled. Once the signer completes the signing process, you can download the document containing both the signed document and the accompanying audit trail.