Edit Document

put/v1-beta/document/edit

The Edit Document API allows users to modify the properties of an existing document and draft document. It facilitates updates to various properties such as the title, description, files, signers, and form fields associated with the document.

Partial Update

Users can execute partial updates to a document by specifying only the fields they intend to modify. The API will solely modify the provided fields, leaving the remainder unchanged.

When you need to update a files, signers or its form fields, you need to provide EditAction such as Add, Update, or Remove. So, if you need to update or remove a file, signer or their form fields, you will need to provide the file ID, signer ID and form field ID, which you can retrieve using the Document Properties API that returns all properties of a given document.

Asynchronous Document Processing

This API operates in two different modes based on the input provided in the request body. If the input contains the files, the API will process the request asynchronously. If the input does not contain the files, the API will process the request synchronously. This will be represented in the response as status with the value Queued or Completed, respectively.

The system will trigger either an Edited or EditFailed event, indicating the success or failure of the operation. In the event of failure, the system will send an EditFailed event along with an accompanying error message. It is imperative to address and resolve this error to ensure the proper operation in the next request.

Code Snippet

In the example request below, we are updating the document's description and a signer associated with the document, along with their form fields.

curl -X PUT 'https://api.boldsign.com/v1-beta/document/edit?documentId=2f0df291-xxxx-xxxx-xxxx-97719d93c8b7' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: {API-KEY}' \
-d '{
    "Message": "Please sign this document.",
    "Signers": [
        {
            "EditAction": "Update",
            "Id": "4771b255-xxx-xxxx-xxxx-3819b11e4b3b",
            "AuthenticationType": "EmailOTP",
            "FormFields": [
                {
                    "EditAction": "Update",
                    "Id": "signature_iYQVu",
                    "FieldType": "Initial",
                    "IsRequired": false
                },
                {
                    "EditAction": "Add",
                    "FieldType": "TextBox",
                    "Bounds": {
                        "X": 100,
                        "Y": 100,
                        "Width": 100,
                        "Height": 20
                    },
                    "IsRequired": false,
                    "PageNumber": 1
                }
            ]
        },
        {
            "EditAction": "Add",
            "Name": "Signer",
            "EmailAddress": "[email protected]",
            "AuthenticationType": "AccessCode",
            "AuthenticationCode": "1234",
            "FormFields": [
                {
                    "EditAction": "Add",
                    "FieldType": "Signature",
                    "Bounds": {
                        "X": 150,
                        "Y": 150,
                        "Width": 200,
                        "Height": 30
                    },
                    "IsRequired": true,
                    "PageNumber": 1
                }
            ]
        }
    ],
    "Labels": ["Label1", "Label2"],
    "ReminderSettings": {
        "EnableAutoReminder": true,
        "ReminderDays": 2,
        "ReminderCount": 4
    },
    "DocumentDownloadOption": "Individually"
}'

var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");

var documentClient = new DocumentClient(apiClient);

var editDocumentRequest = new EditDocumentRequest()
{
    DocumentId = "6f0cff9e-xxxx-xxxx-xxxx-a78e389964c2",
    Message = "Please sign this document.",
    Signers = new List<EditDocumentSigner>()
    {
        new EditDocumentSigner()
        {
            EditAction = EditAction.Update,
            Id = "3ca6a81a-xxxx-xxxx-xxxx-f88e63f2ca6d",
            AuthenticationType = AuthenticationType.EmailOTP,
            FormFields = new List<EditFormField>()
            {
                new EditFormField()
                {
                    EditAction = EditAction.Update,
                    Id = "signature_iYQVu",
                    Type = FieldType.Initial,
                    IsRequired = false,
                },
                new EditFormField()
                {
                    EditAction = EditAction.Add,
                    Type = FieldType.TextBox,
                    IsRequired = false,
                    Bounds = new Rectangle()
                    {
                        X = 100,
                        Y = 100,
                        Width = 100,
                        Height = 20,
                    },
                    PageNumber = 1,
                },
            },
        },
        new EditDocumentSigner()
        {
            EditAction = EditAction.Add,
            Name = "Signer",
            EmailAddress = "[email protected]",
            AuthenticationType = AuthenticationType.AccessCode,
            AuthenticationCode = "1234",
            FormFields = new List<EditFormField>()
            {
                new EditFormField()
                {
                    EditAction = EditAction.Add,
                    Type = FieldType.Signature,
                    IsRequired = false,
                    Bounds = new Rectangle()
                    {
                        X = 150,
                        Y = 150,
                        Width = 200,
                        Height = 30,
                    },
                    PageNumber = 1,
                },
            },
        },
    },
    Labels = new List<string>()
    {
        "Label1",
        "Label2",
    },
    ReminderSettings = new ReminderSettings()
    {
        EnableAutoReminder = true,
        ReminderCount = 4,
        ReminderDays = 2,
    },
};

