# Boldsign

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

- **Category:** signatures
- **Auth:** OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `BOLDSIGN`
- **Version:** 20260312_00

## Tools

### Get Brand Details

**Slug:** `BOLDSIGN_BRAND_GET`

Tool to get brand details by brand ID. Use after obtaining the brand identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brandId` | string | Yes | Unique identifier of the brand to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Brands

**Slug:** `BOLDSIGN_BRAND_LIST`

Tool to list all brands in the account. Use after confirming account is authenticated.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `BrandId` | string | No | Brand identifier to associate the custom field. |
| `FieldName` | string | Yes | Name of the custom field. |
| `FormField` | object | Yes | Custom form field definition. |
| `FieldOrder` | string | Yes | Position/order of the custom field. |
| `SharedField` | boolean | No | Whether the field is shared across the organization. |
| `FieldDescription` | string | Yes | Description/info about the custom field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `BrandId` | string | No | Brand identifier to associate the field |
| `FieldName` | string | No | Name of the custom field |
| `FormField` | object | No | Custom form field settings as a JSON object, follow API spec for nested properties |
| `FieldOrder` | string | No | Order/position of the custom field |
| `SharedField` | boolean | No | Whether the field is shared across the organization |
| `customFieldId` | string | Yes | The ID of the custom field to edit |
| `FieldDescription` | string | No | Description of the custom field |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve (1-based). Default is 1. |
| `labels` | array | No | Filter by document labels. |
| `status` | array | No | Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft. |
| `endDate` | string | No | End of date range (ISO 8601 date-time string). |
| `signers` | array | No | Filter by signer email address(es). |
| `brandIds` | array | No | Filter by brand ID(s); applies to docs created on/after Oct 4, 2024. |
| `pageSize` | integer | No | Number of items per page (1-100). Default is 10. |
| `pageType` | string ("BehalfOfOthers" | "BehalfOfMe") | No | Which documents to list: 'BehalfOfOthers' or 'BehalfOfMe'. Default is 'BehalfOfOthers'. |
| `searchKey` | string | No | Keyword to search across title, document ID, sender or signer names. |
| `startDate` | string | No | Start of date range (ISO 8601 date-time string). |
| `nextCursor` | integer | No | Cursor for deep pagination beyond 10,000 records. |
| `emailAddress` | array | No | Filter by sender identity email address(es). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `CC` | array | No | CC recipients list of objects with EmailAddress. |
| `Files` | array | No | List of file edits (add/update/remove). |
| `Title` | string | No | Document title (draft-only). |
| `Labels` | array | No | List of document labels (<=255 chars, no whitespace). |
| `BrandId` | string | No | Apply brand by ID (draft-only). |
| `Message` | string | No | Message for all recipients. |
| `Signers` | array | No | Signer edits (add/update/remove recipients). |
| `MetaData` | object | No | Custom metadata key/value pairs. |
| `DisableSMS` | boolean | No | Disable SMS notifications. |
| `FormGroups` | array | No | Group rule settings for form fields. |
| `documentId` | string | Yes | ID of the document to edit. |
| `ExpiryValue` | integer | No | Expiry value matching ExpiryDateType. |
| `UseTextTags` | boolean | No | Convert text tags to fields. |
| `DocumentInfo` | array | No | Per-signer document settings. |
| `DisableEmails` | boolean | No | Disable email notifications. |
| `ExpiryDateType` | string ("Days" | "Hours" | "SpecificDateTime") | No | Expiry type unit. |
| `HideDocumentId` | boolean | No | Hide document ID in UI. |
| `DownloadFileName` | string | No | Custom download filename format. |
| `ReminderSettings` | object | No | Auto reminder configuration. |
| `ScheduledSendTime` | integer | No | Unix timestamp to schedule send; null sends immediately. |
| `EnableSigningOrder` | boolean | No | Enable signing order (draft-only). |
| `TextTagDefinitions` | array | No | List of text tag definition objects. |
| `EnableAuditTrailLocalization` | boolean | No | Localize audit trail. |
| `RecipientNotificationSettings` | object | No | Notification toggles for document recipients and CC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `WarnPrior` | boolean | No | Whether to send notification email one day before expiry. null uses existing setting; true enables notification; false disables. |
| `OnBehalfOf` | string | No | Email of the user on whose behalf the request is made. |
| `documentId` | string | Yes | ID of the document to extend expiry for. |
| `NewExpiryValue` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve (1-based). Default is 1. |
| `labels` | array | No | Filter by document labels. |
| `sentBy` | array | No | Filter by sender email address(es). |
| `status` | array | No | Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Scheduled, Draft. |
| `endDate` | string | No | End of date range (ISO 8601 date-time string). |
| `brandIds` | array | No | Filter by brand ID(s). |
| `pageSize` | integer | No | Number of items per page (1 or more). Default is 10. |
| `searchKey` | string | No | Keyword to search across title, document ID, sender or recipient names. |
| `startDate` | string | No | Start of date range (ISO 8601 date-time string). |
| `nextCursor` | integer | No | Cursor for deep pagination beyond 10,000 records. |
| `recipients` | array | No | Filter by recipient email address(es). |
| `transmitType` | string ("Sent" | "Received" | "Both") | No | Filter by transmission type: 'Sent', 'Received', or 'Both'. |
| `dateFilterType` | string ("SentBetween" | "Expiring") | No | Filter documents by sent between dates or expiring date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Document Authentication

**Slug:** `BOLDSIGN_DOCUMENT_REMOVE_AUTHENTICATION`

Tool to remove authentication from a document. Use when you need to disable signer authentication on an existing document before the signing process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zOrder` | integer | No | Signer order in recipient list, used to target specific signer when multiple roles share same email. |
| `emailId` | string | Yes | Email address of the signer whose authentication is to be removed. |
| `documentId` | string | Yes | ID of the document from which to remove authentication. |
| `onBehalfOf` | string | No | Sender's identity email when performing this action on behalf of another user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of CC recipients |
| `files` | array | No | Base64-encoded files to send. Use either files or fileUrls, not both |
| `title` | string | Yes | Document title displayed in UI and emails |
| `labels` | array | No | Tags for categorization; no spaces; max 255 chars each |
| `brandId` | string | No | Apply existing brand ID to document emails and pages |
| `message` | string | No | Message/instructions for all recipients |
| `signers` | array | No | List of signers/recipients for the document |
| `fileUrls` | array | No | Public URLs to files to send. Use either files or fileUrls, not both |
| `metaData` | object | No | Custom key-value metadata (max 50 entries) |
| `disableSMS` | boolean | No | Disable document-related SMS messages |
| `expiryDays` | integer | No | Days until document expires |
| `formGroups` | array | No | Rules for grouped form fields |
| `onBehalfOf` | string | No | Send on behalf of this email address |
| `useTextTags` | boolean | No | Convert text tags into BoldSign fields |
| `documentInfo` | array | No | Per-signer override settings for document metadata |
| `disableEmails` | boolean | No | Disable document-related emails |
| `hideDocumentId` | boolean | No | Hide the document ID in communications |
| `autoDetectFields` | boolean | No | Automatically detect fillable fields in files |
| `downloadFileName` | string | No | Custom filename pattern for downloaded document |
| `reminderSettings` | object | No | Configuration for automatic reminders. |
| `scheduledSendTime` | integer | No | Unix timestamp for scheduling send (≥30 min in future) |
| `sendLinkValidTill` | string | No | ISO8601 datetime when generated signing link expires |
| `enableSigningOrder` | boolean | No | Enforce sequential signing order |
| `textTagDefinitions` | array | No | Definitions for text tag conversion |
| `documentDownloadOption` | string | No | Download option: Combined or Individually |
| `recipientNotificationSettings` | object | No | Toggle notifications for all recipients |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Team Documents

