### Configure Power Automate HTTP GET Action to Download DOCX Template
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/quickstart
This action configures an HTTP GET request within Power Automate to download a DOCX template from a specified URL. It serves as an alternative to storing templates in cloud storage services like OneDrive or Dropbox. The downloaded template will be used later for document generation and e-signature workflows.
```Power Automate Configuration
Power Automate HTTP Action Configuration:
Action: HTTP
Method: GET
URI: https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/dummy-consent.docx
```
--------------------------------
### API Endpoint: Retrieve Temporary File with Examples
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/files/get
Comprehensive documentation for the GET /v1/files/{file_id} endpoint, detailing path parameters, expected returns, and providing concrete request and response examples.
```APIDOC
Endpoint: GET /v1/files/{file_id}
Description: Retrieves an existing temporary file.
Path Parameters:
file_id:
Type: string
Required: true
Description: The unique identifier of a file.
Headers:
X-API-Key: string (Example: key_test_...)
Returns:
Status: 200 OK
Body:
Type: file object (reference: /docs/api/resources/files/object)
Example:
id: fil_0nZXZ8pYPByQ4XksJbDl4r
expires_at: 2025-12-31T20:00:00.000Z
Error:
Type: error object (reference: /docs/api/errors)
```
```json
// GET https://api.signatureapi.com/v1/files/{file_id}
// X-API-Key: key_test_...
```
```json
{
"id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
"expires_at": "2025-12-31T20:00:00.000Z"
}
```
--------------------------------
### Configure SignatureAPI 'Start an envelope' action in Power Automate
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/quickstart
This snippet describes how to add and configure the 'Start an envelope' action from SignatureAPI within a Power Automate flow. It requires the 'Envelope ID' output from a preceding 'Create an envelope' action to begin the signing process.
```APIDOC
Action: Start an envelope
Description: Initiates the document signing process for a given envelope.
Parameters:
- Name: Envelope ID
Type: string
Description: The unique identifier for the envelope to be started.
Source: Output from the 'Create an envelope' action.
```
--------------------------------
### Example API Response for Completed Envelope
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/guides/quickstart
This JSON snippet illustrates the typical response received when an envelope has been successfully completed. It shows the "status" fields for both the main envelope and its recipients, confirming that the signing process is finished. The "deliverable" status might initially be "processing".
```JSON
{
"id": "3cd512e8-0db8-4608-af95-bfcf9dd08620",
"status": "completed",
// ...
"deliverable": {
"id": "del_2gejfUSFk9H0dF20KklS2y",
"envelope_id": "3cd512e8-0db8-4608-af95-bfcf9dd08620",
"status": "processing",
"type": "audit_log",
"url": null
},
// ...
"recipients": [
{
"id": "re_1RIbLpPWJL44QTBY6n8jBW",
"envelope_id": "3cd512e8-0db8-4608-af95-bfcf9dd08620",
"type": "signer",
"key": "visitor",
// ...
"status": "completed",
"completed_at": "2024-09-04T19:31:05.188Z",
"status_updated_at": "2024-09-04T19:31:05.438Z"
}
],
"created_at": "2024-09-04T19:30:24.822Z",
"completed_at": "2024-09-04T19:31:05.188Z"
}
```
--------------------------------
### Example API Response for Generated Deliverable
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/guides/quickstart
This JSON snippet shows the updated "deliverable" section of the envelope status response once the final signed document has been generated. The "status" changes to "generated", and a "url" is provided to access the completed document.
```JSON
{
//...
"deliverable": {
"id": "del_2gejfUSFk9H0dF20KklS2y",
"envelope_id": "3cd512e8-0db8-4608-af95-bfcf9dd08620",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault/envelopes/3cd512e8-0db8-4608-af95-bfcf9dd08620/deliverables/del_2gejfUSFk9H0dF20KklS2y/sealed.pdf?..."
},
//...
}
```
--------------------------------
### Example Request to List Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/all
Demonstrates a GET request to the SignatureAPI events endpoint, including the required API key header.
```json
// GET https://api.signatureapi.com/v1/events
// X-API-Key: key_test_...
```
--------------------------------
### Get Envelope API Request and Response Examples
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/get
Provides example JSON for a GET request to retrieve an envelope and a sample successful response payload, illustrating the structure of the returned envelope object.
```json
// GET https://api.signatureapi.com/v1/envelopes/{envelope_id}
// X-API-Key: key_test_...
```
```json
{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 25005",
"message": "Please review the agreement at your convenience and provide your electronic signature.",
"status": "completed",
"mode": "live",
"routing": "sequential",
"language": "en",
"timezone": "UTC",
"timestamp_format": "DD/MM/YYYY HH:mm:ss",
"sender": {
"name": "Jennifer Lee",
"email": "jennifer@example.com",
"organization": "Acme Enterprises"
},
"topics": [
"sales",
"project_blue"
],
"metadata": {
"customer_ref": "x9550501",
"account_annual_revenue": "$4,500,000"
},
"documents": [
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider"
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
}
]
}
],
"recipients": [
{
"id": "re_26w2VVV5JVm4j459TY5BNM",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "provider",
"name": "Emily Johnson",
"email": "emily@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T15:00:00.000Z",
"status_updated_at": "2025-12-31T15:00:00.000Z"
},
{
"id": "re_38UVwrWdCqX5kqeKFJUTtf",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "client",
"name": "Michael Taylor",
"email": "michael@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T14:00:00.000Z",
"status_updated_at": "2025-12-31T14:00:00.000Z"
}
],
"deliverable": {
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e..."
},
"created_at": "2025-12-31T12:00:00.000Z",
"completed_at": "2025-12-31T15:00:00.000Z"
}
```
--------------------------------
### Example JSON Response for Envelope Creation
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/guides/quickstart
This JSON object represents the successful response from the SignatureAPI after creating an envelope. It includes the envelope's unique ID, title, current status, sender details, document information (including page count and defined places), and recipient details with their current status and signature options.
```json
{
"id": "69b50512-a771-4bdf-5555-12c555590aa2",
"title": "Dummy Consent",
"label": null,
"message": "Please review and sign the attached Dummy Privacy Policy for internal testing purposes. This document is not legally binding and is used solely for demonstration\n\nThank you for your cooperation.",
"status": "processing",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY hh:mm:ss",
"mode": "test",
"routing": "parallel",
"deliverable": null,
"topics": [],
"metadata": {},
"sender": {
"name": "Richard Roe",
"email": "richard@example.com",
"organization": null
},
"documents": [
{
"id": "doc_7C4In8kXXYYf4kfkiUce94",
"envelope_id": "69b50512-a771-4bdf-5555-12c555590aa2",
"title": null,
"page_count": 2,
"url": "https: //pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/privacy-placeholder.pdf",
"format": "pdf",
"data": null,
"fixed_positions": [],
"places": [
{
"key": "signer_signs_here",
"type": "signature",
"recipient_key": "visitor"
}
]
}
],
"recipients": [
{
"id": "re_0RKFGQ8EgXXYYKq854c045",
"envelope_id": "69b50512-a771-4bdf-5555-12c555590aa2",
"type": "signer",
"key": "visitor",
"name": "Jane Doe",
"email": "jane@example.com",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": [
"typed",
"drawn"
],
"status": "pending",
"completed_at": null,
"status_updated_at": "2025-12-31T23:59:59.000Z"
}
],
"created_at": "2025-12-31T23:59:59.000Z",
"completed_at": null
}
```
--------------------------------
### Example Request: List Envelopes via GET
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/list
Demonstrates an HTTP GET request to retrieve a list of envelopes, including the base URL and required API key header.
```JSON
// GET https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
```
--------------------------------
### API Endpoint: Get Deliverable Details
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/deliverables/get
Comprehensive documentation for the API endpoint used to retrieve a deliverable's details. It includes path parameters, expected return values, and example HTTP request and JSON response.
```APIDOC
Endpoint: GET /v1/deliverables/{deliverable_id}
Description: Retrieves the details of a deliverable.
Path Parameters:
deliverable_id:
Type: string
Required: true
Description: The unique identifier for the deliverable.
Returns:
Status: 200 OK
Body: A deliverable object (see /docs/api/resources/deliverables/object)
Error: An error object (see /docs/api/errors)
```
```json
// GET https://api.signatureapi.com/v1/deliverables/{deliverable_id}
// X-API-Key: key_test_...
```
```json
{
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e..."
}
```
--------------------------------
### Retrieve Envelope Status via cURL
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/guides/quickstart
This cURL command retrieves the current status of a specific envelope. Users must replace the placeholder API key with their test key and the envelope ID with the actual ID received earlier. The command performs a GET request to the SignatureAPI endpoint.
```bash
curl -X GET \
-H 'X-API-Key: key_test_xxxxxxxx' \
https://api.signatureapi.com/v1/envelopes/00000000-0000-0000-0000-000000000000
```
--------------------------------
### Configure SignatureAPI 'Get a deliverable' action in Power Automate
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/quickstart
This snippet explains how to configure the 'Get a deliverable' action in Power Automate to retrieve the final tamper-proof document and audit log. It requires the 'Deliverable ID' obtained from the 'Wait for envelope' action, and outputs the signed document as 'File Content' (PDF).
```APIDOC
Action: Get a deliverable
Description: Retrieves the final tamper-proof document and audit log for a completed envelope.
Parameters:
- Name: Deliverable ID
Type: string
Description: The unique identifier for the deliverable to retrieve.
Source: Output from the 'Wait for envelope' action (important: not from 'Create an envelope').
Outputs:
- Name: File Content
Type: binary (PDF)
Description: The PDF file content of the signed deliverable.
```
--------------------------------
### Example Redirect URL with Query Parameters
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/recipients/redirect-url
An example of a redirect URL after a successful ceremony, demonstrating the appended query parameters.
```APIDOC
https://www.example.com/?ceremony_result=ceremony.completed&envelope_id=5b7be28c-6c7c-4aaa-b25f-66879e8d0957&recipient_id=re_0sgQC0cejYRC8wRsT5N9ll
```
--------------------------------
### Example API Request to List Envelope Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/envelope
Illustrates how to construct a GET request to the 'List Envelope Events' endpoint, including the base URL, envelope ID, and API key header for authentication.
```json
// GET https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events
// X-API-Key: key_test_...
```
--------------------------------
### Start Document Signing Process in Power Automate
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/intermediate-tutorial
This section describes how to initiate the document signing process by starting the envelope. At this point, the envelope is fully assembled and sent to recipients.
```Power Automate
1. Add "Start Envelope" action from the SignatureAPI connector.
2. Set the Envelope ID field to the Envelope ID output of the Create an Envelope action.
```
--------------------------------
### API Reference: Get Document Details
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/documents/get
Provides comprehensive documentation for the 'Get a document' API endpoint, detailing its method, path, parameters, expected returns, and example request/response formats.
```APIDOC
Method: GET
Path: /v1/documents/{document_id}
Description: Retrieves the details of an existing document.
Path Parameters:
document_id:
Type: string
Required: true
Description: The unique identifier of the document.
Headers:
X-API-Key: string (required)
Returns:
200 OK: Document Object
Error: Error Object
```
```json
// GET https://api.signatureapi.com/v1/documents/{document_id}
// X-API-Key: key_test_...
```
```json
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider"
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
}
]
}
```
--------------------------------
### Start an envelope API
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/actions/start-envelope
This API endpoint initiates the signing process for a specified envelope. It requires an Envelope ID as input and returns the current status of the envelope.
```APIDOC
API Endpoint: Start an envelope
Description: Initiates the signing process for an envelope.
Input Parameters:
- Name: Envelope ID
Type: string
Required: true
Description: The ID of the envelope.
Output Response:
- Name: Envelope Status
Type: string
Description: The current status of the envelope.
Available Options: draft, processing, in_progress, completed, failed, canceled
```
--------------------------------
### SignatureAPI Base URL and Example Request
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/overview
This section specifies the base URL for the SignatureAPI, which is consistent for both test and live environments. It also provides a concrete example of how to construct a POST request to create a new envelope resource.
```APIDOC
Base URL: https://api.signatureapi.com
Example POST Request: POST https://api.signatureapi.com/v1/envelopes
```
--------------------------------
### Complete Configuration Example for Text Input Place
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/places/text-input
Provides a comprehensive example of a text input place configuration within a document's `places` array. It includes setting a unique key, type, recipient, capture method, prompt, hint, predefined email format, and making the field optional, positioned at a placeholder.
```json
"documents":
[
{
...
"places": [
{
"key": "buyer_email",
"type": "text_input",
"recipient_key": "buyer",
"capture_as": "buyer_email",
"prompt": "john@example.com",
"hint": "Please enter your email",
"format": "email",
"requirement": "optional"
}
]
...
}
]
```
--------------------------------
### Example API Response for Get Recipient
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/recipients/get
Sample JSON response body returned upon successful retrieval of recipient details.
```json
{
"id": "re_26w2VVV5JVm4j459TY5BNM",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "provider",
"name": "Emily Johnson",
"email": "emily@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"completed_at": "2025-12-31T15:00:00.000Z",
"status_updated_at": "2025-12-31T15:00:00.000Z"
}
```
--------------------------------
### Example Event JSON Payload
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/object
An example JSON payload demonstrating the structure and typical values of an Event object.
```JSON
{
"id": "evt_4p2oouvNvjp1I9ckgqycH2",
"type": "recipient.completed",
"timestamp": "2025-12-31T15:00:01.999Z",
"data": {
"envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
"object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
"object_type": "recipient"
}
}
```
--------------------------------
### Example API Request to Get Recipient
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/recipients/get
Illustrative HTTP GET request to retrieve recipient details, showing the endpoint and required API key header.
```json
// GET https://api.signatureapi.com/v1/recipients/{recipient_id}
// X-API-Key: key_test_...
```
--------------------------------
### SignatureAPI Webhook Event: Envelope Started
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/triggers/envelope-started
Details the 'envelope started' webhook event, including its input parameters for filtering and the output fields providing event and envelope identifiers, timestamps, and types.
```APIDOC
Event: Envelope Started
Description: Occurs when an envelope status transitions from processing to in_progress, indicating it is ready to be sent to recipients.
Input:
Topics:
Type: array of string
Description: Use to classify envelopes and filter webhook notifications.
Output:
Event ID:
Type: string
Description: The ID of the event.
Event Timestamp:
Type: string
Description: The date and time of the event, in ISO 8601 format.
Event Type:
Type: string
Description: The type of the event.
Envelope ID:
Type: string
Description: The ID of the envelope this event refers to.
```
--------------------------------
### Example Deliverable Object JSON Response
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/deliverables/object
An example JSON payload representing a Deliverable object, showing typical values for its attributes.
```JSON
{
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e..."
}
```
--------------------------------
### Example File Object Response
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/files/object
An example JSON response demonstrating the structure of a file object, including its ID and expiration timestamp.
```JSON
{
"id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
"expires_at": "2025-12-31T20:00:00.000Z"
}
```
--------------------------------
### Configure SignatureAPI Create an Envelope Action in Power Automate
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/quickstart
This snippet details how to configure the 'Create an envelope' action in Power Automate using SignatureAPI. It covers setting up the connection with an API Key and configuring envelope properties like title, message, and advanced localization options.
```APIDOC
Action: Create an envelope
Connection Configuration:
Connection Name: string (e.g., SignatureAPITest)
API Key: string (from SignatureAPI Dashboard > Settings > API Keys)
Action Configuration:
Envelope title: string (visible to recipient)
Envelope message: string (visible to recipient)
Advanced Options:
Localization settings: (language, time formats, time zones)
Other advanced features
```
--------------------------------
### Example Request: List Recipient Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/recipient
Illustrates how to make a GET request to the SignatureAPI to retrieve events for a specific recipient, including the base URL and API key header.
```json
// GET https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events
// X-API-Key: key_test_...
```
--------------------------------
### API Request to Create File
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/files/create
Example of the HTTP POST request to create a new temporary file.
```json
// POST https://api.signatureapi.com/v1/files
// X-API-Key: key_test_...
```
--------------------------------
### Common Timestamp Format Examples and Usage
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/timestamp-format
This API documentation provides examples of commonly used timestamp formats across different regions, illustrating how they appear and their typical usage contexts. These examples demonstrate practical applications of the timestamp tokens and separators.
```APIDOC
Common Timestamp Formats:
MM/DD/YYYY hh:mm:ss: Example: 12/31/2025 11:59:59 PM, Usage: Primarily in the United States
DD/MM/YYYY HH:mm:ss: Example: 31/12/2025 23:59:59, Usage: Europe, Australia, parts of Asia and Africa
YYYY-MM-DD HH:mm:ss: Example: 2025-12-31 23:59:59, Usage: ISO 8601 international standard
DD/MM/YYYY hh:mm:ss: Example: 31/12/2025 11:59:59 PM, Usage: Informal usage globally
DD.MM.YYYY HH:mm.ss: Example: 31.12.2025 23.59.59, Usage: Commonly in Germanic and Eastern European countries
```
--------------------------------
### Example Paginated Response JSON
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/pagination
An example JSON structure illustrating a paginated response, showing the `links` object with `next` and `previous` URLs and the `data` array containing the paginated items.
```json
{
"links": {
"next": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_0thJdKRhN4&limit=20",
"previous": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_7yNl3c0t&limit=20"
},
"data": [
{...},
{...},
...
]
}
```
--------------------------------
### API Reference: Get Deliverable
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/actions/get-deliverable
Detailed API specification for retrieving a deliverable, including required input parameters and the structure of the returned deliverable object.
```APIDOC
Endpoint: Get a deliverable
Description: Retrieves a deliverable using its ID. Use it to download a signed copy of the envelope.
Input Parameters:
Deliverable ID (string, required): The ID of the deliverable.
Output Fields:
Deliverable ID (string): The ID of the deliverable.
Deliverable Type (string): The type of the deliverable. Currently, the only type is `audit_log`.
Deliverable Status (string): The current status of the deliverable. Available options are `processing`, `generated`, and `failed`.
File Content (file content): The file content of the deliverable. Use this as input in a downstream action to save the signed document.
```
--------------------------------
### Example Response for List Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/all
Illustrates the structure of a successful paginated response from the List Events API, including links and an array of event objects.
```json
{
"links": {
"next": "https://api.signatureapi.com/v1/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "envelope.completed",
"data": {
"object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "envelope"
},
"timestamp": "2024-12-31T23:59:00.000Z"
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.completed",
"data": {
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "recipient",
"recipient_type": "signer"
},
"timestamp": "2024-12-31T23:58:59.000Z"
},
{...},
{...}
]
}
```
--------------------------------
### API Response for File Creation
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/files/create
Example of the successful 201 Created response after creating a temporary file, including the file ID, upload URL, and expiration time.
```json
{
"id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
"put_url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/temp...",
"expires_at": "2025-12-31T20:00:00.000Z"
}
```
--------------------------------
### Configure Text Input Place with Hint and Prompt Properties
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/places/text-input
Illustrates how to use `hint` and `prompt` properties to guide recipients in text input fields. `hint` provides a tooltip on hover/focus, while `prompt` displays a placeholder message inside the field, enhancing user experience during the signing ceremony.
```json
{
//...
"hint": "Your 8-digit reference code",
"prompt": "12345678"
//...
}
```
--------------------------------
### Reference File in Document Creation
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/files/create
Example of how to reference an uploaded file using its full URL when creating a document object.
```json
{
"url": "https://api.signatureapi.com/v1/files/fil_xxxx1",
...
}
```
--------------------------------
### JSON Example for Text Place Configuration
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/places/text
This JSON snippet demonstrates how to define a text place within a document's 'places' array, setting its key, type, value, font size, and color. It shows how to embed a text place configuration into a document structure.
```json
"documents":
[
{
...
"places": [
{
"key": "company_name",
"type": "text",
"value": "Lorem Ipsum Ltd",
"font_size": 12,
"font_color": "#000000"
}
]
...
}
]
```
--------------------------------
### Common Regional Timestamp Format Examples
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/envelopes/timestamp-format
Provides a table of common timestamp formats used in different regions, including their format strings, example outputs, and typical usage contexts.
```APIDOC
Common Timestamp Formats:
- Format: MM/DD/YYYY hh:mm:ss
Example: 12/31/2025 11:59:59 PM
Usage: Primarily in the United States
- Format: DD/MM/YYYY HH:mm:ss
Example: 31/12/2025 23:59:59
Usage: Europe, Australia, parts of Asia and Africa
- Format: YYYY-MM-DD HH:mm:ss
Example: 2025-12-31 23:59:59
Usage: ISO 8601 international standard
- Format: DD/MM/YYYY hh:mm:ss
Example: 31/12/2025 11:59:59 PM
Usage: Informal usage globally
- Format: DD.MM.YYYY HH:mm.ss
Example: 31.12.2025 23:59.59
Usage: Commonly in Germanic and Eastern European countries
```
--------------------------------
### Response Example: Updated Envelope Object
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/update
Example JSON response received after successfully updating an envelope, showing the updated label and other envelope properties.
```json
{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 29009",
"// ...other envelope properties": ""
}
```
--------------------------------
### Example JSON Response for an Envelope
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/object
Illustrates a complete JSON response structure for an envelope, showcasing various fields and their typical values.
```json
{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 25005",
"message": "Please review the agreement at your convenience and provide your electronic signature.",
"status": "completed",
"mode": "live",
"routing": "sequential",
"language": "en",
"timezone": "UTC",
"timestamp_format": "DD/MM/YYYY HH:mm:ss",
"sender": {
"name": "Jennifer Lee",
"email": "jennifer@example.com",
"organization": "Acme Enterprises"
},
"topics": [
"sales",
"project_blue"
],
"metadata": {
"customer_ref": "x9550501",
"account_annual_revenue": "$4,500,000"
},
"documents": [
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2
}
]
}
```
--------------------------------
### Example Response: Paginated List of Envelopes
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/list
Illustrates a successful JSON response for the list envelopes endpoint, showing pagination links and a sample array of envelope objects.
```JSON
{
"links": {
"next": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_0thJdKRhN4&limit=20",
"previous": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_7yNl3c0t&limit=20"
},
"data": [
{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement"
},
{
"id": "a72f0e-b919-4d69-89cd-e7e56af00531",
"title": "Another Dummy Agreement"
},
{
"id": "b72f0e-b919-4d69-89cd-e7e56af00532",
"title": "A Third Dummy Agreement"
}
]
}
```
--------------------------------
### Example Redirect URL for Successful Ceremony
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/ceremonies/redirect-url
An example of a redirect URL after a successful ceremony, demonstrating how the `ceremony_result`, `envelope_id`, and `recipient_id` query parameters are appended to the base URL. This illustrates the final URL format your application would receive.
```APIDOC
https://www.example.com/?ceremony_result=ceremony.completed&envelope_id=5b7be28c-6c7c-4aaa-b25f-66879e8d0957&recipient_id=re_0sgQC0cejYRC8wRsT5N9ll
```
--------------------------------
### Example Response: List Recipient Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/recipient
Shows a sample successful JSON response containing a paginated list of recipient event objects, including links for navigation and detailed event data.
```json
{
"links": {
"next": "https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "recipient.completed",
"timestamp": "2024-12-31T23:58:00.000Z",
"data": {
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"object_type": "recipient",
"recipient_type": "signer"
}
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.sent",
"timestamp": "2024-12-31T23:50:00.000Z",
"data": {
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"object_type": "recipient",
"recipient_type": "signer"
}
},
{...},
{...}
]
}
```
--------------------------------
### API Documentation: List Envelopes Endpoint
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/list
Comprehensive documentation for the `GET /v1/envelopes` endpoint, detailing its purpose, available query parameters, and expected return values.
```APIDOC
Endpoint: GET https://api.signatureapi.com/v1/envelopes
Description: Returns a list of all envelopes in your account.
Query Parameters:
status:
Type: enum
Description: Filter the list of envelopes by status.
Available options: draft, processing, in_progress, completed, failed, canceled
topic:
Type: string
Description: Filter the list of envelopes by topic.
limit:
Type: integer
Description: The maximum number of objects to return in the response, up to 100. The default is 20.
Returns:
200 OK: A paginated list of envelope objects.
Error: Otherwise.
```
--------------------------------
### Example Ceremony URL with Embedding Parameters
Source: https://signatureapi-daf4ee54.mintlify.app/docs/embedded/web-app
Demonstrates a ceremony URL with `embedded=true` and `event_delivery=message` query parameters appended, configuring the UI for embedding and enabling JavaScript message event delivery.
```url
https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3MjI4OTE3NDYsImV4cCI6MTcyMzQ5NjU0NiwiY2VyZW1vbnlf&embedded=true&event_delivery=message
```
--------------------------------
### Example DOCX Template with Fields and Conditionals
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/documents/templates
Demonstrates a DOCX template structure using double curly braces for fields (e.g., {{person.name}}) and {{if}}/{{endif}} for conditional content. This template shows how dynamic data can populate text and control the display of sections based on boolean values.
```Template Syntax
This Dummy Agreement is entered into by {{person.name}}, currently residing at {{person.address}}. The terms and conditions outlined in this agreement shall be governed by the laws of {{jurisdiction}}.
{{if mediation}}
Any dispute shall be resolved by mediation, with each party bearing its own costs.
{{else}}
Any dispute shall be settled by arbitration, and the arbitrator's decision is final.
{{endif}}
```
--------------------------------
### DOCX Template Example with Fields and Conditionals
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/documents/templates
Illustrates a DOCX template structure using double curly braces for fields (e.g., {{person.name}}) and `if`/`else`/`endif` blocks for conditional content. This template demonstrates how dynamic data can be inserted and how sections can be included or excluded based on boolean conditions.
```DOCX Template
This Dummy Agreement is entered into by {{person.name}}, currently residing at {{person.address}}. The terms and conditions outlined in this agreement shall be governed by the laws of {{jurisdiction}}.
{{if mediation}}
Any dispute shall be resolved by mediation, with each party bearing its own costs.
{{else}}
Any dispute shall be settled by arbitration, and the arbitrator's decision is final.
{{endif}}
```
--------------------------------
### Example API Response for List Envelope Events
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/events/envelope
Provides a sample JSON response from a successful call to the 'List Envelope Events' endpoint, showing the structure of paginated links and an array of event objects with their IDs, types, timestamps, and associated data.
```json
{
"links": {
"next": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_0iuY6H...",
"previous": "https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events/?cursor=seq_87unYn..."
},
"data": [
{
"id": "evt_45b62ui33fCihBWpW2kWDa",
"type": "envelope.completed",
"timestamp": "2024-12-31T23:59:00.000Z",
"data": {
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_type": "envelope"
}
},
{
"id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
"type": "recipient.completed",
"timestamp": "2024-12-31T23:58:59.000Z",
"data": {
"envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
"object_id": "re_00ZeZjRaXCgT30n1eBx53N",
"object_type": "recipient",
"recipient_type": "signer"
}
},
{...},
{...}
]
}
```
--------------------------------
### Example Fields for Custom Authentication Data
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/ceremonies/authentication/custom
This JSON snippet provides examples of key-value pairs suitable for the "data" property within a custom authentication request. Recommended data includes session IDs, timestamps, user identification (email, phone, user IDs), and authentication event details (method, device ID, IP address), all crucial for linking the ceremony to your internal authentication records and audit logs.
```json
{
"Session ID": "a4f9e8b2-7c1d-4b2d-9a4b-e0c5d6f7a1b3",
"Order Reference": "25005",
"Authentication Timestamp": "2025-12-31T10:00:00Z",
"Authentication Method": "SMS",
"Phone Number": "+1-111-1111111",
"IP Address": "100.100.100.100"
}
```
--------------------------------
### Configure SignatureAPI 'Wait for envelope' action in Power Automate
Source: https://signatureapi-daf4ee54.mintlify.app/docs/integrations/power-automate/guides/quickstart
This snippet details the configuration of the 'Wait for envelope' action in Power Automate. This action pauses the flow for up to 30 days, waiting for all recipients to complete the signing process. It uses the 'Envelope ID' from the initial 'Create an envelope' action.
```APIDOC
Action: Wait for envelope
Description: Pauses the flow until the specified envelope's signing process is complete (up to 30 days).
Parameters:
- Name: Envelope ID
Type: string
Description: The unique identifier for the envelope to monitor.
Source: Output from the 'Create an envelope' action.
```
--------------------------------
### Create Envelope with Document and Recipient using cURL
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/guides/quickstart
This cURL command sends a POST request to the SignatureAPI's /v1/envelopes endpoint to create a new envelope. It includes a privacy policy document, specifies a single signer (Jane Doe), and defines a signature placeholder within the document. Replace 'key_test_xxxxxxxx' with your actual test API key.
```bash
curl -X POST \
-H 'Content-Type: application/json' \
-H 'X-API-Key: key_test_xxxxxxxx' \
-d '{
"title": "Dummy Consent",
"message": "Please review and sign the attached Dummy Privacy Policy for internal testing purposes. This document is not legally binding and is used solely for demonstration\n\nThank you for your cooperation.",
"documents": [
{
"url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/privacy-placeholder.pdf",
"places": [
{
"key": "signer_signs_here",
"type": "signature",
"recipient_key": "visitor"
}
]
}
],
"recipients": [
{
"key": "visitor",
"type": "signer",
"name": "Jane Doe",
"email": "jane@example.com"
}
]
}' \
https://api.signatureapi.com/v1/envelopes
```
--------------------------------
### Example API Response Data Fragment
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/create
This snippet illustrates a partial JSON object typically found within an API response. It showcases the 'created_at' field with a timestamp in ISO 8601 format and 'completed_at' as a nullable field, demonstrating common data types and structures in API payloads.
```JSON
"created_at": "2025-12-31T12:00:00.000Z",
"completed_at": null
}
```
--------------------------------
### Implement Sequential Signing Order
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/can_i
This feature enables defining a specific order in which signers must complete their actions within an envelope. The guide details how to set up sequential signing.
```APIDOC
API Guide: /docs/api/guides/how-to/sequential-signing
Description: Guide on implementing sequential signing for envelopes.
```
--------------------------------
### Configure Ceremony for Embedding with Wildcard Domain (API)
Source: https://signatureapi-daf4ee54.mintlify.app/docs/embedded/web-app
This API example shows how to update a ceremony to allow embedding from any domain by setting `embeddable_in` to `"*"`. This is useful for troubleshooting Content Security Policy (CSP) issues but is not recommended for production due to security implications.
```http
POST https://api.signatureapi.com/v1/recipients/re_5m393QvSqy9SasSmSIG5xS/ceremony HTTP/1.1
Content-Type: application/json
X-API-Key: key_test_...
{
"authentication": [
//...
],
"embeddable_in": [
"*"
]
}
```
--------------------------------
### Place Signature Using Document Placeholders
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/can_i
This capability enables placing signatures by identifying specific placeholder text within the document, offering flexibility for dynamic content. The guide details how to use placeholders.
```APIDOC
API Guide: /docs/api/guides/how-to/use-placeholders
Description: Guide on placing signatures using placeholders within documents.
```
--------------------------------
### Accessing SignatureAPI's llms-full.txt file
Source: https://signatureapi-daf4ee54.mintlify.app/docs/ai-toolkit/build
This URL provides access to the /llms-full.txt file, which combines SignatureAPI's complete documentation as a single file as context for AI tools. Users should be mindful of its large size (over 100K tokens) and potential impact on LLM model’s context limits and usage constraints.
```plaintext
https://signatureapi.com/llms-full.txt
```
--------------------------------
### SignatureAPI Docs Welcome
Source: https://context7_llms
The welcome page for SignatureAPI documentation.
```APIDOC
Topic: SignatureAPI Docs
Description: The welcome page for SignatureAPI documentation.
```
--------------------------------
### API Endpoint: Get Recipient Details
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/recipients/get
Documentation for the 'Get a recipient' API endpoint, detailing path parameters and expected return values.
```APIDOC
Path Parameters:
recipient_id:
type: string
required: true
description: The unique identifier of the recipient.
Returns:
200 OK:
description: Successful response with a recipient object.
reference: /docs/api/resources/recipients/object
Error:
description: An error occurred.
reference: /docs/api/errors
```
--------------------------------
### Accessing SignatureAPI's llms.txt file
Source: https://signatureapi-daf4ee54.mintlify.app/docs/ai-toolkit/build
This URL provides access to the /llms.txt file, which lists all available pages in the SignatureAPI documentation. AI tools can use this file to understand the documentation structure and find relevant content to user prompts.
```plaintext
https://signatureapi.com/llms.txt
```
--------------------------------
### SignatureAPI MCP Server Tools Overview
Source: https://signatureapi-daf4ee54.mintlify.app/docs/ai-toolkit/agents
Overview of tools available in the SignatureAPI Model Context Protocol (MCP) server for AI agents. Each tool corresponds to a specific API capability, grouped by resource type and invokable through the MCP protocol. This table outlines the tool name, the resource it acts on, its operation type (Read or Write), and its corresponding REST API documentation.
```APIDOC
Tools available in SignatureAPI MCP Server:
- Tool: create_envelope
Resource: Envelope
Operation: Write
Maps to: Create envelope
- Tool: retrieve_envelope
Resource: Envelope
Operation: Read
Maps to: Get envelope
- Tool: update_envelope
Resource: Envelope
Operation: Write
Maps to: Update envelope
- Tool: list_envelopes
Resource: Envelope
Operation: Read
Maps to: List envelopes
- Tool: cancel_envelope
Resource: Envelope
Operation: Write
Maps to: Cancel envelope
- Tool: delete_envelope
Resource: Envelope
Operation: Write
Maps to: Delete envelope
- Tool: list_envelope_events
Resource: Envelope
Operation: Read
Maps to: List envelope events
- Tool: retrieve_recipient
Resource: Recipient
Operation: Read
Maps to: Get recipient
- Tool: replace_recipient
Resource: Recipient
Operation: Write
Maps to: Replace recipient
- Tool: resend_recipient
Resource: Recipient
Operation: Write
Maps to: Resend recipient
- Tool: create_ceremony
Resource: Ceremony
Operation: Write
Maps to: Create ceremony
- Tool: list_recipient_events
Resource: Recipient
Operation: Read
Maps to: List recipient events
- Tool: retrieve_deliverable
Resource: Deliverable
Operation: Read
Maps to: Get deliverable
- Tool: create_file
Resource: File
Operation: Write
Maps to: Create file
```
--------------------------------
### Example Request to Cancel Envelope
Source: https://signatureapi-daf4ee54.mintlify.app/docs/api/resources/envelopes/cancel
An example JSON request body for canceling an envelope, including the endpoint and a sample API key for authentication.
```json
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/cancel
// X-API-Key: key_test_...
{
"reason": "Price renegotiated by John D."
}
```
--------------------------------
### Install react-native-webview
Source: https://signatureapi-daf4ee54.mintlify.app/docs/embedded/react-native
Installs the `react-native-webview` library, a dependency required for embedding web content in React Native applications.
```bash
npm install react-native-webview
```