How to hide the document ID while sending the document using BoldSign API?

When sending documents to signers via BoldSign, you might have specific preferences regarding the visibility of document IDs within the document itself. BoldSign provides a feature that allows you to control whether the document ID should be visible in the document or not.

Hide document ID in the document

When you want to hide the document ID in the document, set the HideDocumentId property to true in the send API call.

Here are code examples demonstrating how to achieve this:

Code snippet

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 'HideDocumentId= true' \
    -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"
}' \
 -F 'Files={your file}' \
 -F 'Title={title}' \

In these examples, set the HideDocumentId property to true to hide the document ID in the document. When executing the above code, ensure that you provide the necessary fields such as Files, Title, and Signers.

By following these steps and setting the HideDocumentId property as needed, you can control whether the document ID is visible or hidden in the documents you send via BoldSign API.

For a visual reference, take a look at the images as follows.

Document Id visible in the document

Document ID hidden in the document