**Slug:** `BOLDSIGN_DOCUMENT_TEAM_LIST`

Tool to list team documents. Use when a team or account admin needs to retrieve all team documents with optional filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve (1-based). Default is 1. |
| `labels` | array | No | Filter by document labels (tags). |
| `status` | array | No | Filter by document status. One or more of: None, WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Draft. |
| `teamId` | array | No | Filter by team ID(s). |
| `userId` | array | No | Filter by team user ID(s). |
| `endDate` | string | No | End of date range (ISO 8601 date-time string). |
| `brandIds` | array | No | Filter by associated brand ID(s). |
| `pageSize` | integer | No | Number of items per page. Default is 10. |
| `searchKey` | string | No | Keyword to search across title, document ID, sender or recipient names. |
| `startDate` | string | No | Start of date range (ISO 8601 date-time string). |
| `nextCursor` | integer | No | Cursor for deep pagination beyond 10,000 records. |
| `transmitType` | string ("Sent" | "Received" | "Both") | No | Transmission type: 'Sent', 'Received', or 'Both'. |
| `dateFilterType` | string ("SentBetween" | "Expiring") | No | Date filter type: SentBetween or Expiring. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Files` | array | No | Optional files to upload (.pdf,.png,.jpg,.docx). |
| `Title` | string | Yes | Document title shown in UI and emails |
| `Locale` | string ("EN" | "FR" | "NO" | "DE" | "ES" | "BG" | "CS" | "DA" | "IT" | "NL" | "PL" | "PT" | "RO" | "RU" | "SV") | No | UI language for embedded experience |
| `Message` | string | No | Optional message for all recipients |
| `Signers` | array | Yes | List of signers with their name and email |
| `FileUrls` | array | No | Optional publicly accessible file URLs (e.g., https://...). Use this instead of uploading files. Do not provide Files when using FileUrls. |
| `RedirectUrl` | string | No | URL to redirect after embedded UI finishes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base64` | string | Yes | Base64 encoded file content |
| `mimetype` | string | Yes | MIME type of the file |
| `file_name` | string | Yes | Filename to use when uploading |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |