SignatureAPI

https://signatureapi.com
Admin
SignatureAPI is a RESTful API platform for managing electronic document signing workflows, including...
Tokens:155,891
Snippets:1,925
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- To integrate into an app, install the SignatureAPI plugin (skills plus MCP server): https://signatureapi.com/docs/ai-toolkit/develop/agent-skills.md

================
CODE SNIPPETS
================
### Ceremony Object Configuration Examples

Source: https://signatureapi.com/docs/api/resources/ceremonies/object

Examples showing different authentication setups and their impact on the ceremony URL and embedding configuration.

```json
{
    "authentication": [
      {
        "type": "email_link",
        "subject_override": null,
        "message_override": null
      }
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "embeddable_in": [],
    "url_variant": "standard",
    "url": null
  }
```

```json
{
    "authentication": [
      {
        "type": "email_code"
      }
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "embeddable_in": [],
    "url_variant": "standard",
    "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
  }
```

```json
{
    "authentication": [
      {
        "type": "custom",
        "provider": "SuperApp",
        "data": {
          "Session ID": "se_88620999344",
          "Authenticated At": "Dec 31, 2025 23:59:59"
        }
      }
    ],
    "redirect_url": "https://www.example.com/redirect",
    "redirect_delay": 5,
    "embeddable_in": [
      "https://app.example.com"
    ],
    "url_variant": "standard",
    "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
  }
```

--------------------------------

### Define Signature Places

Source: https://signatureapi.com/docs/api/resources/places/signature

Examples demonstrating various ways to configure signature places, including placeholder-based, fixed-position, and multi-signature setups.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employer_first_signature",
        "type": "signature",
        "recipient_key": "employer",
        "height": 60
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employer_signature",
        "type": "signature",
        "recipient_key": "employer",
        "height": 60
      }
    ],
    "fixed_positions": [
      {
        "place_key": "employer_signature",
        "page": 2,
        "top": 360,
        "left": 72
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employer_signature_page_1",
        "type": "signature",
        "recipient_key": "employer",
        "height": 60
      },
      {
        "key": "employer_signature_page_3",
        "type": "signature",
        "recipient_key": "employer",
        "height": 60
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employee_signature",
        "type": "signature",
        "recipient_key": "employee",
        "height": 40
      }
    ]
    //...
  }
]
```

--------------------------------

### Upload Resource JSON Examples

Source: https://signatureapi.com/docs/api/resources/uploads/object

Examples of the JSON structure for temporary and permanent upload resources.

```json
{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}
```

```json
{
  "id": "upl_3joO7lxE8HVhOZmkCHFCxK",
  "retention": "permanent",
  "key": "contract-template-v2",
  "url": "https://api.signatureapi.com/v1/uploads/upl_3joO7lxE8HVhOZmkCHFCxK",
  "format": "docx",
  "sha_256": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
  "size": 234567,
  "created_at": "2025-12-30T12:00:00.000Z"
}
```

--------------------------------

### Create Envelope Request Examples

Source: https://signatureapi.com/docs/api/resources/envelopes/create

Examples showing both a minimal envelope creation request and a full configuration including branding, metadata, and complex recipient settings.

```json
// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "title": "Service Agreement",
  "message": "Please review the privacy policy and provide your signature.",
  "documents": [
    {
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/privacy-placeholder.pdf",
      "format": "pdf",
      "places": [
        {
          "key": "signer_signs_here",
          "type": "signature",
          "recipient_key": "visitor"
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "visitor",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ]
}
```

```json
// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "title": "Exploration Agreement",
  "label": "Exploration Agreement for Order Ref. 25005",
  "routing": "sequential",
  "message": "Please review the agreement and provide your signature.",
  "topics": [
    "sales",
    "project_blue"
  ],
  "metadata": {
    "customer_ref": "x9550501",
    "account_annual_revenue": "$4,500,000"
  },
  "branding": {
    "logo": "https://api.signatureapi.com/v1/uploads/upl_3jBYlxa9gv0fGLzFAnfwxe",
    "accent_color": "#9810fa",
    "email": {
      "footer": "**Disclaimer:** This email and its attachments may contain confidential information. If you are not the intended recipient, please delete it and notify the sender.",
      "logo_position": "left"
    }
  },
  "documents": [
    {
      "title": "Exploration Agreement",
      "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",
          "height": 60
        },
        {
          "key": "client_signs_here",
          "type": "signature",
          "recipient_key": "client",
          "height": 60
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "service_provider",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "signature_options": ["typed", "drawn"],
      "delivery_type": "email",
      "ceremony": {
        "authentication": [
          {
            "type": "email_code"
          }
        ],
        "redirect_url": "https://example.com/after-signing",
        "embeddable_in": [],
        "url_variant": "short"
      }
    },
    {
      "type": "signer",
      "key": "client",
      "name": "Michael J. Miller",
      "email": "michael@example.com",
      "signature_options": ["drawn"],
      "delivery_type": "email",
      "ceremony": {
        "authentication": [
          {
            "type": "custom",
            "provider": "My App",
            "data": {
              "session_id": "1234567890",
              "user_id": "user123"
            }
          }
        ],
        "redirect_url": null,
        "embeddable_in": [],
        "url_variant": "standard"
      }
    }
  ],
  "deliverable": {
    "type": "standard",
    "language": "en",
    "timezone": "UTC",
    "timestamp_format": "MM/DD/YYYY HH:mm:ss"
  }
}
```

--------------------------------

### Install WebView package

Source: https://signatureapi.com/docs/api/guides/how-to/embed-mobile

Install the react-native-webview dependency required for rendering the signing interface.

```bash
npm install react-native-webview
```

--------------------------------

### Example Event JSON

Source: https://signatureapi.com/docs/api/resources/events/object

A sample JSON payload representing a recipient.completed event.

```json
{
  "id": "evt_4p2oouvNvjp1I9ckgqycH2",
  "type": "recipient.completed",
  "timestamp": "2025-12-31T15:00:01.999Z",
  "data": {
    "object_id": "re_7v7Sion0vqjJioYmwfZ9mf",
    "object_type": "recipient",
    "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
    "envelope_metadata": {
      "deal_id": "50055",
      "deal_owner": "Jane C."
    },
    "recipient_type": "signer",
    "recipient_key": "client",
    "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72"
  }
}
```

--------------------------------

### POST /envelopes

Source: https://signatureapi.com/docs/api/resources/envelopes/create

Creates a new envelope and starts the signing process.

```APIDOC
## POST /envelopes

### Description
Creates an envelope and starts the signing process. The envelope begins in `processing` status while documents are validated and recipients are queued for notification.

### Method
POST

### Endpoint
/envelopes

### Parameters
#### Request Body
- **title** (string) - Required - The title of the envelope, displayed to recipients. Must be between 1 and 500 characters.
- **documents** (array of documents) - Required - The documents included in the envelope (1-10 documents).

#### Document Object
- **key** (string) - Optional - A user-provided identifier for this document.
- **title** (string) - Optional - An optional display name for the document.
- **url** (string) - Required - The URL where the document or template file is located.
- **format** (enum) - Required - The file format of the document (`pdf` or `docx`).
- **fixed_positions** (array) - Optional - Array of fixed positions for places.
- **places** (array) - Optional - Areas within a document where a recipient provides input.
```

--------------------------------

### List Deliverables Response

Source: https://signatureapi.com/docs/api/resources/deliverables/list

Example response containing a paginated list of deliverable objects.

```json
// HTTP/1.1 200 OK
{
  "links": {
    "next": null,
    "previous": null
  },
  "data": [
    {
      "id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
      "name": null,
      "envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
      "type": "standard",
      "status": "generated",
      //...
    },
    {
      "id": "del_MYSExzUfKEWsXYnkywsAGQr",
      "name": "hr_pack",
      "envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
      "type": "simple",
      "status": "generated",
      //...
    }
  ]
}
```

--------------------------------

### File Object Response

Source: https://signatureapi.com/docs/api/resources/files/object

Example of the JSON response returned when interacting with the File resource.

```json
{
  "id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
  "expires_at": "2025-12-31T20:00:00.000Z"
}
```

--------------------------------

### List Deliverables Request

Source: https://signatureapi.com/docs/api/resources/deliverables/list

Example request for retrieving deliverables using the envelope ID.

```json
// GET https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
```

--------------------------------

### Create Ceremony Response Examples

Source: https://signatureapi.com/docs/api/resources/ceremonies/create

Expected response objects returned upon successful creation of a ceremony.

```json
// HTTP/1.1 201 Created
  {
    "authentication": [
      {
        "type": "email_link",
        "subject_override": "Please sign the Service Agreement",
        "message_override": "Please review and sign the attached agreement."
      }
    ],
    "embeddable_in": [],
    "redirect_url": null,
    "redirect_delay": 3,
    "url_variant": "standard",
    "url": null
  }
```

```json
// HTTP/1.1 201 Created
  {
    "authentication": [
      {
        "type": "email_code"
      }
    ],
    "embeddable_in": [],
    "redirect_url": null,
    "redirect_delay": 3,
    "url_variant": "standard",
    "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
  }
```

```json
// HTTP/1.1 201 Created
  {
    "authentication": [
      {
        "type": "custom",
        "provider": "SuperApp",
        "data": {
          "Session ID": "se_88620999344",
          "Authenticated At": "2025-12-31T23:59:59Z"
        }
      }
    ],
    "embeddable_in": [
      "https://superapp.example.com"
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "url_variant": "standard",
    "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
  }
```

```json
// HTTP/1.1 201 Created
  {
    "authentication": [
      {
        "type": "email_link"
      }
    ],
    "embeddable_in": [],
    "redirect_url": "https://example.com/signing-complete",
    "redirect_delay": 5,
    "url_variant": "standard",
    "url": null
  }
```

```json
// HTTP/1.1 201 Created
  {
    "authentication": [
      {
        "type": "custom",
        "provider": "MyApp",
        "data": {
          "user_id": "usr_12345"
        }
      }
    ],
    "embeddable_in": [
      "https://app.example.com",
      "https://staging.example.com"
    ],
    "redirect_url": "https://app.example.com/done",
    "redirect_delay": 3,
    "url_variant": "standard",
    "url": "https://sign.signatureapi.com/en/start?token=eyJhbGciOiJFUzI1NiIsInR..."
  }
```

--------------------------------

### Retrieve Deliverable Response

Source: https://signatureapi.com/docs/api/resources/deliverables/get

Example response body containing deliverable metadata and the download URL.

```json
// HTTP/1.1 200 OK
{
  "id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
  "name": null,
  "envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
  "type": "standard",
  "status": "generated",
  "url": "https://vault.signatureapi.com/envelopes/4ec99c57-4430-4d73-8afd-912dcf4b5880/deliverables/del_LXRDwyTeJDVrWXmjwxsAGPq...",
  "language": "en",
  "timezone": "America/New_York",
  "timestamp_format": "MM/DD/YYYY HH:mm:ss",
  "included_documents": ["contract", "addendum"],
  "password": null,
  "created_at": "2024-01-01T00:00:00Z",
  "generated_at": "2024-01-01T00:01:00Z"
}
```

--------------------------------

### Retrieve Deliverable Request

Source: https://signatureapi.com/docs/api/resources/deliverables/get

Example request format for fetching a deliverable by its unique identifier.

```json
// GET https://api.signatureapi.com/v1/deliverables/{deliverable_id}
// X-API-Key: key_test_...
```

--------------------------------

### Retrieve Upload Response

Source: https://signatureapi.com/docs/api/resources/uploads/get

Example JSON responses for temporary and permanent upload types.

```json
// HTTP/1.1 200 OK
{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}
```

```json
// HTTP/1.1 200 OK
{
  "id": "upl_3joO7lxE8HVhOZmkCHFCxK",
  "retention": "permanent",
  "key": "contract-template-v2",
  "url": "https://api.signatureapi.com/v1/uploads/upl_3joO7lxE8HVhOZmkCHFCxK",
  "format": "docx",
  "sha_256": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
  "size": 234567,
  "created_at": "2025-12-30T12:00:00.000Z"
}
```

--------------------------------

### Metadata Usage Examples

Source: https://signatureapi.com/docs/api/resources/envelopes/metadata

Various patterns for structuring metadata to support different business requirements.

```json
{
  "title": "Investment Agreement",
  "metadata": {
    "deal_id": "DEAL-2026-0042",
    "investor_id": "INV-88421",
    "round": "Series A",
    "amount": "500000"
  }
  //...
}
```

```json
{
  "title": "Loan Application",
  "metadata": {
    "application_id": "APP-78542",
    "correlation_id": "corr_a1b2c3d4",
    "source_system": "loan-origination"
  }
  //...
}
```

```json
{
  "title": "Service Agreement",
  "metadata": {
    "customer_id": "CUST-12345",
    "contract_number": "CNT-2026-001",
    "sales_rep": "jsmith"
  }
  //...
}
```

--------------------------------

### Start Envelope

Source: https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Initiates an envelope using the specified Envelope ID and returns the current status of the envelope.

```APIDOC
## Start Envelope

### Description
Initiates an envelope process. Requires the Envelope ID as input and returns the current status of the envelope.

### Parameters
#### Input
- **Envelope ID** (string) - Required - The ID of the envelope.

### Response
- **Envelope Status** (string) - The current status of the envelope. Available options: `draft`, `processing`, `in_progress`, `completed`, `failed`, `canceled`.
```

--------------------------------

### POST /v1/envelopes

Source: https://signatureapi.com/docs/api/resources/recipients/approver

Example of creating an envelope with an approver recipient using sequential routing.

```APIDOC
## POST /v1/envelopes

### Description
Creates a new envelope including an approver recipient. The approver reviews and approves the document before subsequent signers.

### Method
POST

### Endpoint
/v1/envelopes

### Request Body
- **title** (string) - Required - The title of the envelope.
- **recipients** (array) - Required - List of recipients. Use `"type": "approver"` for approvers.
- **routing** (string) - Optional - Set to `"sequential"` to ensure the approver acts before the signer.

### Request Example
{
    "title": "Service Agreement",
    "recipients": [
        {
            "key": "manager",
            "type": "approver",
            "name": "Sarah Chen",
            "email": "sarah@company.com"
        },
        {
            "key": "client",
            "type": "signer",
            "name": "Michael Torres",
            "email": "michael@client.com"
        }
    ],
    "routing": "sequential"
}
```

--------------------------------

### Upload Response Examples

Source: https://signatureapi.com/docs/api/resources/uploads/create

Successful responses return a 201 Created status along with the upload object details.

```json
// HTTP/1.1 201 Created
{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}
```

```json
// HTTP/1.1 201 Created
{
  "id": "upl_3joO7lxE8HVhOZmkCHFCxK",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_3joO7lxE8HVhOZmkCHFCxK",
  "format": "docx",
  "sha_256": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
  "size": 234567,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}
```

```json
// HTTP/1.1 201 Created
  {
    "id": "upl_7kBBcD2eF3gHiJkLmNoPqR",
    "retention": "temporary",
    "url": "https://api.signatureapi.com/v1/uploads/upl_7kBBcD2eF3gHiJkLmNoPqR",
    "format": "png",
    "sha_256": "fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210",
    "size": 51200,
    "created_at": "2025-12-30T12:00:00.000Z",
    "expires_at": "2025-12-31T12:00:00.000Z"
  }
```

--------------------------------

### List Envelope Events Request

Source: https://signatureapi.com/docs/api/resources/events/envelope

Example request to retrieve events for a specific envelope using the GET method.

```json
// GET https://api.signatureapi.com/v1/envelopes/2dc5d4bb-5f4e-41a8-aea8-077a48587e31/events
// X-API-Key: key_test_...
```

--------------------------------

### Recipient Name Place Examples

Source: https://signatureapi.com/docs/api/resources/places/recipient-name

Various configurations for recipient name places, including placeholder-based, fixed-position, multiple-recipient, and custom font size setups.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "client_name",
        "type": "recipient_name",
        "recipient_key": "client"
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "signer_name",
        "type": "recipient_name",
        "recipient_key": "signer"
      }
    ],
    "fixed_positions": [
      {
        "place_key": "signer_name",
        "page": 1,
        "top": 180,
        "left": 150
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "buyer_name",
        "type": "recipient_name",
        "recipient_key": "buyer"
      },
      {
        "key": "seller_name",
        "type": "recipient_name",
        "recipient_key": "seller"
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employee_name",
        "type": "recipient_name",
        "recipient_key": "employee",
        "font_size": 10
      }
    ]
    //...
  }
]
```

--------------------------------

### Recipient Email Place Configuration Examples

Source: https://signatureapi.com/docs/api/resources/places/recipient-email

Various configurations for recipient email places, including placeholder-based, fixed-position, multi-recipient, and custom font size setups.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "client_email",
        "type": "recipient_email",
        "recipient_key": "client"
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "signer_email",
        "type": "recipient_email",
        "recipient_key": "signer"
      }
    ],
    "fixed_positions": [
      {
        "place_key": "signer_email",
        "page": 1,
        "top": 200,
        "left": 150
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "buyer_email",
        "type": "recipient_email",
        "recipient_key": "buyer"
      },
      {
        "key": "seller_email",
        "type": "recipient_email",
        "recipient_key": "seller"
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "applicant_email",
        "type": "recipient_email",
        "recipient_key": "applicant",
        "font_size": 10
      }
    ]
    //...
  }
]
```

--------------------------------

### Access the full documentation index

Source: https://signatureapi.com/docs/ai-toolkit/develop/llms-txt

Use this URL for models with large context windows when you need the entire reference available at once.

```text
https://signatureapi.com/llms-full.txt
```

--------------------------------

### Document Configuration Examples

Source: https://signatureapi.com/docs/api/resources/documents

JSON representations of document objects for PDF and DOCX formats, including fixed positions and signature places.

```json
{
  "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
  "key": "agreement",
  "title": "Service Agreement",
  "page_count": 3,
  "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/agreement.pdf",
  "format": "pdf",
  "fixed_positions": [
    {
      "place_key": "provider_signs_here",
      "page": 3,
      "top": 600,
      "left": 72
    }
  ],
  "places": [
    {
      "key": "provider_signs_here",
      "type": "signature",
      "recipient_key": "service_provider",
      "height": 60
    },
    {
      "key": "client_signs_here",
      "type": "signature",
      "recipient_key": "client",
      "height": 60
    }
  ]
}
```

```json
{
  "id": "doc_8hKpmnFR6CFr6oChasgVb9",
  "envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
  "key": "agreement",
  "title": "Service Agreement",
  "page_count": 2,
  "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/agreement-template.docx",
  "format": "docx",
  "data": {
    "date": "December 31st, 2025",
    "serviceProvider": {
      "name": "Jane Smith",
      "organization": "ACME Global, Inc."
    },
    "client": {
      "name": "Michael J. Miller",
      "organization": "Miller Industries"
    }
  },
  "fixed_positions": [],
  "places": [
    {
      "key": "provider_signs_here",
      "type": "signature",
      "recipient_key": "service_provider",
      "height": 60
    },
    {
      "key": "client_signs_here",
      "type": "signature",
      "recipient_key": "client",
      "height": 60
    }
  ]
}
```

--------------------------------

### Envelope Started Trigger

Source: https://signatureapi.com/docs/integrations/power-automate/triggers/envelope-started

The Envelope Started trigger initiates a flow when an envelope is started. It accepts optional topic filtering and returns event-specific metadata.

```APIDOC
## Envelope Started Trigger

### Description
This trigger initiates a Power Automate flow when an envelope process is started. It allows for classification and filtering of notifications.

### Input
- **Topics** (array of string) - Optional - Use to classify envelopes and filter webhook notifications.

### Output
- **Event ID** (string) - The ID of the event.
- **Event Timestamp** (string) - The date and time of the event, in ISO 8601 format.
- **Event Type** (string) - The type of the event.
- **Envelope ID** (string) - The ID of the envelope this event refers to.
```

--------------------------------

### Configure Multiline Text Input Fields

Source: https://signatureapi.com/docs/api/resources/places/multiline-text-input

Examples showing various configurations for multiline text inputs including comments, mailing addresses, and request reasons.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "customer_comments",
        "type": "multiline_text_input",
        "recipient_key": "customer",
        "capture_as": "comments",
        "prompt": "Enter your comments here...",
        "hint": "Please provide detailed feedback",
        "requirement": "optional",
        "width": 400,
        "line_count": 5,
        "line_height": 14,
        "font_size": 10
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "full_address",
        "type": "multiline_text_input",
        "recipient_key": "applicant",
        "capture_as": "mailing_address",
        "prompt": "Enter your complete mailing address",
        "requirement": "required",
        "width": 350,
        "line_count": 3
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "request_reason",
        "type": "multiline_text_input",
        "recipient_key": "requester",
        "capture_as": "reason",
        "hint": "Describe why this request is needed",
        "requirement": "required",
        "width": 450,
        "line_count": 4,
        "font_size": 10
      }
    ]
    //...
  }
]
```

--------------------------------

### Configure Checkbox Places

Source: https://signatureapi.com/docs/api/resources/places/checkbox

Examples showing various configurations for checkbox places, including optional, required, custom symbols, and data capture.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "receive_marketing_emails",
        "type": "checkbox",
        "recipient_key": "employee",
        "symbol": "check",
        "height": 10
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "accept_terms",
        "type": "checkbox",
        "recipient_key": "customer",
        "symbol": "check",
        "requirement": "required",
        "height": 12
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "decline_arbitration",
        "type": "checkbox",
        "recipient_key": "customer",
        "symbol": "xmark",
        "height": 10
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "agreed_to_terms",
        "type": "checkbox",
        "recipient_key": "borrower",
        "symbol": "check",
        "requirement": "required",
        "capture_as": "terms_accepted",
        "height": 12
      }
    ]
    //...
  }
]
```

--------------------------------

### General Error Payload Example

Source: https://signatureapi.com/docs/api/errors

Example of a standard JSON error response for 4XX and 5XX status codes.

```json
{
  "type": "https://signatureapi.com/docs/v1/errors/invalid-api-key",
  "title": "Invalid API Key",
  "status": 401,
  "detail": "Please provide a valid API key in the X-API-Key header."
}
```

--------------------------------

### Configure Hints and Prompts

Source: https://signatureapi.com/docs/api/resources/places/multiline-text-input

Use hint and prompt fields to provide guidance to the recipient within the input area.

```json
{
  //...
  "hint": "Describe the reason for this request",
  "prompt": "Enter your comments here..."
  //...
}
```

--------------------------------

### Access the compact documentation index

Source: https://signatureapi.com/docs/ai-toolkit/develop/llms-txt

Use this URL for IDE assistants that fetch documentation pages on demand.

```text
https://signatureapi.com/llms.txt
```

--------------------------------

### Validation Error Payload Example

Source: https://signatureapi.com/docs/api/errors

Example of a JSON error response for 422 validation errors, containing a list of specific field issues.

```json
{
  "type": "https://signatureapi.com/docs/v1/errors/validation-error",
  "title": "Validation Error",
  "status": 422,
  "errors": [
    "documents[0].url protocol must be HTTPS",
    "recipients[0].email must be a valid email address"
  ]
}
```

--------------------------------

### Create file request

Source: https://signatureapi.com/docs/api/resources/files/create

The POST request to initiate file creation.

```json
// POST https://api.signatureapi.com/v1/files
// X-API-Key: key_test_...
```

--------------------------------

### Configure Hints and Prompts for Boxed Text Input

Source: https://signatureapi.com/docs/api/resources/places/boxed-text-input

Use the hint property to provide tooltip guidance and the prompt property to set placeholder text for the input field.

```json
{
  //...
  "hint": "Enter the 6-digit code from your email",
  "prompt": "0"
  //...
}
```

--------------------------------

### Retrieve SharePoint Item ID

Source: https://signatureapi.com/docs/integrations/power-automate/guides/how-to/ceremony-custom-twilio

Expression used within the Get Item action to extract the ID from the previous Get Items result.

```Power Automate Expression
first(body('Get_items')?['value'])?['ID']
```

--------------------------------

### GET /v1/envelopes/{envelope_id}

Source: https://signatureapi.com/docs/api/resources/envelopes/get

Retrieves an envelope object by its ID.

```APIDOC
## GET /v1/envelopes/{envelope_id}

### Description
Retrieves the details of a specific envelope using its unique identifier.

### Method
GET

### Endpoint
https://api.signatureapi.com/v1/envelopes/{envelope_id}

### Parameters
#### Path Parameters
- **envelope_id** (string) - Required - The unique identifier of the envelope to retrieve.

### Response
#### Success Response (200)
- **envelope** (object) - Returns an envelope object containing details such as id, title, status, recipients, and documents.

#### Response Example
{
  "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "title": "Exploration Agreement",
  "status": "completed",
  "sender": {
    "name": "Jennifer Lee",
    "email": "jennifer@example.com"
  }
}
```

--------------------------------

### GET /v1/envelopes

Source: https://signatureapi.com/docs/api/resources/envelopes/topics

Retrieve a list of envelopes filtered by a specific topic.

```APIDOC
## GET /v1/envelopes

### Description
Retrieves envelopes associated with a specific topic.

### Method
GET

### Endpoint
/v1/envelopes

### Parameters
#### Query Parameters
- **topic** (string) - Optional - The topic name to filter envelopes by.
```

--------------------------------

### Create Deliverable Request Examples

Source: https://signatureapi.com/docs/api/resources/deliverables/create

Various request payloads for creating deliverables, including standard, simple, password-protected, and filtered document configurations.

```json
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "type": "standard"
}
```

```json
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "type": "simple"
}
```

```json
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "type": "standard",
  "password": "SecurePass123",
  "language": "en",
  "timezone": "America/New_York",
  "timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