documentClient.EditDocument(editDocumentRequest);

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)
    document_id = "6f0cff9e-xxxx-xxxx-xxxx-a78e389964c2"

    signer1 = EditDocumentSigner(
        edit_action="Update",
        id="3ca6a81a-xxxx-xxxx-xxxx-f88e63f2ca6d",
        authentication_type="EmailOTP",
        form_fields=[
            EditFormField(
                edit_action="Add",
                fieldType="TextBox",
                is_required=False,
                bounds=Rectangle(x=100, y=100, width=100, height=20),
                page_number=1
            )
        ]
    )

    signer2 = EditDocumentSigner(
        edit_action="Add",
        name="Signer",
        email_address="[email protected]",
        authentication_type="AccessCode",
        authentication_code="1234",
        form_fields=[
            EditFormField(
                edit_action="Add",
                type="Signature",
                is_required=False,
                bounds=Rectangle(x=150, y=150, width=200, height=30),
                page_number=1
            )
        ]
    )

    document_file = EditDocumentFile(
        edit_action="Add",
        file='YOUR_FILE_PATH'
    )

    edit_request = EditDocumentRequest(
        message="Please sign this document.",
        files=[document_file],
        signers=[signer1],
        labels=["Label1", "Label2"],
        reminder_settings=ReminderSettings(
            enable_auto_reminder=True,
            reminder_count=4,
            reminder_days=2
        )
    )
    response = document_api.edit_document(document_id, edit_request)

<?php
require_once(__DIR__ . '/../vendor/autoload.php');

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\EditDocumentRequest;
use BoldSign\Model\EditDocumentSigner;
use BoldSign\Model\EditFormField;
use BoldSign\Model\Rectangle;
use BoldSign\Model\ReminderSettings;
use BoldSign\Model\EditDocumentFile;

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

$apiInstance = new DocumentApi($config);
$document_id = "6f0cff9e-xxxx-xxxx-xxxx-a78e389964c2";

$formField1 = new EditFormField();
$formField1->setEditAction("Update");
$formField1->setId("signature_iYQVu");
$formField1->setFieldType("Initial");
$formField1->setIsRequired(false);

$formField2 = new EditFormField();
$formField2->setEditAction("Add");
$formField2->setFieldType("TextBox");
$formField2->setIsRequired(false);
$formField2->setBounds(new Rectangle([100, 100, 100, 20]));
$formField2->setPageNumber(1);

$signer1 = new EditDocumentSigner();
$signer1->setEditAction("Update");
$signer1->setId("3ca6a81a-xxxx-xxxx-xxxx-f88e63f2ca6d");
$signer1->setAuthenticationType("EmailOTP");
$signer1->setFormFields([$formField1, $formField2]);


$formField3 = new EditFormField();
$formField3->setEditAction("Add");
$formField3->setFieldType("Signature");
$formField3->setIsRequired(false);
$formField3->setBounds(new Rectangle([150, 150, 200, 30]));
$formField3->setPageNumber(1);

$signer2 = new EditDocumentSigner();
$signer2->setEditAction("Add");
$signer2->setName("Signer");
$signer2->setEmailAddress("[email protected]");
$signer2->setAuthenticationType("AccessCode");
$signer2->setAuthenticationCode("1234");
$signer2->setFormFields([$formField3]);


$document1 = new EditDocumentFile();
$document1->setFileUrl("YOUR_FILE_URL");
$document1->setEditAction('Add');


$reminderSettings = new ReminderSettings();
$reminderSettings->setEnableAutoReminder(true);
$reminderSettings->setReminderCount(4);
$reminderSettings->setReminderDays(2);

$edit_document_request = new EditDocumentRequest();
$edit_document_request->setMessage('Please sign this document.');
$edit_document_request->setSigners([$signer1, $signer2]);
$edit_document_request->setFiles([$document1]);
$edit_document_request->setLabels(["Label1", "Label2"]);
$edit_document_request->setReminderSettings($reminderSettings);
$edit_document_response = $apiInstance->editDocument($document_id, $edit_document_request);

import * as fs from 'fs';
import {
    DocumentApi,
    EditDocumentFile,
    EditDocumentRequest,
    EditDocumentSigner,
    EditFormField,
    Rectangle,
    ReminderSettings
} from '../api';

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

const documentId = "6f0cff9e-xxxx-xxxx-xxxx-a78e389964c2";

const bounds1 = new Rectangle();
bounds1.x = 100;
bounds1.y = 100;
bounds1.width = 100;
bounds1.height = 20;

const formField1 = new EditFormField();
formField1.editAction = EditFormField.EditActionEnum.Update;
formField1.id = "signature_iYQVu";
formField1.fieldType = EditFormField.FieldTypeEnum.Initial;
formField1.isRequired = false;

const formField2 = new EditFormField();
formField2.editAction = EditFormField.EditActionEnum.Add;
formField2.fieldType = EditFormField.FieldTypeEnum.TextBox;
formField2.isRequired = false;
formField2.bounds = bounds1;
formField2.pageNumber = 1;

const signer1 = new EditDocumentSigner();
signer1.editAction = EditDocumentSigner.EditActionEnum.Update;
signer1.id = "3ca6a81a-xxxx-xxxx-xxxx-f88e63f2ca6d";
signer1.authenticationType = EditDocumentSigner.AuthenticationTypeEnum.EmailOtp;
signer1.formFields = [formField1, formField2];

const bounds2 = new Rectangle();
bounds2.x = 150;
bounds2.y = 150;
bounds2.width = 200;
bounds2.height = 30;

const formField3 = new EditFormField();
formField3.editAction = EditFormField.EditActionEnum.Add;
formField3.fieldType = EditFormField.FieldTypeEnum.Signature;
formField3.isRequired = false;
formField3.bounds = bounds2;
formField3.pageNumber = 1;

const signer2 = new EditDocumentSigner();
signer2.editAction = EditDocumentSigner.EditActionEnum.Add;
signer2.name = "Signer";
signer2.emailAddress = "[email protected]";
signer2.authenticationType =EditDocumentSigner.AuthenticationTypeEnum.AccessCode;
signer2.authenticationCode = "1234";
signer2.formFields = [formField3];

const documentfile = new EditDocumentFile();
documentfile.file = fs.createReadStream("YOUR_FILE_PATH");
documentfile.editAction = EditDocumentFile.EditActionEnum.Add;

const reminderSettings = new ReminderSettings();
reminderSettings.enableAutoReminder = true;
reminderSettings.reminderCount = 4;
reminderSettings.reminderDays = 2;

const editDocumentRequest = new EditDocumentRequest();
editDocumentRequest.message = "Please review and sign the attached document.";
editDocumentRequest.signers = [signer1, signer2];
editDocumentRequest.files = [documentfile];
editDocumentRequest.labels = ["Label1", "Label2"];
editDocumentRequest.reminderSettings = reminderSettings;
const editDocumentResponse = await documentApi.editDocument(documentId, editDocumentRequest);

ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(apiClient);

Rectangle bounds = new Rectangle();
bounds.setX(50f);
bounds.setY(100f);
bounds.setWidth(100f);
bounds.setHeight(60f);

EditFormField formField = new EditFormField();
formField.setEditAction(EditFormField.EditActionEnum.ADD);
formField.setFieldType(EditFormField.FieldTypeEnum.SIGNATURE);
formField.setPageNumber(1);
formField.setBounds(bounds);

EditDocumentSigner signers = new EditDocumentSigner();
signers.setEmailAddress("[email protected]");
signers.setName("signername");
signers.setFormFields(Arrays.asList(formField));
signers.setEditAction(EditDocumentSigner.EditActionEnum.ADD);

EditDocumentFile document1 = new EditDocumentFile();
document1.setEditAction(EditDocumentFile.EditActionEnum.ADD);
document1.setFileUrl( new URI( "YOUR_FILE_URL"));

EditDocumentRequest editDocumentJsonRequest = new EditDocumentRequest();
editDocumentJsonRequest.setSigners(Arrays.asList(signers));
editDocumentJsonRequest.setMessage("Updated documments");
editDocumentJsonRequest.setFiles(Arrays.asList(document1));
String documentId = "6f0cff9e-xxxx-xxxx-xxxx-a78e389964c2";

documentApi.editDocument(documentId, editDocumentJsonRequest);

Request Body

Filesarray

Details of the files to be edited. One or more files can be specified.

EditActionstringRequired	This is used to specify the edit action to be performed on the file. They are `Add`, `Update`, and `Remove`.
Idstring	ID of the file. This ID used to identify and target the specific file to perform the edit action. Note : This is required only for `Update` and `Remove` actions.
FileFormFile	The file to be uploaded for sending signature request. `.pdf`, `.png`, `.jpg`, and `.docx` are supported file formats. The preferred file format is `.pdf`. You can upload up to 25 files. Each document may have a maximum of 1000 pages and must be no larger than 25 MB in size. For a single file with file name, the Base64 format should be: `{ "base64": "data:application/{{fileType}};base64,{{content}}", "fileName": "{{fileName}}" }`. Note : This is required only for `Add` and `Update` actions.
FileUrlURI	The URL of the file must be publicly accessible. `.pdf`, `.png`, `.jpg`, and `.docx` are supported file formats. The preferred file format is `.pdf`. You can upload up to 25 files. Each document may have a maximum of 1000 pages and must be no larger than 25 MB in size. Note : This is required only for `Add` and `Update` actions.

Titlestring

This is the title of the document that will be displayed in the BoldSign user interface and in the signature request email.

Note : Title can be edited only for draft documents.

Messagestring A message for all recipients. You can include instructions that the signer should know before signing the document.

Signersarray

Details of the signers to be edited. One or more signers can be specified.

EditActionstringRequired This is used to specify the edit action to be performed on the signer. They are Add, Update, and Remove.

Idstring

ID of the signer. This ID used to identify and target the specific signer to perform the edit action.

Note : This is required only for Update and Remove actions.

Namestring Name of the signer. This name will appear on all emails, notifications, and the audit file.

EmailAddressstring Email ID of the signer. This ID will appear on all emails, notifications, and the audit file.

PrivateMessagestring A message that appears when the specified signer proceeds to sign the document. You can include instructions that the signer should know before signing the document.

AuthenticationTypeNullable enum This is used to allow authentication for a specific signer. We have four types of authentication: AccessCode, EmailOTP, SMSOTP, and IdVerification. The default value is None.

AuthenticationCodestring The authentication access code that must be entered by the signer to access the document. This should be shared with the signer.

EnableEmailOTPNullable boolean Enables email OTP authentication. If this is enabled, the signer must enter the OTP received in the email to access the document.

PhoneNumberobject

When you set the authentication type to SMSOTP or select the delivery mode as SMS, EmailAndSMS, or WhatsApp, you can provide the phone number with the country code.

CountryCodestring	This property represents the country code associated with the phone number.
Numberstring	This property represents the actual phone number.

IdentityVerificationSettingsobject

Settings for identity verification when IdVerification authentication type is enabled for the signer.

Typestring	Customize the frequency of identity verification for signers accessing documents. EveryAccess: Signers must undergo identity verification each time they access the document, even after completing their signature. UntilSignCompleted: Identity verification is required until the signer completes their signature, after which they will not need to undergo identity verification again. OncePerDocument: Signers authenticate their identity only once, even if accessing the document multiple times.
MaximumRetryCountinteger	Specify the maximum number of verification attempts allowed for signers. Exceeding this limit restricts access to the document. Senders have the option to reset failed signers for additional attempts and manually review failed document uploads for approval or rejection. The maximum number of retries is 10.
RequireLiveCaptureboolean	Mandate signers to capture a live image of their identification document using their device camera. This verifies the document's authenticity and originality, preventing the use of photos or photocopies.
RequireMatchingSelfieboolean	Uses advanced machine learning algorithms to ensure facial recognition accuracy, preventing the use of stolen identity documents by comparing the photo on the ID and the selfie image.
NameMatcherstring	Define the tolerance level for matching the signer's name with the name on the uploaded identification document. Options include: Strict: Minimal variations are permitted, adhering to strict matching rules. Moderate: Moderate matching rules allow for variations in the middle, prefix, and suffix parts of the name. Lenient: Relaxed matching rules accommodate minor spelling mistakes for increased flexibility.
HoldForPrefillboolean	Enable this option to hold the signer from signing the document, giving you the opportunity to prefill the signer's details. Once the prefill is completed, the signer can proceed with the signing process. The maximum hold time is 30 seconds; if you exceed this time limit, the signer will be redirected to the signing page.

AuthenticationRetryCountNullable integer

Specifies the maximum number of allowed authentication attempts for the signer during the signing process. This applies to the following authentication methods:

AccessCode
EmailOTP
SMSOTP

The retry count must be an integer between 1 and 10. If this property is not specified, the value configured in the business profile will be used automatically. You can learn how to set it here. This property is optional.

DeliveryModeNullable enum This property allows you to specify the desired delivery mode for sending notifications. We have four types of delivery modes: Email, SMS, WhatsApp, and EmailAndSMS. The default value is Email.

SignerOrderNullable integer Signing order of the signer. This is applicable when the signing order option is enabled.

SignerTypeNullable enum Type of the signer. The values are Signer, Reviewer, and InPersonSigner.

HostEmailstring Email ID of the host. It is applicable when the signerType is set to InPersonSigner.

SignerRolestring The role of the signer.

AllowFieldConfigurationNullable boolean This option enables the signer to add fields at their end while signing the document. If this option is set to false, the signer cannot add fields, and they must complete the assigned ones.

FormFieldsarray

List of form fields associated with the signer that need to be edited.

EditActionstringRequired This is used to specify the edit action to be performed on the form field. They are Add, Update, and Remove.

Idstring

The ID of the form field. ID must start with a letter or an underscore and can only contain letters, digits, and underscores.

Note : This is required for Update and Remove actions.

Namestring Name of the form field.

TypeNullable enum

Type of the form field. The available values are Signature, Initial, CheckBox, TextBox, Label, DateSigned, Image, Attachment, EditableDate, Hyperlink, Formula, and Dropdown. The Formula field is only available in the beta version.

Note : To add Email, Name, Title, and Company fields via API, use TextBox fields with the validation type set to Regex.

PageNumberNullable integer

Page number in the document where the form field has to be placed. The page number must be greater than zero.

Note : This is required for Add action.

BoundsRectangle

Position and size values of the form field to be placed.

Note : This is required for Add action.

Xfloat	X coordinate value to place the form field.
Yfloat	Y coordinate value to place the form field.
WidthfloatRequired	Width of the form field. The width must be greater than zero.
HeightfloatRequired	Height of the form field. The height must be greater than zero.

IsRequiredNullable boolean Decides whether this form field is required to be filled or not.

TabIndexNullable integer Assign tab index to control the flow of field focus while using TAB key navigation. Defaults to null, which denotes it will follow regular flow. The accepted range starts from -1 to a valid integer.

BackgroundHexColorstring Customize the label field background color. The value should be a hex color code. Example - #FFFFFF.

Valuestring Value to be displayed on the label form field.

Labelstring The label used to represent the value for a radio button. Also, can be used to prefill a radio button.

FontSizeNullable float Size of the font. The default font size is 13.0.

FontNullable enum Font family. The values are Courier, Helvetica, TimesNewRoman, and NotoSans. The default font family is Helvetica.

FontHexColorstring Color of the font. The value should be a hex color code. Example - #035efc.

IsBoldFontNullable boolean Decides whether the font should be bold or not.

IsItalicFontNullable boolean Decides whether the font should be italic or not.

IsUnderLineFontNullable boolean Decides whether the font should be underlined or not.

LineHeightNullable integer Height of a line in the text. The default line height is 15.0.

CharacterLimitNullable integer Limits the number of characters in the text. The character limit value must be greater than zero.

GroupNamestring The group name of the form field. This field is required when the type is set to RadioButton.

PlaceHolderstring A hint text to be displayed on the text form field by default.

ValidationTypeNullable enum Type of validation for the text box form field. The values are Only Numbers, Regex, Currency, Email, and None. The default validation type is None.

ValidationCustomRegexstring Value for regex validation. This is applicable when the validationType is set to Regex.

ValidationCustomRegexMessagestring Description for regex validation. This message is displayed when the signer enters an invalid regex format value in the text box form field.

DateFormatstring

Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy. When null is provided, the value is inherited from your account's business profile settings. Accepted formats are

MM/dd/yyyy (02/08/2024)
dd/MM/yyyy (08/02/2024)
dd-MMM-yyyy (08-Feb-2024)
MMM-dd-yyyy (Feb-08-2024)
MMM dd, yyyy (Feb 08, 2024)
dd MMM, yyyy (08 Feb, 2024)
yyyy, MMM dd (2024, Feb 08)
yyyy/MM/dd (2024/02/08)
dd-MM-yyyy (08-02-2024)
MM-dd-yyyy (02-08-2024)
yyyy-MM-dd (2024-02-08)

TimeFormatstring

Format of the time to be displayed on the date signed form field. When null is provided, the value is inherited from your account's business profile settings. Accepted formats are

hh:mm tt (12:30 PM)
h:mm tt (2:45 PM)
HH:mm (14:30)
H:mm (9:15)
None (Disabled, no time will be displayed)

ImageInfoobject

Options to customize the image form field.

Titlestring	Title of the image form field.
Descriptionstring	Description of the image form field.
AllowedFileExtensionsstring	Controls the image formats that are allowed to upload on the image form field. The values are `.jpg` or `.jpeg`, `.svg`, `.png`, and `.bmp`.

AttachmentInfoobject

Options to customize the attachment form field.

Titlestring	Title of the attachment form field.
Descriptionstring	Description of the attachment form field.
AllowedFileTypesstring	Controls the file formats that are allowed to upload on the attachment form field. The values are `PDF`, `Document`, and `Image`.

EditableDateFieldSettingsobject

Options to customize the editable date form field.

DateFormatstring

BoldSign API supports a variety of date-time formats, including:

MM/dd/yyyy
dd/MM/yyyy
dd-MMM-yyyy
MMM-dd-yyyy
MMM dd,yyyy
dd MMM,yyyy
yyyy,MMM dd
yyyy/MM/dd
dd-MM-yyyy
MM-dd-yyyy
yyyy-MM-dd

Format of the date to be displayed on the date signed form field. The default value is MM/dd/yyyy.

MinDatestring

The minimum date that can be selected. The string should be in date-time format. The default ISO standard YYYY-MM-DDTHH:MM:SSZ.

Example Format

minDate : 2024-01-01T00:00:00Z

The date-time should be passed in UTC timezone using Z (e.g., 2024-01-01T00:00:00Z).

If using a specific timezone, provide the UTC offset:

IST (UTC+5:30): 2024-01-01T00:00:00+05:30
PST (UTC-8:00): 2024-01-01T00:00:00-08:00

MaxDatestring

The maximum date that can be selected. The string should be in date-time format. The default ISO 8601 standard YYYY-MM-DDTHH:MM:SSZ.

Example Format

maxDate : 2025-12-31T23:59:59Z

Pass the date-time in UTC timezone using Z (e.g., 2025-12-31T23:59:59Z).

For specific timezones, provide the UTC offset:

EST (UTC-5:00): 2025-12-31T23:59:59-05:00
CET (UTC+1:00): 2025-12-31T23:59:59+01:00

ConditionalRulesarray This is used to specify which fields should be visible based on the conditions provided.

HyperLinkTextstring Text to be displayed for the hyperlink.

DataSyncTagstring The value that can be specified on two or more textbox form fields to sync them.

DropDownOptionsarray The values that have to be displayed on the dropdown form field. One or more values can be specified.

IsReadOnlyNullable boolean Decides whether this form field is read-only or not.

TextAlignNullable enum Determines the horizontal alignment of text for the textbox and label form fields, and can be set to Left, Center, or Right. The default alignment of text is Left.

TextDirectionNullable enum Determines the text direction of text for the textbox and label form fields, and can be set to LTR or RTL. The default text direction is LTR.

CharacterSpacingNullable float Determines the character spacing of text for the textbox and label form fields. It can be set as a floating-point value.

CharacterLimitNullable integer Limits the number of characters in the text. The character limit value must be greater than zero.

GroupNamestring The group name of the form field. This field is required when the type is set to RadioButton.

PlaceHolderstring A hint text to be displayed on the text form field by default.

ValidationTypeNullable enum Type of validation for the text box form field. The values are Only Numbers, Regex, Currency, Email, and None. The default validation type is None.

ValidationCustomRegexstring Value for regex validation. This is applicable when the validationType is set to Regex.

ValidationCustomRegexMessagestring Description for regex validation. This message is displayed when the signer enters an invalid regex format value in the text box form field.

FormulaFieldSettingsobject

Options to configure formula field.

FormulaExpressionstring	This property is used to specify the formula as a string to define the calculation or expression for the formula field.
DecimalPrecisioninteger	This property is used to determine the decimal rounding precision for the computed result.

ResizeOptionNullable enum Defines how the Textbox form field resizes based on the entered text. The available values are GrowHorizontally, GrowVertically, GrowBoth, FixedSize, and AutoResizeFont.

AllowEditFormFieldNullable boolean This allows form fields to be edited while sending the document.

AllowDeleteFormFieldNullable boolean This allows form fields to be deleted while sending the document.

LanguageNullable integer Index of the language in which the document signing pages and emails for the signer should render. The supported languages are 1-English, 2-Spanish, 3-German, 4-French, and 5-Romanian. Note that 'locale' should now be used instead of 'language' as it has replaced the deprecated term.

LocaleNullable enum Specify the language index for rendering document signing pages and emails for the signer, choosing from the supported locales such as EN-English, NO-Norwegian, FR-French, DE-German, ES-Spanish, BG-Bulgarian, CS-Czech, DA-Danish, IT-Italian, NL-Dutch, PL-Polish, PT-Portuguese, RO-Romanian, RU-Russian, JA-Japanese, TH-Thai, ZH_CN-Simplified Chinese, Zh_TW-Traditional Chinese, and SV-Swedish. The default locale language is EN-English.

RecipientNotificationSettingsobject

Control email notifications to recipients by configuring the properties within recipientNotificationSettings.

SignatureRequestboolean	Indicates whether the recipient should be notified when a document is sent.
Declinedboolean	Indicates whether the recipient should be notified when a document is declined.
Revokedboolean	Indicates whether the recipient should be notified when a document is revoked.
Signedboolean	Indicates whether the recipient should be notified when a document is signed by another recipient.
Completedboolean	Indicates whether the recipient should be notified when the document is completed.
Expiredboolean	Indicates whether the recipient should be notified when a document expires.
Reassignedboolean	Indicates whether the recipient should be notified when the document is reassigned.
Deletedboolean	Indicates whether the recipient should be notified when a document is deleted.
Remindersboolean	Indicates whether the recipient should receive reminders for pending signature requests.
EditRecipientboolean	Indicates whether the recipient should be notified when there is a change in the recipient.
EditDocumentboolean	Indicates whether the recipient should be notified when the document is edited.

EnableQesNullable boolean When set to true, the signer will be allowed to sign the document with a qualified electronic signature (QES). It can only be assigned to a single signer. When there are multiple signers in a document, the signer order option should be enabled to ensure only the last person in the document is enabled with QES, and the last signer order also should not have multiple signers.

AuthenticationSettingsobject

Configure additional options for signers who are authenticated using Email OTP, SMS OTP, or Access Code. These settings allow you to control how often the signer must authenticate when accessing the document. And it applies only when the signer's AuthenticationType is set to EmailOTP, SMSOTP, or AccessCode. For IdVerification, use the IdentityVerificationSettings property instead.

AuthenticationFrequencystring

Specifies how frequently the signer must complete authentication:

EveryAccess: The signer must authenticate every time they access the document, even after signing.
UntilSignCompleted: Authentication is required until the signer completes their signature. After signing, further authentication is not required.
OncePerDocument: The signer authenticates only once per document, regardless of how many times they access it.

CCarray

Email IDs of the CC recipients. One or more CC recipients can be specified.

EmailAddressstring

Email ID of the CC recipients.

EnableSigningOrderNullable boolean

Enables or disables the signing order. If this is enabled, then the signers can sign the document in the specified order and will not be able to sign in parallel. The default value is false.

Note : EnableSigningOrder can be enabled or disabled only for draft documents.

ExpiryDateTypeNullable enum This specifies the type of expiry date for the document. They are Days, Hours, and SpecificDateTime. The default value is Days.

ExpiryValueNullable long This specifies the expiry value for the document based on the ExpiryDateType selected. The default value is 60 days.

ReminderSettings.EnableAutoReminderboolean Enables or disables the auto reminder.

ReminderSettings.ReminderDaysinteger The number of days between each automatic reminder.

ReminderSettings.ReminderCountinteger The number of times the auto reminder should be sent.

DisableEmailsNullable boolean Disables the sending of document-related emails to all recipients. The default value is false.

DisableSMSNullable boolean Disables the sending of document-related SMS to all recipients. The default value is false.

BrandIdstring

You can customize the logo, colors, and other elements of the signature request emails and document signing pages to match your company branding. The ID of the existing brand can be obtained from the branding API and from the web app.

Note : BrandId can be edited only for draft documents.

HideDocumentIdNullable boolean Decides whether the document ID should be hidden or not.

Labelsarray Labels (tags) are added to the document to categorize and filter the documents. One or more labels can be added. Labels cannot contain whitespaces and must not exceed 255 characters.

UseTextTagsboolean When enabled, it will convert all the tags defined in the document to BoldSign form fields. The default value is false.

TextTagDefinitionsarray

This can be used for long text tag handling.

DefinitionIdstring The definition ID of the text tag.

TypeType The type of the form field.

SignerIndexinteger The signer index of the form field.

IsRequiredboolean When disabled, the signer is not required to fill out the specific form field. The default value is true.

PlaceHolderstring The placeholder of the form field.

TabIndexNullable int Assign tab index to control the flow of field focus while using TAB key navigation. Defaults to null, which denotes it will follow regular flow. The accepted range starts from -1 to a valid integer.

FieldIdstring The field ID of the form field.

Fontobject

The font of the form field.

NameFontFamily	Font family. The values are `Courier`, `Helvetica`, and `TimesNewRoman`. The default font family is `Helvetica`.
Colorstring	Color of the font. The value should be a hex color code. Example - `#035efc`.
Sizefloat	Size of the font.
StyleFontStyle	Style of the font. The values are `Regular`, `Bold`, `Italic`, and `Underline`. The default font style is `Regular`.
LineHeightinteger	Height of a line in the text.
IsBoldFontboolean	Decides whether the font should be bold or not.
IsItalicFontboolean	Decides whether the font should be italic or not.
IsUnderLineFontboolean	Decides whether the font should be underlined or not.

Validationobject

When the type is selected as TextBox, validation of the form field is required.

Typestring	The validation type of the text box form field. The available values are `None`, `NumbersOnly`, `EmailAddress`, `Currency`, and `CustomRegex`. The default value is `None`.
Regexstring	The custom regex of the text box form field. When `ValidationType` is set to `CustomRegex`, this will be required.
RegexMessagestring	Description for regex validation. This message is displayed when the signer enters an invalid regex format value in the text box field.

Sizeobject

This can be used to specify the form field's height and width.

Widthfloat	The width of the form field. The width must be greater than zero.
Heightfloat	The height of the form field. The height must be greater than zero.

DateFormatstring

MM/dd/yyyy (02/08/2024)
dd/MM/yyyy (08/02/2024)
dd-MMM-yyyy (08-Feb-2024)
MMM-dd-yyyy (Feb-08-2024)
MMM dd, yyyy (Feb 08, 2024)
dd MMM, yyyy (08 Feb, 2024)
yyyy, MMM dd (2024, Feb 08)
yyyy/MM/dd (2024/02/08)
dd-MM-yyyy (08-02-2024)
MM-dd-yyyy (02-08-2024)
yyyy-MM-dd (2024-02-08)

TimeFormatstring

Format of the time to be displayed on the date signed form field. When null is provided, the value is inherited from your account's business profile settings. Accepted formats are

hh:mm tt (12:30 PM)
h:mm tt (2:45 PM)
HH:mm (14:30)
H:mm (9:15)
None (Disabled, no time will be displayed)

RadioGroupNamestring The form field's group name, which is required when the type is set as RadioButton.

Valuestring The value of the form field.

DropDownOptionsarray The options of the dropdown form field.

OffSetobject

Specifies the offset positioning for the text tag, allowing adjustments to its location relative to the computed position. The computed value after adjustment must remain within the page dimensions.

OffSetXdouble	Adjusts the text tag's position horizontally (left or right). The default value is 0.0.
OffSetYdouble	Adjusts the text tag's position vertically (top or bottom). The default value is 0.0.

FormulaFieldSettingsobject

Options to configure formula field.

FormulaExpressionstring	This property is used to specify the formula as a string to define the calculation or expression for the formula field.
DecimalPrecisioninteger	This property is used to determine the decimal rounding precision for the computed result.

Labelstring The label used to represent the value for a radio button. Also, can be used to prefill a radio button.

ResizeOptionenum Defines how the Textbox form field resizes based on the entered text. The available values are GrowHorizontally, GrowVertically, GrowBoth, FixedSize, and AutoResizeFont.

DataSyncTagstring The value that can be specified on two or more textbox fields to sync them.

TextAlignstring Determines the horizontal alignment of text for the textbox and label form fields, and can be set to Left, Center, or Right. The default alignment of text is Left.

TextDirectionstring Determines the text direction of text for the textbox and label form fields, and can be set to LTR or RTL. The default text direction is LTR.

CharacterSpacingfloat Determines the character spacing of text for the textbox and label form fields. It can be set as a floating-point value.

CharacterLimitinteger Limits the number of characters in the text. The character limit value must be greater than zero.

