Ignisign

Learn how to use Ignisign with Composio

Overview

SLUG: IGNISIGN

Description

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

Authentication Details

bearer_token
stringRequired

Connecting to Ignisign

Create an auth config

Use the dashboard to create an auth config for the Ignisign toolkit. This allows you to connect multiple Ignisign accounts to Composio for agents to use.

1

Select App

Navigate to Ignisign.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Ignisign Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4ignisign_auth_config_id = "ac_YOUR_IGNISIGN_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Ignisign for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, ignisign_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Ignisign toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["IGNISIGN"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Ignisign API Authentication

Description

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

Action Parameters

appEnv
stringRequired
appId
stringRequired
secret
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel Signature Request

Description

Tool to cancel a signature request. Use after identifying the signature request to abort.

Action Parameters

requestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Initialize Document

Description

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

Action Parameters

appEnv
stringRequired
appId
stringRequired
description
string
externalId
string
label
string
signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Signer

Description

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

Action Parameters

appEnv
stringRequired
appId
stringRequired
birthCountry
string
birthDate
string
birthPlace
string
email
string
externalId
string
firstName
string
lastName
string
nationality
string
phoneNumber
string
signerProfileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook Endpoint

Description

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

Action Parameters

appEnv
stringRequired
appId
stringRequired
description
string
url
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Delete Document

Description

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

Action Parameters

documentId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Ignisign Signature Request

Description

Tool to delete a signature request. Use when you need to permanently remove a signature request by its ID.

Action Parameters

signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Signer

Description

Tool to delete a signer. Use when you need to remove a signer from a specific application environment after confirming signer ID.

Action Parameters

appEnv
stringRequired
appId
stringRequired
signerId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Webhook Endpoint

Description

Tool to delete a specific webhook endpoint. Use when you want to remove an existing webhook by its ID.

Action Parameters

webhookId
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get application context

Description

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

Action Parameters

app_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Document Information

Description

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

Action Parameters

documentId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Missing Signer Inputs

Description

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.

Action Parameters

appEnv
stringRequired
appId
stringRequired
signatureProfileId
stringRequired
signerId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signature Request Details

Description

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

Action Parameters

signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signature Request Document

Description

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.

Action Parameters

documentId
string
requestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signature Requests

Description

Tool to retrieve a paginated list of signature requests for an application. Use after confirming the application ID and environment.

Action Parameters

appEnv
stringRequired
appId
stringRequired
page
integer
pageSize
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signature Request Status

Description

Tool to retrieve the current status of a specific signature request. Use when you need to check the state of a single request by its ID.

Action Parameters

requestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signed Document

Description

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)

Action Parameters

requestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signer Creation Constraints

Description

Tool to retrieve input constraints required to create a signer for a specific signature profile. Use after selecting a signature profile to determine required signer inputs.

Action Parameters

app_env
stringRequired
app_id
stringRequired
signature_profile_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signer Input Constraints

Description

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

Action Parameters

appEnv
stringRequired
appId
stringRequired
signerProfileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signer Inputs

Description

Tool to retrieve inputs provided by a signer for a signature request. Use after a signer has completed their input steps to fetch submitted values.

Action Parameters

requestId
stringRequired
signerId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signer Profile

Description

Tool to retrieve a signer profile. Use after obtaining the signer profile ID.

Action Parameters

app_env
stringRequired
app_id
stringRequired
signerProfileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signer Profiles

Description

Tool to retrieve signer profiles. Use when listing all profiles for a given app environment after confirming app ID and environment.

Action Parameters

app_env
stringRequired
app_id
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Webhook Details

Description

Tool to retrieve details of a specific webhook endpoint. Use after you have the webhook ID to inspect its URL, description, and creation timestamp.

Action Parameters

appEnv
stringRequired
appId
stringRequired
webhookId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhooks

Description

Tool to list all webhook endpoints configured for an application environment. Use after confirming the application ID and environment.

Action Parameters

appEnv
stringRequired
appId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Close Ignisign Signature Request

Description

Tool to close an active signature request. Use when you need to end or abort a signature process.

Action Parameters

signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Signer

Description

Tool to update details of an existing signer. Use after fetching a signer when you need to change its profile.

Action Parameters

appEnv
stringRequired
appId
stringRequired
signerId
stringRequired
signerProfileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Initialize Ignisign Signature Request

Description

Tool to initialize a new signature request. Use when starting a signature flow in a specific application environment.

Action Parameters

appEnv
stringRequired
appId
stringRequired
signatureProfileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Documents

Description

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.

Action Parameters

appEnv
stringRequired
appId
stringRequired
signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Provide Document Content Data JSON

Description

Tool to provide JSON content for a document. Use when you need to attach or update the JSON data of a document.

Action Parameters

documentId
stringRequired
jsonContent
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Provide Document Content File

Description

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

Action Parameters

documentId
stringRequired
file
object
fileName
string
filePath
string
fileUrl
string
mimeType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Provide Document Content Private File

Description

Tool to provide private content for a document via its SHA-256 hash. Use after creating a document placeholder and needing to submit the private content hash for signing.

Action Parameters

documentHash
stringRequired
documentId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Publish Signature Request

Description

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

Action Parameters

signatureRequestId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Signers

Description

Tool to search for signers within an application. Use after obtaining application ID and environment. Allows optional filtering by name, email, or external ID.

Action Parameters

appEnv
stringRequired
appId
stringRequired
filter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Document Information

Description

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

Action Parameters

description
string
documentId
stringRequired
externalId
string
label
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Signature Request

Description

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

Action Parameters

description
string
diffusionDate
string
diffusionMode
string
documentIds
array
expirationDate
string
expirationDateIsActivated
boolean
externalId
string
language
string
signatureRequestId
stringRequired
signerIds
array
statements
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Webhook Endpoint

Description

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 `wbh_123` to `https://example.com/webhook`.

Action Parameters

description
string
url
stringRequired
webhookId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired