templateIdsarray | This is the templateIds of the existing templates to be used for sending the document. One or more values can be specified. |
titlestring | 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. |
rolesarray | A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles, Customer and Representative. roleIndexintegerRequired | The row index value of the role. The role index should be in linear increments for each role (1, 2, 3, and so on). The index value must be between 1 and 50. Example:When merging templates, the role index follows a linear progression. In the first template, the role index starts naturally. In the second template, the role index begins from the next value after the sum of the roles used in the first template. For the third template, the role index starts from the next value after the sum of the roles used in the first and second templates, and so on. | signerNamestring | Name of the signer. This name will appear on all the emails, notifications, and audit files. | signerOrderinteger | Signing order of the signer. This is applicable when the signing order option is enabled. | signerEmailstring | Mail ID of the signer. This ID will appear on all the emails, notifications, and audit files. | hostEmailstring | Mail ID of the host. It is applicable when the signerType is set to InPersonSigner. | privateMessagestring | Displays a message to the specified signer when he proceeds to sign the document. 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: The retry count must be an integer between 1 and 10 . If this property is not specified, the default value is 3 or the value configured in the business profile. 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. | 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. | typestring | 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 . | pageNumberinteger | Page number in the document in which the form field has to be placed. The page number must be greater than zero. | boundsRectangle | 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. | widthfloat | Width of the form field. The width must be greater than zero. | heightfloat | Height of the form field. The default line height is 15.0 . |
| isRequiredboolean | Decides whether this form field is required to be filled or not. | 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. | valuestring | Value to be displayed on the label form field. | fontSizefloat | Size of the font. | fontstring | 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 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 type is set to RadioButton. | placeHolderstring | A hint text is to be displayed on the text form field by default. | validationTypeValidationType | 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 areMM/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 arehh: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 can be uploaded to 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 can be uploaded to 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 . 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 . 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 which 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. |
|
| existingFormFieldsarray | List of existing form fields in the document. indexinteger | Index of the existing form field. | idstring | The ID of the existing form field. | valuestring | Value of the existing form field. | isReadOnlyboolean | Decides whether this form field is readOnly or not. |
| languageinteger | Index of the 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 . | 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 a 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. |
|
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. |
labelsarray | Labels (tags) are added to the documents to categorize and filter them. One or more labels can be added. Labels cannot contain whitespaces and must not exceed 255 characters. |
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 . |
hideDocumentIdboolean | Decides whether the document ID should be hidden or not. |
reminderSettingsboolean | Options to customize the auto reminder settings.enableAutoReminderboolean | Enables or disables the auto reminder. | reminderDaysinteger | The number of days between each automatic reminder. | reminderCountinteger | The number of times the auto reminder should be sent. |
|
ccarray | Mail ID of the CC recipients. One or more CC recipients can be specified.emailAddressstring | Mail ID of the CC recipients. |
|
expiryDaysinteger | The number of days after which the document expires. The default value is 60 days. |
enablePrintAndSignboolean | Allows the signer to print the document, sign, and upload it. The default value is false. |
enableReassignboolean | Allows the signer to reassign the signature request to another person. The default value is true. |
enableSigningOrderboolean | Enables or disables the signing order. If this option is enabled, then the signers can only sign the document in the specified order and cannot sign in parallel. The default value is false. |
disableExpiryAlertboolean | Disables the alert, which was shown one day before the expiry of the document. |
documentInfoarray | Options to customize the information like 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 | The email address of the user to create the templates on their behalf. |
roleRemovalIndicesarray | Removes the roles present in the template with their indices given in this property. |
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. |
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. |
|
removeFormFieldsarray | The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified. |
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. |
filesbase64 | 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}}" }, {...}] . |
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. |
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. |
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. Default 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 . | 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 . | 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 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 filed. 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. | heightfloat | The height of the 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). | 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. |
| label string | The label used to represent the value for a radio button. Also, can be used to prefill a radio button. |
|