Explore BoldSign APIs in Postman: A step-by-step guide

The BoldSign Postman collection makes it really easy for you to effectively work with BoldSign APIs to build and test your applications in the Postman app itself. This article provides a step-by-step guide for exploring and testing these APIs by sending HTTP requests and receive responses. Simply create a free sandbox in BoldSign to get started. Let’s dive in and start exploring BoldSign APIs with the Postman collection!

Fork the collection

You can start by forking the BoldSign API collection to your workspace by clicking the button below. This creates a copy of the original collection under your workspace so that you can make further modifications to it.

If you want to view the BoldSign page in Postman or view the BoldSign API collection, you can do so by following the links before forking the collection.

Authorize

Authorization confirms that you are a valid BoldSign user. There are a variety of authorization types available. The easiest way to authorize your requests is to add your X-API-KEY. To do that, you need to create and obtain your API token from the BoldSign application:
  1. Navigate to this page in your BoldSign application.
  2. Click Generate API and a pop-up will be displayed. In that, click Generate Token.
  3. The API key will be generated now, and you can copy it from the Manage Keys section.
Read more details about API key generation process from this article: Create API Key.
Then, you can proceed with the following steps:
  1. Click the Authorization tab, and you can see all the supported types in the dropdown.
  2. Now select the API Key in the Type dropdown.
  3. Enter X-API-KEY in the Key field and the valid API key in the Value field.
  4. Select Header in the Add to field and click Save.

Try out the APIs

You are now ready to start using the BoldSign APIs in Postman. Send API requests by specifying the required parameters. One more thing that you need to do is to change the authorization type to Inherit auth from parent in the APIs. This will take the authorization key values from the collection. You can do this by clicking the required API and navigating to its Authorization tab.

Sending a document

Send a document out for eSignature using the Document Send API in the Documents category. Click that API and move to the Body section. The required parameters are auto selected. You can just replace the values of the following parameters with your desired values.
  • Title – Title for the signature request
  • Signers[0][Name] – Signer’s name
  • Signers[0][EmailAddress] – Signer’s email address
  • Files – The files to be uploaded for the signature request
Click Send. The signature request document is created now, and that document’s ID will be displayed in the Body section. Copy that ID for further use.

Check out all the parameters and read more details about the Document Send API from this article.

Signing a document

The signer will receive an email about the signature request and can sign by clicking the Review and Sign button in that email. It is not mandatory for the signer to have a BoldSign account to sign a document.

Checking document status

You will receive an email when the signer has signed the document. You can also check the current status and get a entire summary of the document using the Document Properties API in the Documents category. Enter the copied document’s ID in the params and send the request.
The document’s entire details will be displayed in the Body section. The status Completed denotes that the document has been signed by all the signers.

Download the signed document and audit trail

You will receive the completed document and audit trail document in an email when all the signers have signed the document. You can also download the document using the Document Download API and download the audit trail using the Document AuditTrail API in the Documents category.
Enter the ID of the document in the params and click Send. The document will be displayed in the body section. If you want to download the document to your file system, click the dropdown next to the Send button and select Send and Download.

Conclusion

Thanks for reading this far. I hope this walkthrough of the document’s features gave you enough knowledge to explore other APIs available  in BoldSign. You can also check out the developer documentation to learn more about BoldSign APIs.

Please let us know in the comments section below if you have any feedback. You can also reach us through our support portal or feedback portal.

Share this blog

Subscribe RSS feed
Jayavigneshwaran

Jayavigneshwaran

Jayavigneshwaran is a Product Manager at Syncfusion. He is passionate about Web technologies and the Flutter framework and has been active in development since 2013.

Share this blog

Jayavigneshwaran

Jayavigneshwaran

Jayavigneshwaran is a Product Manager at Syncfusion. He is passionate about Web technologies and the Flutter framework and has been active in development since 2013.

Subscribe RSS feed

Leave a Reply

Your email address will not be published. Required fields are marked *