```

```json
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json

{
  "type": "standard",
  "included_documents": ["contract", "addendum"]
}
```

--------------------------------

### Initials Place Configuration Examples

Source: https://signatureapi.com/docs/api/resources/places/initials

Various configurations for initials places, including placeholder-based, fixed-position, multi-page, and compact sizing.

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employer_initials",
        "type": "initials",
        "recipient_key": "employer",
        "height": 60
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "employer_initials",
        "type": "initials",
        "recipient_key": "employer",
        "height": 40
      }
    ],
    "fixed_positions": [
      {
        "place_key": "employer_initials",
        "page": 1,
        "top": 720,
        "left": 500
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "client_initials_p1",
        "type": "initials",
        "recipient_key": "client",
        "height": 30
      },
      {
        "key": "client_initials_p2",
        "type": "initials",
        "recipient_key": "client",
        "height": 30
      },
      {
        "key": "client_initials_p3",
        "type": "initials",
        "recipient_key": "client",
        "height": 30
      }
    ],
    "fixed_positions": [
      {
        "place_key": "client_initials_p1",
        "page": 1,
        "top": 720,
        "left": 520
      },
      {
        "place_key": "client_initials_p2",
        "page": 2,
        "top": 720,
        "left": 520
      },
      {
        "place_key": "client_initials_p3",
        "page": 3,
        "top": 720,
        "left": 520
      }
    ]
    //...
  }
]
```

