API Documentation

Blogs
Demos
Login
Create API Sandbox

Blogs Demos Login

US

Create API Sandbox

API Overview

Getting started
Developer sandbox account
API in Postman
Open API specification
API explorer
Requests
Versioning
Client libraries
Rate limit
Changelog
Feedback
Security

Authentication

Introduction
API key
OAuth 2.0

Documents

Send document
Send document from template
Send document using multiple templates
Send document on-behalf
Send document from draft
Edit document
List documents
List team documents
Behalf list documents
Document details and status
Send reminder
Extend document expiry
Revoke document
Download document
Download audit trail
Delete document
Add authentication to the document
Remove authentication from the document
Change access code
Add document tags
Delete document tags
Prefill form fields

Template

Create template
List templates
Delete template
Download template
Template details
Edit template
Add template tags
Delete template tags

Embedded Signing

Create embedded signing link
Embed in an iFrame

Embedded Request

Create embedded request link
Create embedded request link from template
Create embedded request link using multiple templates
Embed in an iFrame

Embedded Template

Create embedded template
Edit embedded template
Embed in an iFrame

Identity Verification

Introduction
Verification report
Verification image
Embedded manual verification
Prefill using verification data
Sandbox mode

Text Tags

Introduction
Supported fields
Advanced usage

Sender Identities

Create identity
Update identity
Delete identity
Resend invitation
Rerequest
List identities
Identity details

Webhooks

Introduction
Available Events
Setting up a webhook
Webhook configuration and lifecycle
Listen for callback
Custom headers
Event metadata
Sample event data
Test webhooks
Verify webhook events
IP WhiteListing
Go Live

Users

Create user
Update user role
List users
Get user details
Resend user invitation
Cancel user invitation
Update metadata
Change team

Teams

Create team
Update team
Get team details
List teams

Branding

Create brand
Update brand
List brands
Get brand
Delete brand
Reset brand settings to default

Custom Field

Create custom field
Edit custom field
List custom field
Delete custom field
Embedded custom field create url

Contacts

Create contact
Update contact
List Contacts
Delete Contact
Get Contact

Plan

Get balance document credits

Troubleshooting

Possible errors and solution

SDKs

Overview
.NET SDK
Python SDK
PHP SDK
Java SDK
Node.js SDK

How-to guides

Apply branding to documents using API
Change recipient of the document
Combine audit trail and signed document using API
Configuring the embedded link expiration in BoldSign
Create an API app with BoldSign
Create conditional fields using API
Customize the embedded send toolbars in your application
Difference between BoldSign API and web application
Disable all email notifications using API
Disable expiry notification for the signers
Download document using BoldSign API
Download on behalf of document
Embed the document creation into your application
Embed the template creation into your application
Extend the Expiry Date of a Document Using BoldSign API
How to add radio buttons to the document using BoldSign API?
How to add custom information to your document?
How to allow signers to reassign the document using BoldSign API?
How to download the attachments in document using BoldSign API?
How to add SMS authentication to signature requests using BoldSign API?
How to hide the document ID while sending the document using BoldSign API?
How do I know whether my document or template is ready for eSignature?
How to manage API rate limits in BoldSign?
How to prevent signers from reassigning the document?
How to send document from template and notify the signer through email using BoldSign API?
How to send document by merging multiple templates and notify the signer through email using BoldSign API?
How to send reminders for waiting or in-progress documents?
How to set the form fields required by the signers via API?
How to send document to the signer via email using BoldSign API?
How to retrieve document history using BoldSign API?
How to retrieve document information using BoldSign API?
How to send document using multiple templates by filling existing form fields?
How to track the documents based on the status using BoldSign API?
Integrate embedded requsets into your application
Integrate embedded signing into your application
Place form fields to the document
How to Add Checkbox FormField to the Document via BoldSign API?
Redirect to specific page after signing the document
Restrict Sending and Enable Draft Saving for Embedded Requests
Send document from template by filling existing fields
Send document on behalf of others
Send document to multiple recipients
Send document with in-person signing using API
How to set hyperlink form fields while making an electronic signature request via API?
Set Language for Embedded Sign Page
How to allow signers to upload images before complete signing the electronic signature request via API?
Set Language for Embedded Send Requests
What are the options you have with a BoldSign Trial account and Developer Sandbox account?
SSL/TLS Requirements and Best Practices
How to set automatic reminders for electronic signature requests through API?
Troubleshooting Invalid Email address error in BoldSign API
How to send a signature request through both SMS and email using BoldSign API?
Why can't I access older envelopes in my Sandbox account?
How to set the prefilled value for form fields using BoldSign API?
How to authenticate signers with an access code before allowing them to sign the document using BoldSign API?
How to add additional form fields for signers when sending a document from a template using API?
How to create non editable form fields with BoldSign API?
How to set date format for date-signed and editable-date fields using BoldSign API?
How to add Dropdown field for signers while sending an eSignature request via API?
How to set text direction for text boxes using BoldSign API?
How to set character limit for form fields while making an electronic signature request via API?
How to Set Up Synchronizing Form Field Values Across the Document for Signature Requests via API?
How to Customize Form Field Fonts in eSignature Requests via API?
How to require signers to upload supporting documents before completing the signing process?
How to set date range for editable date fields using BoldSign API?
How to request a signature with Signer Authentication (Email, Access Code, or SMS) using BoldSign API?
How to request signature with text tags for dynamic documents in BoldSign API?
How to allow signers to configure their own form fields?
How to set multiple CCs for signer to sign the document using BoldSign API?
How to request eSignature via SMS (Text Messages) using BoldSign API?
How to send a private message to the signer when sending a document via API?
How to add email authentication for the signer after sending the document?
How to add SMS authentication for the signer after sending the document?
How to request the signatures without email notifications using BoldSign API?
How to disable email notifications when sending document from template using BoldSign API?
How to allow signers to print and sign the document using BoldSign API?
How to set signer language for an eSignature document using BoldSign API?
How to add validation to the textbox form field via API?
How to invite new users to a team using BoldSign API?
How to list the behalf documents using BoldSign API?
How to implement OAuth authentication in a .NET application using the BoldSign API?
How to implement OAuth authentication in a Python application using the BoldSign API?
How to implement OAuth authentication in a Node.js application using the BoldSign API?
How to send document from template with auto reminder using BoldSign API?
How to get signatures by prefilling readonly form fields?
How to delete a template via BoldSign API?
How to prefill values for radio button while sending documents from template?
How to prefill values for radio button after sending documents from template?
How to provide background color for label fields while sending document?
How to add additional files while sending document from template?
How to add metadata while sending document for e-signature?
How to allow signers to sign in a particular order?
How to add a file as a base64 string when sending a document for signature?
How to hide standard form fields using branding via BoldSign API?
How to prefill image field when sending document from template?
How to prefill values for image field after sending document for e-Signature?
How to verify the signer with Email OTP while making eSignature requests?
How can you show custom form fields to users while creating a document or template using branding?
How to add files using file URLs when sending a document for eSignature?
How to prefill values for label field while sending document from template for signature?
Request an eSignature via SMS when sending a document from a template
How to delete a document via BoldSign API?
How to add access code authentication for the signer after sending the document?
How to request signature by email and SMS when sending document from template?
How to remove authentication after sending the document?
How to revoke or cancel a document via the API?
How to change the access code for a signer to access the document via the API?
How to configure recipient notifications in BoldSign using API requests?
How to replace fillable fields with BoldSign form fields via API?
How to add group checkboxes to the document using BoldSign API?
How to create a Template using BoldSign API?
How to create a custom field using BoldSign API?
How to delete a custom field using BoldSign API?
How to list custom fields using BoldSign API?
How to update meta data to the users in the organization via API?
How to get the identity verification report via API?
How to edit a custom field using BoldSign API?
How to set a checkbox field to checked and read-only by default when sending documents using API?
How to remove existing form fields when sending a document from a template?
How to get the uploaded Identity verification document via API?
How to customize signed document naming using BoldSign API?
How to remove specific roles When sending a document from a Template using BoldSign API?

Release notes

v6.0.28-beta

Tue, 26 August, 2025

Feature

Added support to get the specific sender identity details through GetProperties API.

In this article

Feature

Copyright 2001-2025 Syncfusion Inc.All Rights Reserved

Quick Links

Pricing
Help Center
Blog
eSignature API
API Demos
Status

Trust & Security

Privacy Policy
Cookie Policy
Security Policy
Ethics Policy
Terms of Use
Electronic Signature Disclosure
Responsible Disclosure

Company

About Us
Contact Us
Become a Partner

Quick Links

Pricing
Help Center
Blog
eSignature API
API Demos
Status

Trust & Security

Privacy Policy
Cookie Policy
Security Policy
Ethics Policy
Terms of Use
Electronic Signature Disclosure
Responsible Disclosure

Company

About Us
Contact Us
Become a Partner

Copyright 2001-2025 Syncfusion Inc.All Rights Reserved