> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Boldsign

> BoldSign delivers eSignature solutions, letting organizations create, send, and manage legally binding documents through streamlined digital signing workflows

![Boldsign logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/boldsign.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=b99579feddc346381be48ad7841b238e)

* **Category:** signatures
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** Yes
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `BOLDSIGN`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Brand Details
>
> **Slug:** `BOLDSIGN_BRAND_GET`
>
> Tool to get brand details by brand ID. Use after obtaining the brand identifier.
>
> #### Input Parameters
>
> **brandId** `string` *required*
>
> Unique identifier of the brand to fetch.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Brands
>
> **Slug:** `BOLDSIGN_BRAND_LIST`
>
> Tool to list all brands in the account. Use after confirming account is authenticated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field
>
> **Slug:** `BOLDSIGN_CUSTOM_FIELD_CREATE`
>
> Tool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.
>
> #### Input Parameters
>
> **BrandId** `string`
>
> Brand identifier to associate the custom field.
>
> **FieldName** `string` *required*
>
> Name of the custom field.
>
> **FormField** `object` *required*
>
> Custom form field definition.
>
> **FieldOrder** `string` *required*
>
> Position/order of the custom field.
>
> **SharedField** `boolean`
>
> Whether the field is shared across the organization.
>
> **FieldDescription** `string` *required*
>
> Description/info about the custom field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit Custom Field
>
> **Slug:** `BOLDSIGN_CUSTOM_FIELD_EDIT`
>
> Tool to edit an existing custom field. Use when you need to update a custom field's properties after creation.
>
> #### Input Parameters
>
> **BrandId** `string`
>
> Brand identifier to associate the field
>
> **FieldName** `string`
>
> Name of the custom field
>
> **FormField** `object`
>
> Custom form field settings as a JSON object, follow API spec for nested properties
>
> **FieldOrder** `string`
>
> Order/position of the custom field
>
> **SharedField** `boolean`
>
> Whether the field is shared across the organization
>
> **customFieldId** `string` *required*
>
> The ID of the custom field to edit
>
> **FieldDescription** `string`
>
> Description of the custom field
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Behalf Documents
>
> **Slug:** `BOLDSIGN_DOCUMENT_BEHALF_LIST`
>
> Tool to list documents sent on behalf of users. Use when fetching and filtering documents you've sent or on behalf of others.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (1-based). Default is 1.
>
> **labels** `array`
>
> Filter by document labels.
>
> **status** `array`
>
> Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft.
>
> **endDate** `string`
>
> End of date range (ISO 8601 date-time string).
>
> **signers** `array`
>
> Filter by signer email address(es).
>
> **brandIds** `array`
>
> Filter by brand ID(s); applies to docs created on/after Oct 4, 2024.
>
> **pageSize** `integer`
>
> Number of items per page (1-100). Default is 10.
>
> **pageType** `string ("BehalfOfOthers" | "BehalfOfMe")`
>
> Which documents to list: 'BehalfOfOthers' or 'BehalfOfMe'. Default is 'BehalfOfOthers'.
>
> **searchKey** `string`
>
> Keyword to search across title, document ID, sender or signer names.
>
> **startDate** `string`
>
> Start of date range (ISO 8601 date-time string).
>
> **nextCursor** `integer`
>
> Cursor for deep pagination beyond 10,000 records.
>
> **emailAddress** `array`
>
> Filter by sender identity email address(es).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit Document (Beta)
>
> **Slug:** `BOLDSIGN_DOCUMENT_EDIT_BETA`
>
> Tool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.
>
> #### Input Parameters
>
> **CC** `array`
>
> CC recipients list of objects with EmailAddress.
>
> **Files** `array`
>
> List of file edits (add/update/remove).
>
> **Title** `string`
>
> Document title (draft-only).
>
> **Labels** `array`
>
> List of document labels (\<=255 chars, no whitespace).
>
> **BrandId** `string`
>
> Apply brand by ID (draft-only).
>
> **Message** `string`
>
> Message for all recipients.
>
> **Signers** `array`
>
> Signer edits (add/update/remove recipients).
>
> **MetaData** `object`
>
> Custom metadata key/value pairs.
>
> **DisableSMS** `boolean`
>
> Disable SMS notifications.
>
> **FormGroups** `array`
>
> Group rule settings for form fields.
>
> **documentId** `string` *required*
>
> ID of the document to edit.
>
> **ExpiryValue** `integer`
>
> Expiry value matching ExpiryDateType.
>
> **UseTextTags** `boolean`
>
> Convert text tags to fields.
>
> **DocumentInfo** `array`
>
> Per-signer document settings.
>
> **DisableEmails** `boolean`
>
> Disable email notifications.
>
> **ExpiryDateType** `string ("Days" | "Hours" | "SpecificDateTime")`
>
> Expiry type unit.
>
> **HideDocumentId** `boolean`
>
> Hide document ID in UI.
>
> **DownloadFileName** `string`
>
> Custom download filename format.
>
> **ReminderSettings** `object`
>
> Auto reminder configuration.
>
> **ScheduledSendTime** `integer`
>
> Unix timestamp to schedule send; null sends immediately.
>
> **EnableSigningOrder** `boolean`
>
> Enable signing order (draft-only).
>
> **TextTagDefinitions** `array`
>
> List of text tag definition objects.
>
> **EnableAuditTrailLocalization** `boolean`
>
> Localize audit trail.
>
> **RecipientNotificationSettings** `object`
>
> Notification toggles for document recipients and CC.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extend Document Expiry
>
> **Slug:** `BOLDSIGN_DOCUMENT_EXTEND_EXPIRY`
>
> Tool to extend a document's expiry date. Use before signing to prolong a document's deadline.
>
> #### Input Parameters
>
> **WarnPrior** `boolean`
>
> Whether to send notification email one day before expiry. null uses existing setting; true enables notification; false disables.
>
> **OnBehalfOf** `string`
>
> Email of the user on whose behalf the request is made.
>
> **documentId** `string` *required*
>
> ID of the document to extend expiry for.
>
> **NewExpiryValue** `string` *required*
>
> New expiry value for the document. Must not exceed 180 days from creation. Format depends on document's default expiry type: 'yyyy-MM-dd' for days, integer hours (e.g., '12') for hours, or ISO 8601 datetime for specific date/time (e.g., '2022-12-15T10:58:04.863Z').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Documents
>
> **Slug:** `BOLDSIGN_DOCUMENT_LIST`
>
> Tool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (1-based). Default is 1.
>
> **labels** `array`
>
> Filter by document labels.
>
> **sentBy** `array`
>
> Filter by sender email address(es).
>
> **status** `array`
>
> Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Scheduled, Draft.
>
> **endDate** `string`
>
> End of date range (ISO 8601 date-time string).
>
> **brandIds** `array`
>
> Filter by brand ID(s).
>
> **pageSize** `integer`
>
> Number of items per page (1 or more). Default is 10.
>
> **searchKey** `string`
>
> Keyword to search across title, document ID, sender or recipient names.
>
> **startDate** `string`
>
> Start of date range (ISO 8601 date-time string).
>
> **nextCursor** `integer`
>
> Cursor for deep pagination beyond 10,000 records.
>
> **recipients** `array`
>
> Filter by recipient email address(es).
>
> **transmitType** `string ("Sent" | "Received" | "Both")`
>
> Filter by transmission type: 'Sent', 'Received', or 'Both'.
>
> **dateFilterType** `string ("SentBetween" | "Expiring")`
>
> Filter documents by sent between dates or expiring date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Document Authentication
>
> **Slug:** `BOLDSIGN_DOCUMENT_REMOVE_AUTHENTICATION`
>
> Remove authentication for a specified signer on an existing document, with an optional signer order to distinguish roles sharing an email address.
>
> #### Input Parameters
>
> **zOrder** `integer`
>
> Signer order in recipient list, used to target specific signer when multiple roles share same email.
>
> **emailId** `string` *required*
>
> Email address of the signer whose authentication is to be removed.
>
> **documentId** `string` *required*
>
> ID of the document from which to remove authentication.
>
> **onBehalfOf** `string`
>
> Sender's identity email when performing this action on behalf of another user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Document
>
> **Slug:** `BOLDSIGN_DOCUMENT_SEND`
>
> Tool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.
>
> #### Input Parameters
>
> **cc** `array`
>
> List of CC recipients
>
> **files** `array`
>
> Base64-encoded files to send. Use either files or fileUrls, not both
>
> **title** `string` *required*
>
> Document title displayed in UI and emails
>
> **labels** `array`
>
> Tags for categorization; no spaces; max 255 chars each
>
> **brandId** `string`
>
> Apply existing brand ID to document emails and pages
>
> **message** `string`
>
> Message/instructions for all recipients
>
> **signers** `array`
>
> List of signers/recipients for the document
>
> **fileUrls** `array`
>
> Public URLs to files to send. Use either files or fileUrls, not both
>
> **metaData** `object`
>
> Custom key-value metadata (max 50 entries)
>
> **disableSMS** `boolean`
>
> Disable document-related SMS messages
>
> **expiryDays** `integer`
>
> Days until document expires
>
> **formGroups** `array`
>
> Rules for grouped form fields
>
> **onBehalfOf** `string`
>
> Send on behalf of this email address
>
> **useTextTags** `boolean`
>
> Convert text tags into BoldSign fields
>
> **documentInfo** `array`
>
> Per-signer override settings for document metadata
>
> **disableEmails** `boolean`
>
> Disable document-related emails
>
> **hideDocumentId** `boolean`
>
> Hide the document ID in communications
>
> **autoDetectFields** `boolean`
>
> Automatically detect fillable fields in files
>
> **downloadFileName** `string`
>
> Custom filename pattern for downloaded document
>
> **reminderSettings** `object`
>
> Configuration for automatic reminders.
>
> **scheduledSendTime** `integer`
>
> Unix timestamp for scheduling send (≥30 min in future)
>
> **sendLinkValidTill** `string`
>
> ISO8601 datetime when generated signing link expires
>
> **enableSigningOrder** `boolean`
>
> Enforce sequential signing order
>
> **textTagDefinitions** `array`
>
> Definitions for text tag conversion
>
> **documentDownloadOption** `string`
>
> Download option: Combined or Individually
>
> **recipientNotificationSettings** `object`
>
> Toggle notifications for all recipients
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Team Documents
>
> **Slug:** `BOLDSIGN_DOCUMENT_TEAM_LIST`
>
> List a page of team documents for a team or account admin, with optional filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (1-based). Default is 1.
>
> **labels** `array`
>
> Filter by document labels (tags).
>
> **status** `array`
>
> Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft.
>
> **teamId** `array`
>
> Filter by team ID(s).
>
> **userId** `array`
>
> Filter by team user ID(s).
>
> **endDate** `string`
>
> End of date range (ISO 8601 date-time string).
>
> **brandIds** `array`
>
> Filter by associated brand ID(s).
>
> **pageSize** `integer`
>
> Number of items per page. Default is 10.
>
> **searchKey** `string`
>
> Keyword to search across title, document ID, sender or recipient names.
>
> **startDate** `string`
>
> Start of date range (ISO 8601 date-time string).
>
> **nextCursor** `integer`
>
> Cursor for deep pagination beyond 10,000 records.
>
> **transmitType** `string ("Sent" | "Received" | "Both")`
>
> Transmission type: 'Sent', 'Received', or 'Both'.
>
> **dateFilterType** `string ("SentBetween" | "Expiring")`
>
> Date filter type: SentBetween or Expiring.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Embedded Request Link
>
> **Slug:** `BOLDSIGN_EMBEDDED_REQUEST_CREATE_LINK`
>
> Tool to create an embedded request link. Use after specifying title and signers to generate an embeddable URL for in-app document preparation and sending.
>
> #### Input Parameters
>
> **Files** `array`
>
> Optional files to upload (.pdf,.png,.jpg,.docx).
>
> **Title** `string` *required*
>
> Document title shown in UI and emails
>
> **Locale** `string ("EN" | "FR" | "NO" | "DE" | "ES" | "BG" | "CS" | "DA" | "IT" | "NL" | "PL" | "PT" | "RO" | "RU" | "SV")`
>
> UI language for embedded experience
>
> **Message** `string`
>
> Optional message for all recipients
>
> **Signers** `array` *required*
>
> List of signers with their name and email
>
> **FileUrls** `array`
>
> Optional publicly accessible file URLs (e.g., https\://...). Use this instead of uploading files. Do not provide Files when using FileUrls.
>
> **RedirectUrl** `string`
>
> URL to redirect after embedded UI finishes
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File (Helper)
>
> **Slug:** `BOLDSIGN_FILE_UPLOAD`
>
> Helper action to upload a file to R2 temp via the Composio file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).
>
> #### Input Parameters
>
> **base64** `string` *required*
>
> Base64 encoded file content
>
> **mimetype** `string` *required*
>
> MIME type of the file
>
> **file\_name** `string` *required*
>
> Filename to use when uploading
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get API Credits Count
>
> **Slug:** `BOLDSIGN_PLAN_GET_API_CREDITS_COUNT`
>
> Tool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