```json
"documents": [
  {
    //...
    "places": [
      {
        "key": "witness_initials",
        "type": "initials",
        "recipient_key": "witness",
        "height": 25
      }
    ]
    //...
  }
]
```

--------------------------------

### Get Capture

Source: https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Retrieves the value of a recipient input capture from a specified envelope.

```APIDOC
## Get Capture

### Description
Retrieves the value of a recipient input capture from a specified envelope using the envelope ID and the captured key.

### Parameters
- **Envelope ID** (string) - Required - The ID of the envelope.
- **Captured Key** (string) - Required - The key of the captured value.

### Response
- **Capture Value** (string) - The value of the recipient input capture.
```

--------------------------------

### GET /v1/uploads/{upload_id}

Source: https://signatureapi.com/docs/api/resources/uploads/get

Retrieves the metadata for an existing upload by its unique identifier.

```APIDOC
## GET /v1/uploads/{upload_id}

### Description
Retrieve the metadata for an existing upload. The response includes the file format, size, SHA-256 hash, retention type, and creation time.

### Method
GET

### Endpoint
https://api.signatureapi.com/v1/uploads/{upload_id}

### Parameters
#### Path Parameters
- **upload_id** (string) - Required - The unique identifier of the upload.

### Response
#### Success Response (200)
- Returns an upload object containing metadata such as id, retention, format, sha_256, size, and created_at.

#### Response Example
{
  "id": "upl_1sAAaVfabdt0esVjmSTmLA",
  "retention": "temporary",
  "url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
  "format": "pdf",
  "sha_256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "size": 102400,
  "created_at": "2025-12-30T12:00:00.000Z",
  "expires_at": "2025-12-31T12:00:00.000Z"
}
```

