# Ignisign

IgniSign is a comprehensive electronic signature platform that enables users to sign, send, and manage documents securely online.

- **Category:** signatures
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 33
- **Triggers:** 0
- **Slug:** `IGNISIGN`
- **Version:** 20260312_00

## Tools

### Ignisign API Authentication

**Slug:** `IGNISIGN_API_AUTHENTICATION`

Tool to authenticate an application over Ignisign API and retrieve a JWT. Use when obtaining a bearer token before making other API calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier (e.g., appId_d9cf31d7-6f48-4b11-8168-ded211c1296d). |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | Execution environment. Allowed values: DEVELOPMENT, STAGING, PRODUCTION. |
| `secret` | string | Yes | Secret tied to the application and environment; obtainable from Ignisign Console. |

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

### Cancel Signature Request

**Slug:** `IGNISIGN_CANCEL_SIGNATURE_REQUEST`

Cancel (close) a signature request to terminate it. This uses the Ignisign /close endpoint which permanently cancels the signature workflow. Use this when you need to abort a signature request that is in DRAFT or IN_PROGRESS status. This operation is idempotent - calling it on an already cancelled request returns success without error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requestId` | string | Yes | Unique identifier (24-character hex string) of the signature request to cancel. Obtain this from IGNISIGN_GET_SIGNATURE_REQUESTS or IGNISIGN_INIT_SIGNATURE_REQUEST. |

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

### Initialize Document

**Slug:** `IGNISIGN_CREATE_DOCUMENT`

Tool to initialize a document for a signature request. Use when linking a new document to an existing signature request after creating that request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | Application identifier |
| `label` | string | No | Human-friendly label for the document |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | Target application environment |
| `externalId` | string | No | Free-text external reference; not interpreted by IgniSign |
| `description` | string | No | Human-readable description of the document |
| `signatureRequestId` | string | Yes | ID of the signature request to associate the document with |

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

**Slug:** `IGNISIGN_CREATE_SIGNER`

Tool to create a new signer. Use when onboarding a signer to an application environment after selecting a signer profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier. |
| `email` | string | No | Signer’s email address; required if demanded by the signer profile. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment. |
| `lastName` | string | No | Signer’s last name; required if demanded by the signer profile. |
| `birthDate` | string | No | Birth date as YYYY-MM-DD; required if demanded by the signer profile. |
| `firstName` | string | No | Signer’s first name; required if demanded by the signer profile. |
| `birthPlace` | string | No | Place of birth; required if demanded by the signer profile. |
| `externalId` | string | No | External reference; not used by Ignisign for identification. |
| `nationality` | string | No | Nationality as ISO 3166-1 alpha-2 code; required if demanded by the signer profile. |
| `phoneNumber` | string | No | Phone number in E.164 format; required if demanded by the signer profile. |
| `birthCountry` | string | No | Birth country as ISO 3166-1 alpha-2 code; required if demanded by the signer profile. |
| `signerProfileId` | string | Yes | Signer profile ID to which the signer must conform. |

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

**Slug:** `IGNISIGN_CREATE_WEBHOOK_ENDPOINT`

Tool to create a new webhook endpoint for an application. Use after obtaining application ID and environment to register for event notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webhook endpoint URL to receive Ignisign events. |
| `appId` | string | Yes | The application identifier. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment. |
| `description` | string | No | Human-readable description of the webhook endpoint. |

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

### Delete Document

**Slug:** `IGNISIGN_DELETE_DOCUMENT`

Tool to delete a specific document by its ID. Use when you need to permanently remove a document after processing is complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `documentId` | string | Yes | The unique identifier (MongoDB ObjectId) of the document to delete. Obtain this from a previous document creation or listing operation. |

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

### Delete Ignisign Signature Request

**Slug:** `IGNISIGN_DELETE_SIGNATURE_REQUEST`

Permanently deletes a signature request from Ignisign by its ID. This action is irreversible and removes the signature request along with all associated data. The signature request ID can be obtained from the IGNISIGN_INIT_SIGNATURE_REQUEST action or IGNISIGN_GET_SIGNATURE_REQUESTS action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signatureRequestId` | string | Yes | Unique MongoDB ObjectId identifier of the signature request to delete. This ID is returned when initializing a signature request. |

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

### Delete Signer

**Slug:** `IGNISIGN_DELETE_SIGNER`

Tool to revoke/delete a signer from an Ignisign application environment. This action permanently revokes the signer's access and is idempotent (can be called multiple times on the same signer). Use when you need to remove a signer after confirming their signer ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier (e.g., appId_d9cf31d7-6f48-4b11-8168-ded211c1296d). |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment. |
| `signerId` | string | Yes | Unique identifier of the signer to revoke (24-character MongoDB ObjectId format, e.g., '688f26dd3b3a41c435b74a40'). |

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