EnablePrintAndSignNullable boolean Allows the signer to print and sign the document. The default value is false.

EnableReassignNullable boolean Allows the signer to reassign the signature request to another person. The default value is true.

DisableExpiryAlertNullable boolean Disables the alert that will be sent one day before the document's expiry.

DocumentInfoarray

Options to customize the information, such as the title and description of the document for a particular signer.

Languageinteger	Language in which the document signing pages and emails for the signer should be rendered. The supported languages are `1-English`, `2-Spanish`, `3-German`, `4-French`, and `5-Romanian`. Note that 'locale' should now be used instead of 'language' as it has replaced the deprecated term. The default language is `1-English`.
Titlestring	Title of the document. Note : `Title` can be edited only for draft documents.
Descriptionstring	A message for the signer. You can include instructions that the signer should know before signing the document.
Localestring	Specify the language index for rendering document signing pages and emails for the signer, choosing from the supported locales such as `EN-English`, `NO-Norwegian`, `FR-French`, `DE-German`, `ES-Spanish`, `BG-Bulgarian`, `CS-Czech`, `DA-Danish`, `IT-Italian`, `NL-Dutch`, `PL-Polish`, `PT-Portuguese`, `RO-Romanian`, `RU-Russian`, `JA-Japanese`, `TH-Thai`, `ZH_CN-Simplified Chinese`, `Zh_TW-Traditional Chinese`, and `SV-Swedish`. The default locale language is `EN-English`.

OnBehalfOfstring Email ID of the user to send the document on behalf of them.

DocumentDownloadOptionNullable enum This option allows you to configure how the uploaded files, especially multiple files, should be downloaded: either as a single combined document or as separate documents. The values are Combined and Individually. The default value is Combined. If the value is null, the setting configured in the business profile will be considered.

FormGroupsarray

Manages the rules and configuration of grouped form fields.

MinimumCountinteger	The minimum number of items that must be selected in a form group. The minimum count value must be greater than zero.
MaximumCountinteger	The maximum number of items that must be selected in a form group. The maximum count value must be greater than zero.
DataSyncTagstring	The data sync tag of the form group.
GroupNamesarray	The group names to which this form group rule should be applied.
GroupValidationstring	Specify the form group validation type. The available validations are `Minimum`, `Maximum`, `Absolute`, and `Range`.

MetaDatadictionary Additional information about the document in the form of key-value pairs. Up to 50 key-value pairs can be added. The key is limited to 50 characters, and the value is limited to 500 characters.

RecipientNotificationSettingsobject

Control email notifications to recipients or CC collectively by configuring properties within recipientNotificationSettings.

SignatureRequestboolean	Indicates whether the recipient or CC should be notified when a document is sent.
Declinedboolean	Indicates whether the recipient or CC should be notified when a document is declined.
Revokedboolean	Indicates whether the recipient or CC should be notified when a document is revoked.
Signedboolean	Indicates whether the recipient or CC should be notified when a document is signed by another recipient.
Completedboolean	Indicates whether the recipient or CC should be notified when the document is completed.
Expiredboolean	Indicates whether the recipient or CC should be notified when a document expires.
Reassignedboolean	Indicates whether the recipient or CC should be notified when the document is reassigned.
Deletedboolean	Indicates whether the recipient or CC should be notified when a document is deleted.
Remindersboolean	Indicates whether the recipient should receive reminders for pending signature requests.
EditRecipientboolean	Indicates whether the recipient should be notified when there is a change in the recipient.
EditDocumentboolean	Indicates whether the recipient or CC should be notified when the document is edited.
Viewedboolean	Indicates whether the CC should be notified when the document is viewed.

EnableAuditTrailLocalizationNullable boolean Enable localization for the audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.

DownloadFileNamestring

Defines the custom format for the file name of downloaded document files. You can combine your own file name elements with the following predefined dynamic variables:

title
documentId
signername
signername_last
signername_order#1
sendername
completeddate
status

The #1 in signername_order#1 serves as a placeholder and should be replaced with an actual value, such as signername_order#3, to represent a 3rd signer's name.

The maximum file name length is 250 characters. If the generated name exceeds this limit, it will be truncated to fit within the limit. This property is optional; if not provided, the default format configured in the business profile will be used.

ScheduledSendTimeNullable long

This property is used to schedule the document for sending at a later time. The value should be a Unix timestamp representing the desired send time. If null is provided, the document will be sent immediately.

Note : ScheduledSendTime can be edited only for draft documents.

Notes

Please note that you must use either the fileUrls or files parameter in a request, both cannot be used together.
For more details on OTP behavior, validity, and resend limits when using Email or SMS OTP for signing, please refer to this article: OTP Limitation and Restriction

Example Response

Request without files

{
    "status": "Completed"
}

Request with files

{
    "status": "Queued"
}

Edit Document

Partial Update

Asynchronous Document Processing

Code Snippet

Request Body

Example Format

Example Format

Notes

Example Response

Quick Links

Trust & Security

Company

Quick Links

Trust & Security

Company