--------------------------------

### GET /v1/senders/{sender_id}

Source: https://signatureapi.com/docs/api/resources/senders/get

Retrieves the details of a sender, including its verification status.

```APIDOC
## GET /v1/senders/{sender_id}

### Description
Retrieves the details of a sender. Use this endpoint to check the current verification status of a sender after creation.

### Method
GET

### Endpoint
https://api.signatureapi.com/v1/senders/{sender_id}

### Parameters
#### Path Parameters
- **sender_id** (string) - Required - The unique identifier of the sender.

### Response
#### Success Response (200)
- Returns a sender object on success.

#### Response Example
{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "jennifer@example.com",
    "status": "verified",
    "created_at": "2025-01-01T00:00:00.000Z"
}
```

--------------------------------

### POST /v1/senders

Source: https://signatureapi.com/docs/api/resources/senders/create

Registers a new sender email address and starts the verification process.

```APIDOC
## POST /v1/senders

### Description
Registers a new sender email address and starts the verification process. SignatureAPI sends a verification email to the provided address.

### Method
POST

### Endpoint
https://api.signatureapi.com/v1/senders

### Parameters
#### Request Body
- **email** (string) - Required - The email address to register as a sender. Must be a valid email address. Maximum 320 characters.

### Request Example
{
    "email": "jennifer@example.com"
}

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the sender.
- **email** (string) - The registered email address.
- **status** (string) - The current status of the sender (e.g., pending_verification).
- **created_at** (string) - The timestamp when the sender was created.

#### Response Example
{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "jennifer@example.com",
    "status": "pending_verification",
    "created_at": "2025-01-01T00:00:00.000Z"
}
```

--------------------------------

### Configure Context7 in Cursor

Source: https://signatureapi.com/docs/ai-toolkit/develop/context7

Add the Context7 MCP server to the Cursor configuration file.

```json
{
  "mcpServers": {
    "context7": {
      "url": "https://mcp.context7.com/mcp"
    }
  }
}
```
Tokens:
Raw