### Delete Webhook Endpoint

**Slug:** `IGNISIGN_DELETE_WEBHOOK_ENDPOINT`

Delete a webhook endpoint by its ID. After deletion, returns the list of remaining webhook endpoints configured for the application environment. Use this tool when you need to remove a webhook that is no longer needed or to clean up unused webhooks. The webhook ID can be obtained from the create webhook or list webhooks endpoints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhookId` | string | Yes | The unique identifier of the webhook endpoint to delete. This ID is returned when creating a webhook or can be obtained from the list webhooks endpoint. |

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

**Slug:** `IGNISIGN_GET_APPLICATION_CONTEXT`

Tool to retrieve the global context of an application. Use when you need configuration and environment settings for a given app.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | Unique identifier of the Ignisign application. Must match the app_id associated with the authentication token. Format: 'appId_<uuid>' |

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

**Slug:** `IGNISIGN_GET_DOCUMENT_INFORMATION`

Tool to retrieve document metadata by ID. Use when you need detailed information of a specific document after obtaining its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `documentId` | string | Yes | The unique identifier of the document. |

#### 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 Missing Signer Inputs

**Slug:** `IGNISIGN_GET_MISSING_SIGNER_INPUTS`

Tool to determine missing inputs needed for a signer in a specific signature profile. Use after selecting a signature profile and signer to identify required fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier used to identify the application. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The execution environment where requests are executed. |
| `signerId` | string | Yes | The unique identifier of the signer. Obtain this from the Search Signers or Create Signer actions. |
| `signatureProfileId` | string | Yes | The unique identifier of the signature profile. Obtain this from the Get Signer Profiles action. |

#### 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 Signature Request Details

**Slug:** `IGNISIGN_GET_SIGNATURE_REQUEST_DETAILS`

Tool to retrieve detailed information for a specific signature request. Use after creating or listing a signature request to inspect its details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signatureRequestId` | string | Yes | The unique identifier (MongoDB ObjectId) of the signature request to retrieve. |

#### 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 Signature Request Document

**Slug:** `IGNISIGN_GET_SIGNATURE_REQUEST_DOCUMENT`

Tool to retrieve the document associated with a specific signature request. The action downloads the original file of a document. Provide `documentId` to select a specific document or omit to use the first available document of the request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requestId` | string | Yes | Unique identifier of the signature request. |
| `documentId` | string | No | Optional: specify a concrete documentId to download. If omitted, the first documentId found on the signature request will be used. |

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

**Slug:** `IGNISIGN_GET_SIGNATURE_REQUESTS`

Retrieves a paginated list of signature requests for a specific Ignisign application and environment. Use this to list all signature requests (drafts, in-progress, completed, cancelled) in an application. Each signature request can have associated documents and signers. Returns pagination metadata to iterate through large result sets. Note: The app_env parameter must match your API key's environment scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-indexed). Defaults to 1 if not specified. |
| `appId` | string | Yes | The Ignisign application identifier. Obtain this from 'Get application context' or the Ignisign console. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment. Must match the environment scope of your API key (e.g., a DEVELOPMENT API key can only access DEVELOPMENT environment). |
| `pageSize` | integer | No | Number of items to return per page. Defaults to 25 if not specified. |

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

**Slug:** `IGNISIGN_GET_SIGNED_DOCUMENT`

Tool to download the signed document (signature proof) for a signature request. The action will: 1) Resolve the first documentId from the signature request details. 2) Try v4: GET /documents/{documentId}/signatures/PDF_WITH_SIGNATURES 3) Fallback v3: GET /v3/documents/{documentId}/signature-proof 4) Final fallback: GET /documents/{documentId}/file (original file)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requestId` | string | Yes | Unique identifier of the signature request to download the signed document for. |

#### 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 Signer Input Constraints

**Slug:** `IGNISIGN_GET_SIGNER_INPUT_CONSTRAINTS`

Tool to get signer input constraints. Use when you need to know which fields are required from signers for a given signer profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier used to identify the application. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The execution environment where requests are executed. |
| `signerProfileId` | string | Yes | The unique identifier of the signer profile. |

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

**Slug:** `IGNISIGN_GET_SIGNER_INPUTS`

Retrieves the inputs provided by a specific signer for a signature request. Returns field values the signer has submitted (e.g., firstName, lastName, email). Use this after a signer has been added to a signature request to fetch their profile information. The signer must be associated with the specified signature request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signerId` | string | Yes | The MongoDB ObjectId of the signer whose inputs to retrieve. Obtain this from the Search Signers action or from the signerIds array in a signature request's details. |
| `requestId` | string | Yes | The MongoDB ObjectId of the signature request. Obtain this from the Get Signature Requests action or from the response when initializing a signature request. |

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

**Slug:** `IGNISIGN_GET_SIGNER_PROFILE`

Retrieve detailed information about a specific signer profile by its ID. Use this to get profile settings including integration mode, authentication methods, and associated signers. First use 'Get Signer Profiles' to list available profile IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | The Ignisign application identifier. Starts with 'appId_'. |
| `app_env` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment (DEVELOPMENT, STAGING, or PRODUCTION). |
| `signer_profile_id` | string | Yes | The unique identifier of the signer profile to retrieve. Obtain this from the Get Signer Profiles action. |

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

**Slug:** `IGNISIGN_GET_SIGNER_PROFILES`

Retrieve all signer profiles for a specific Ignisign application environment. Use this tool to list all configured signer profiles that define how signers interact with signature requests. Each profile specifies integration mode (BY_SIDE, EMBEDDED, or MACHINE_TO_MACHINE), authentication methods, and other settings. Returns profile IDs which can be used when creating signers or signature requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | The unique identifier for the Ignisign application (e.g., 'appId_d9cf31d7-6f48-4b11-8168-ded211c1296d') |
| `app_env` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment to retrieve signer profiles from. Use 'DEVELOPMENT' for testing, 'STAGING' for pre-production, or 'PRODUCTION' for live environment |

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

**Slug:** `IGNISIGN_GET_WEBHOOKS`

Retrieves all webhook endpoints configured for a specific Ignisign application environment. Returns the list of webhooks including their URLs, descriptions, and creation timestamps. Use this to audit existing webhook integrations or verify webhook configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The Ignisign application identifier in format 'appId_<UUID>' (e.g., 'appId_d9cf31d7-6f48-4b11-8168-ded211c1296d'). |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The target environment for the application: DEVELOPMENT (sandbox testing), STAGING (pre-production), or PRODUCTION (live). |

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

### Initialize Ignisign Signature Request

**Slug:** `IGNISIGN_INIT_SIGNATURE_REQUEST`

Initialize a new signature request in Ignisign. This is the first step in creating a signature workflow. After initialization, you can add documents (IGNISIGN_CREATE_DOCUMENT), assign signers (IGNISIGN_CREATE_SIGNER), and publish the request (IGNISIGN_PUBLISH_SIGNATURE_REQUEST) to start the signing process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The unique application identifier. Obtain this from IGNISIGN_GET_APPLICATION_CONTEXT or use the appId associated with your Ignisign account. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The target environment for the signature request. Use DEVELOPMENT for testing, STAGING for pre-production, or PRODUCTION for live signatures. |
| `signatureProfileId` | string | Yes | The signer profile ID (_id field) that defines signature settings and authentication methods. Retrieve available profiles using IGNISIGN_GET_SIGNER_PROFILES. |

#### 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:** `IGNISIGN_LIST_DOCUMENTS`

Tool to retrieve documents linked to a signature request. The action works by calling the signature request context endpoint and extracting its documentIds, then fetching each document detail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The IgniSign application identifier. Obtain this from the application context or your IgniSign dashboard. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment. Use DEVELOPMENT for testing, STAGING for pre-production, or PRODUCTION for live operations. |
| `signatureRequestId` | string | Yes | The unique identifier (MongoDB ObjectId format) of the signature request whose documents should be listed. Obtain this from creating or listing signature requests. |

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

### Provide Document Content Data JSON

**Slug:** `IGNISIGN_PROVIDE_DOCUMENT_CONTENT_DATA_JSON`

Provides JSON content to an existing document in Ignisign. Use this action after creating a document with IGNISIGN_CREATE_DOCUMENT to attach structured JSON data that will be associated with a signature request. The JSON content is stored and can be used for document generation or data binding in signature workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `documentId` | string | Yes | The unique identifier of the document (MongoDB ObjectId format). Obtain this from IGNISIGN_CREATE_DOCUMENT response. |
| `jsonContent` | object | Yes | The JSON object to attach to the document. Can contain nested objects, arrays, strings, numbers, booleans, and null values. |

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

### Provide Document Content File

**Slug:** `IGNISIGN_PROVIDE_DOCUMENT_CONTENT_FILE`

Tool to provide file content for a document. Use after creating a document to attach its file content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | for the document content (e.g., PDF). The 'name' field should be the desired filename (e.g., 'contract.pdf'). |
| `fileUrl` | string | No | HTTP URL to a file to fetch and upload if neither `file` nor `filePath` is provided. |
| `fileName` | string | No | Override filename for the upload. If not provided, uses the filename from filePath or fileUrl. |
| `filePath` | string | No | Absolute local file path to upload if `file` is not provided. |
| `mimeType` | string | No | Override MIME type (e.g., 'application/pdf'). If not provided, auto-detected from filename extension. |
| `documentId` | string | Yes | The unique identifier (MongoDB ObjectId) of the document to attach the file to. Obtained from the IGNISIGN_CREATE_DOCUMENT action. |

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

### Provide Document Content Private File

**Slug:** `IGNISIGN_PROVIDE_DOCUMENT_CONTENT_PRIVATE_FILE`

Provides private document content by submitting its SHA-256 hash to IgniSign. Use this after creating a document with IGNISIGN_CREATE_DOCUMENT when the document content should remain private (not uploaded). The hash proves document integrity without exposing its contents. The document status will change to 'PROVIDED' upon success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `documentId` | string | Yes | MongoDB ObjectId identifier of the document. Obtain this from the IGNISIGN_CREATE_DOCUMENT action. |
| `documentHash` | string | Yes | Hex-encoded SHA-256 hash (64 lowercase hex characters) of the private document content to be signed. This hash represents the document without uploading the actual file. |

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

### Publish Signature Request

**Slug:** `IGNISIGN_PUBLISH_SIGNATURE_REQUEST`

Tool to publish a draft signature request. Use after adding all documents and signer details to the draft.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signatureRequestId` | string | Yes | The unique identifier of the draft signature request to publish. |

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

### Search Signers

**Slug:** `IGNISIGN_SEARCH_SIGNERS`

Tool to search for signers within an application environment. Use after obtaining application ID and environment. Requires a non-empty filter string to search by name, email, or external ID. Use '*' to match all signers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The application identifier (e.g., appId_XXXX-XXXX-XXXX-XXXX-XXXX) |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application execution environment. |
| `filter` | string | Yes | Required filter string (non-empty) to search signers by name, email, or external ID. Use '*' to match all signers. |

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

### Update Document Information

**Slug:** `IGNISIGN_UPDATE_DOCUMENT_INFORMATION`

Tool to update document metadata. Use when you need to change a document's label, description, or external identifier after creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | A user-friendly label to identify the document. |
| `documentId` | string | Yes | The unique identifier of the document to update (MongoDB ObjectId format, 24 hex characters). |
| `externalId` | string | No | Optional external identifier used by external systems (free text; not interpreted by Ignisign). |
| `description` | string | No | A detailed, human-readable description of the document. |

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

### Update Signature Request

**Slug:** `IGNISIGN_UPDATE_SIGNATURE_REQUEST`

Tool to partially update a signature request in DRAFT state. Use when you need to modify draft request metadata before sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | New title of the signature request. |
| `language` | string ("EN" | "FR" | "DE") | No | Language code of the signature request. |
| `signerIds` | array | No | List of signer IDs to include in the request. |
| `externalId` | string | No | External reference ID for your system. |
| `statements` | array | No | List of statement objects to attach to the request. |
| `description` | string | No | New description for the signature request. |
| `documentIds` | array | No | List of document IDs to associate with the request. |
| `diffusionDate` | string | No | Scheduled send date (required if diffusionMode = SCHEDULED). |
| `diffusionMode` | string ("WHEN_READY" | "SCHEDULED") | No | When to send the signature request. |
| `expirationDate` | string | No | Expiration date in ISO 8601 format. |
| `signatureRequestId` | string | Yes | Unique identifier of the signature request to update. |
| `expirationDateIsActivated` | boolean | No | Whether the expiration date is active. |

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

### Update Signer

**Slug:** `IGNISIGN_UPDATE_SIGNER`

Updates an existing signer's profile assignment. Use this to change which signer profile a signer is associated with. The signer must already exist in the application environment. Requires: app_id (from Get Application Context), signer_id (from Create Signer or Search Signers), and signer_profile_id (from Get Signer Profiles).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `appId` | string | Yes | The Ignisign application identifier (e.g., 'appId_d9cf31d7-6f48-4b11-8168-ded211c1296d'). Obtain from Get Application Context. |
| `appEnv` | string ("DEVELOPMENT" | "STAGING" | "PRODUCTION") | Yes | The application environment where the signer exists. |
| `signerId` | string | Yes | The unique identifier of the signer to update (e.g., '688f26dd3b3a41c435b74a40'). Obtain from Create Signer or Search Signers. |
| `signerProfileId` | string | Yes | The signer profile ID to assign to this signer (e.g., '688f26dd3b3a41c435b749f6'). Obtain from Get Signer Profiles. |

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

### Update Webhook Endpoint

**Slug:** `IGNISIGN_UPDATE_WEBHOOK_ENDPOINT`

Tool to update an existing webhook endpoint. Use when you have a webhook ID and want to modify its destination URL or description. Example: Update the URL of webhook `68e7adc882353ea4e072bdbe` to `https://example.com/webhook`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | New destination URL that the webhook will call. Must be a valid HTTPS URL. |
| `webhookId` | string | Yes | Unique identifier of the webhook to update (e.g., '68e7adc882353ea4e072bdbe'). |
| `description` | string | No | Human-readable description of the webhook endpoint. Set to empty string to clear. |

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