Document

A document is also known as an envelope. It acts as an overall container for BoldSign transactions. A document in BoldSign contains one or more files, in which the signature will be added electronically, details about the sender and signers, status, history, etc. Each document has a unique ID, and you can use that for identifying or fetching the document.

Using BoldSign, you can send documents to others for eSignatures. In addition, you can perform various operations like self-sign, sign the document as a recipient, send the document on behalf of another user, add authentication, remind signers, delete a document, get document details, get a document list, etc.

Asynchronous document processing

The process of document send is asynchronous. Although you will promptly receive the document ID upon initiation, the actual file may still be undergoing processing in the background. To determine whether the document has been successfully sent, you must listen for the webhooks.

The system will trigger either a Sent or SendFailed event, indicating the success or failure of the document transmission, respectively. In the event of failure, the system will send a SendFailed event along with an accompanying error message. It is imperative to address and resolve this error to ensure the proper sending of the document in the next request.

Document not found

If you discover that a document is not present in your account even after receiving a documentId in the API response, it is directly tied to the asynchronous document processing, as explained in the preceding section. To ascertain whether the document has been successfully created, you should actively monitor the Sent and SendFailed webhook events. These events will provide confirmation regarding the status of the document, indicating whether it has been successfully created or if an issue has occurred during the process.

Send documents

post/v1/document/send

You can request signatures from others by sending the documents for signing. It is not mandatory for the signers to have a BoldSign account. Thus, the signer can sign a document sent by another user with or without a BoldSign account. If required, you can also add yourself as one of the signers. To self-sign a document, you can send a signature request to yourself alone. This API supports both multipart/form-data and application/json content types.

Code snippet using multipart/form-data

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 'DisableExpiryAlert=false' \
     -F 'ReminderSettings.ReminderDays=5' \
     -F 'BrandId=' \
     -F 'ReminderSettings.ReminderCount=3' \
     -F 'EnableReassign=true' \
     -F 'Message=' \
     -F 'Signers={
        "name": "sdc",
        "emailAddress": "alexgayle@cubeflakes.com",
        "signerType": "Signer",
        "formFields": [
           {
                "id": "string",
                "name": "string",
                "fieldType": "Signature",
                "pageNumber": 1,
                "bounds": {
                  "x": 50,
                  "y": 50,
                  "width": 1,
                  "height": 1
                },
                "isRequired": true
    },
           {
                "id": "string",
                "name": "string",
                "fieldType": "Label",
                "pageNumber": 1,
                "bounds": {
                  "x": 150,
                  "y": 250,
                  "width": 1,
                  "height": 1
                },
                "isRequired": true,
                "backgroundHexColor": "string"
    }
  ],
  "locale": "EN"
}' \
  -F 'ExpiryDays=30' \
  -F 'EnablePrintAndSign=false' \
  -F 'AutoDetectFields=false' \
  -F 'OnBehalfOf=' \
  -F 'EnableSigningOrder=false' \
  -F 'UseTextTags=false' \
  -F 'SendLinkValidTill=' \
  -F 'FileUrls=string' \
  -F 'Title=dcsd' \
  -F 'HideDocumentId=false' \
  -F 'EnableEmbeddedSigning=false' \
  -F 'ExpiryDateType=Days' \
  -F 'ReminderSettings.EnableAutoReminder=true' \
  -F 'ExpiryValue=60' \
  -F 'DisableEmails=false' \
  -F 'DisableSMS=false' \
  -F 'MetaData={
  "DocumentType": "new",
  "DocumentCategory": "software"
}' \

var apiClient = new ApiClient("YOUR_API_KEY");

var documentClient = new DocumentClient(apiClient);

List<FormField> formField = new List<FormField>
{
    new FormField(
        id: "Signature",
        type: FieldType.Signature,
        pageNumber: 1,
        bounds: new Rectangle(x: 50, y: 50, width: 200, height: 30))
};

var documentDetails = new SendForSign
{
    Title = "Agreement",
    Signers = new List<DocumentSigner>
    {
        new DocumentSigner(
            signerName: "David",
            signerType: SignerType.Signer,
            signerEmail: "david@cubeflakes.com",
            formFields: formField)
    },
    Files = new List<IDocumentFile>
    {
        new DocumentFilePath
        {
            ContentType = "application/pdf",
            FilePath = "YOUR_FILE_PATH",
        }
    },
};

var documentCreated = documentClient.SendDocument(documentDetails);

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
	
    form_field = boldsign.FormField(
		fieldType="Signature",
		pageNumber=1,
		bounds=boldsign.Rectangle(x=50, y=50, width=200, height=25))

    document_signer = boldsign.DocumentSigner(
        name="David",
        emailAddress="david@cubeflakes.com",
        signerType="Signer",
        formFields=[form_field])

    send_for_sign = boldsign.SendForSign(
        title= "Document SDK API",
        files=["YOUR_FILE_PATH"],
        signers=[document_signer])
    
    document_created = document_api.send_document(send_for_sign)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\{FormField, Rectangle, DocumentSigner, SendForSign, FileInfo};

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

$document_api = new DocumentApi($config);

$form_field = new FormField();
$form_field->setFieldType('Signature');
$form_field->setPageNumber(1);
$bounds = new Rectangle([100, 100, 100, 50]);
$form_field->setBounds($bounds);

$document_signer = new DocumentSigner();
$document_signer->setName("David");
$document_signer->setEmailAddress("david@cubeflakes.com");
$document_signer->setSignerType("Signer");
$document_signer->setFormFields([$form_field]);

$send_for_sign = new SendForSign();
$files = new FileInfo();
$files = 'YOUR_FILE_PATH';
$send_for_sign->setFiles([$files]);
$send_for_sign->setSigners([$document_signer]);
$send_for_sign->setTitle('Document SDK API');

$document_created = $document_api->sendDocument($send_for_sign);

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

FormField signatureField = new FormField();
signatureField.setFieldType(FormField.FieldTypeEnum.SIGNATURE);
signatureField.setPageNumber(1);
Rectangle bounds = new Rectangle().x(100f).y(100f).width(100f).height(50f);
signatureField.setBounds(bounds);

DocumentSigner signer = new DocumentSigner();
signer.setName("David");
signer.setEmailAddress("david@cubeflakes.com");
signer.setSignerType(DocumentSigner.SignerTypeEnum.SIGNER);
signer.setFormFields(Arrays.asList(signatureField));

SendForSign sendForSign = new SendForSign();
File file = new File("YOUR_FILE_PATH");  
sendForSign.setFiles(Arrays.asList(file));
sendForSign.setSigners(Arrays.asList(signer));
sendForSign.setTitle("Document SDK API");

DocumentCreated documentCreated = documentApi.sendDocument(sendForSign);

import { DocumentApi, DocumentSigner, FormField, Rectangle, SendForSign } from "boldsign"; 
import * as fs from 'fs';

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

const bounds = new Rectangle();
bounds.x = 100;
bounds.y = 50;
bounds.width = 100;
bounds.height = 100;

const formField = new FormField();
formField.fieldType = FormField.FieldTypeEnum.Signature;
formField.pageNumber = 1;
formField.bounds = bounds;

const documentSigner = new DocumentSigner();
documentSigner.name = "David";
documentSigner.emailAddress = "david@cubeflakes.com";
documentSigner.signerType = DocumentSigner.SignerTypeEnum.Signer;
documentSigner.formFields = [formField];

const files = fs.createReadStream("YOUR_FILE_PATH");

const sendForSign = new SendForSign();
sendForSign.title = "Agreement";
sendForSign.signers = [documentSigner];
sendForSign.files = [files];

const documentCreated =documentApi.sendDocument(sendForSign);

Code snippet using application/json

curl -X 'POST' \
  'https://api.boldsign.com/v1/document/send' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "DisableExpiryAlert": false,
    "ReminderSettings": {
        "ReminderDays": 5,
        "ReminderCount": 3,
        "EnableAutoReminder": true
    },
    "BrandId": "",
    "EnableReassign": true,
    "Message": "",
    "Signers": [
        {
            "name": "Alex",
            "emailAddress": "alexgayle@boldsign.dev",
            "signerType": "Signer",
            "formFields": [
                {
                    "id": "string",
                    "name": "string",
                    "fieldType": "Signature",
                    "pageNumber": 1,
                    "bounds": {
                        "x": 50,
                        "y": 50,
                        "width": 125,
                        "height": 25
                    },
                    "isRequired": true
                },
                {
                    "id": "string",
                    "name": "string",
                    "fieldType": "Label",
                    "pageNumber": 1,
                    "bounds": {
                        "x": 150,
                        "y": 250,
                        "width": 125,
                        "height": 25
                    },
                    "isRequired": true,
                    "value": "string",
                    "backgroundHexColor": "string"
                }
            ],
            "locale": "EN"
        }
    ],
    "ExpiryDays": 30,
    "EnablePrintAndSign": false,
    "AutoDetectFields": false,
    "OnBehalfOf": "",
    "EnableSigningOrder": false,
    "UseTextTags": false,
    "SendLinkValidTill": "",
    "Files": [
        "data:application/pdf;base64,JVBERi0xLjcKJcfs..."
    ],
    "Title": "Sampledocument",
    "HideDocumentId": false,
    "EnableEmbeddedSigning": false,
    "ExpiryDateType": "Days",
    "ExpiryValue": 60,
    "DisableEmails": false,
    "DisableSMS": false,
    "MetaData": {
    "DocumentType": "new",
    "DocumentCategory": "Software"
  }
  }'

Request body

filesarray

The files 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}}" }"].

For multiple files with file name, the format should be: [{ "base64": "data:application/{{fileType}};base64,{{content1}}", "fileName": "{{fileName}}" }, {...}].

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

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

signersarray

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

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

emailAddressstringRequired Mail ID of the signer. This ID will appear on all the emails, notifications, and the audit files.

privateMessagestring When the specified signer proceeds to sign the document, a message appears. You can include the instructions that the signer should know before signing the document.

authenticationTypestring This is used to allow authentication for a specific signer. We have three types of authentication. They are AccessCode, EmailOTP, SMSOTP and IdVerification. The default value is None.

authenticationCodestring The authentication access code that the signer must enter to access the document. This should be shared with the signer.

enableEmailOTPboolean Enables the email OTP authentication. when this feature is enabled, the signer must enter the OTP received via email, to access the document.

phoneNumberobject

When you set the authentication type to SMSOTP or select the delivery mode as SMS or EmailAndSMS, 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. 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 int

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.

deliveryModestring This property allows you to specify the desired delivery mode for sending notifications. We have three types of delivery modes. They are Email , SMS and EmailAndSMS. The default value is Email.

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

hostEmailstring Mail ID of the host. It is applicable when the signerType is set to InPersonSigner.

signerRolestring The role of the signer, which was specified while creating the template.

allowFieldConfigurationboolean 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. By default, it is set to false.

formFieldsarray

List of form fields associated with the signer.

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

namestring Name of the form field.

typestringRequired

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 .

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

boundsRectangleRequired

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

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.

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

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.

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

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

fontSizefloat Size of the font. The default size font is 13.0 .

font string 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.

isBoldFontboolean Decides whether the font should be in bold or not.

isItalicFontboolean Decides whether the font should be in italic or not.

isUnderLineFontboolean Decides whether the font should be underlined or not.

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

characterLimitinteger 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 fieldType is set to RadioButton.

placeHolderstring A hint text to be displayed in the textbox form field by default.

validationTypestring Type of validation for the textbox 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 textbox 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 the business profile settings of your account. 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 the business profile settings of your account. Accepted formats are

hh:mm tt (12:30 PM)
h:mm tt (2:45 PM)
HH:mm (14:30)
H:mm (9:15)
hh:mm:ss tt (12:30:15 PM)
h:mm:ss tt (2:45:30 PM)
HH:mm:ss (14:30:10)
H:mm:ss (9:15:40)
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

maxDate string

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

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.

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 of 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.

formulaFieldSettingsobject

Options to configure formula field.

formulaExpressionstring	This property is used to specify the formula as a string define the calculation or expression for the formula field.
decimalPrecisioninteger	This property is used to determines the decimal rounding precision for the computed result.

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

languageinteger 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. The default language is 1-English .

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, 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 other 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.

ccarray

Mail ID of the CC recipients. One or more CC recipients can be specified.

emailAddressstring

Mail ID of the CC recipients.

enableSigningOrderboolean Enables or disables the signing order. When enabled, signers must sign the document in the designated order and cannot sign in parallel. The default value is set to false.

expiryDaysinteger The number of days after which the document expires. 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.

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

disableSMSboolean Disables the sending of document related SMS to all the 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.

hideDocumentIdboolean 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.

fileUrlsarray 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.

sendLinkValidTillstring Configures the expiration for the generated URL. A maximum of 180 days can be assigned. The string should be in date-time format.

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.

typeFieldType 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.

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

fieldIdstring The field id of the form field.

fontobject

The font of the form field.

nameFontFamily	Font family. The values are `Courier,` `Helvetica,` `TimesNewRoman,` and `NotoSans.` The default font family is `Helvetica`.
colorstring	Color of the font. The value should be 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.

validationobject

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

typestring	The validation type of the textbox form field. The available values are `None,` `NumbersOnly,` `EmailAddress,` `Currency,` and `CustomRegex.` The default value is `None.`
regexstring	The custom regex of the textbox form field. When we set the ValidationType to `CustomRegex`, it will be required.

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 the business profile settings of your account. Accepted formats are

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

radioGroupNamestring The form field's group name, which is required when we set the type 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 value must remain within the page dimensions.

offSetXdouble	Adjusts the text tag's position horizontally (left or right).
offSetYdouble	Adjusts the text tag's position vertically (top or bottom).

formulaFieldSettingsobject

Options to configure formula field.

formulaExpressionstring	This property is used to specify the formula as a string define the calculation or expression for the formula field.
decimalPrecisioninteger	This property is used to determines the decimal rounding precision for the computed result.

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

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

disableExpiryAlertarray Disables the alert, which was shown one day before the expiry of the document.

documentInfoarray

Options to customize the information, like 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.
descriptionstring	A message for the signer. You can include the 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`, and `SV-Swedish`. The default locale language is `EN-English` .

onBehalfOfstring Mail ID of the user to send the document on behalf of them.

autoDetectFieldsboolean When enabled, it will convert all the fillable form fields in the document to BoldSign form fields. BoldSign supports Textbox, Checkbox, Radio button, and Signature form fields. Other fields will not be detected as of now. The default value is false.

documentDownloadOptionenum 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 settings 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 other 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.

enableAuditTrailLocalizationboolean Enable localization for 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.

scheduledSendTimelong This property allows you to specify the date and time in Unix Timestamp format to schedule a document for sending at a future time. The scheduled time must be at least 30 minutes from the current time and must not exceed the document’s expiry date.

Notes:

1.Please note that you must use either the fileUrls or files parameter in a request, both cannot be used together.

2.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

201 Created

{
  "documentId": "8f59295d-xxxx-xxxx-xxxx-e7dc88cfff2c"
}

Document

Asynchronous document processing

Document not found

Send documents

Code snippet using multipart/form-data

Code snippet using application/json

Request body

Example Format

Example Format

Notes:

Example response

Quick Links

Trust & Security

Company

Quick Links

Trust & Security

Company