### Initials Place Examples

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

Illustrates different ways to configure initials places, including basic setup, fixed positioning, and placement across multiple pages.

```APIDOC
### Examples

#### Basic (Placeholder)
```json
{
  "documents": [
    {
      "places": [
        {
          "key": "employer_initials",
          "type": "initials",
          "recipient_key": "employer",
          "height": 60
        }
      ]
    }
  ]
}
```

#### Fixed Position
```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
        }
      ]
    }
  ]
}
```

#### Initials on Multiple Pages
```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
        }
      ]
    }
  ]
}
```

#### Compact Initials
```json
{
  "documents": [
    {
      "places": [
        {
          "key": "witness_initials",
          "type": "initials",
          "recipient_key": "witness",
          "height": 25
        }
      ]
    }
  ]
}
```
```

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

### Create file request example

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

This is an example of a POST request to the `/v1/files` endpoint to register a new temporary file. No request body is needed.

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

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

### Retrieve Upload Response Examples

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

Examples of the JSON response structure for temporary and permanent file uploads.

```json
// HTTP Status Code 200

{
  "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 Status Code 200

{
  "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"
}
```

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

### Store Upload Request Example

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

This example demonstrates a POST request to store an upload, converting it to a permanent file. The `uploadId` is a path parameter, and the `key` is provided in the JSON request body.

```bash
POST https://api.signatureapi.com/v1/uploads/{uploadId}/store
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "key": "contract-template-v2"
}
```

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

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

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

Examples of deliverable objects for both 'standard' and 'simple' types.

```APIDOC
### Standard Deliverable Example (HTTP 200)

```json
{
  "id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
  "name": null,
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "standard",
  "status": "generated",
  "url": "https://vault.signatureapi.com/envelopes/52872f0e-b919-4d69-89cd-e7e56af00548/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"
}
```

### Simple Deliverable Example (HTTP 200)

```json
{
  "id": "del_MYSExzUfKEWsXYnkywsAGQr",
  "name": null,
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "simple",
  "status": "generated",
  "url": "https://vault.signatureapi.com/envelopes/52872f0e-b919-4d69-89cd-e7e56af00548/deliverables/del_MYSExzUfKEWsXYnkywsAGQr...",
  "included_documents": ["contract", "addendum"],
  "password": null,
  "created_at": "2024-01-01T00:00:00Z",
  "generated_at": "2024-01-01T00:01:00Z"
}
```
```

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

### Get Recipient Request Example

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

Use this example to make a GET request to retrieve recipient details. Ensure you replace `{recipient_id}` with the actual recipient ID and include your API key in the headers.

```http
// GET https://api.signatureapi.com/v1/recipients/{recipient_id}
// X-API-Key: key_test_...
```

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

### Boxed Text Input Examples

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

Provides examples of how to configure 'boxed_text_input' places for different use cases like verification codes, SSN, and Tax IDs.

```APIDOC
## Examples for boxed_text_input Place

### Verification Code Example
```json
{
  "key": "verification_code",
  "type": "boxed_text_input",
  "recipient_key": "signer",
  "font_size": 12,
  "width": 150,
  "height": 20,
  "box_count": 6,
  "capture_as": "verification_code",
  "hint": "Enter the 6-digit code from your email",
  "requirement": "required"
}
```

### Last 4 of SSN Example
```json
{
  "key": "ssn_last_four",
  "type": "boxed_text_input",
  "recipient_key": "applicant",
  "font_size": 12,
  "width": 100,
  "height": 20,
  "box_count": 4,
  "capture_as": "ssn_last_four",
  "hint": "Last 4 digits of your Social Security Number",
  "requirement": "required"
}
```

### Tax ID (EIN) Example
```json
{
  "key": "ein",
  "type": "boxed_text_input",
  "recipient_key": "taxpayer",
  "font_size": 12,
  "width": 225,
  "height": 20,
  "box_count": 9,
  "capture_as": "ein",
  "hint": "Enter your 9-digit Employer Identification Number",
  "requirement": "required"
}
```
```

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

### List events request

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

Example request for retrieving account events.

```json
// GET https://api.signatureapi.com/v1/events
// X-API-Key: key_test_...
```

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

### Retrieve deliverable via API

Source: https://signatureapi.com/docs/api/guides/use-cases/save-signed-documents

API request and response examples for fetching deliverable details directly.

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

```json
// HTTP Status Code 200

{
  "id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
  "envelope_id": "55072f0e-b919-4d69-89cd-e7e56af00530",
  "type": "standard",
  "status": "generated",
  "url": "https://vault.signatureapi.com/envelopes/55072f0e-b919-4d69-89cd-e7e56af00530/deliverables/del_LXRDwyTeJDVrWXmjwxsAGPq...",
  //...
}
```

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

### List events response

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

Example response containing a paginated list of event objects.

```json
// HTTP Status Code 200

{
  "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",
      "timestamp": "2025-12-31T23:59:00.000Z",
      "data": {
        "object_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "object_type": "envelope",
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "envelope_metadata": {}
      }
    },
    {
      "id": "evt_7BFIYuMgWzJ1AHscS0RNxC",
      "type": "recipient.completed",
      "timestamp": "2025-12-31T23:58:59.000Z",
      "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "envelope_id": "2dc5d4bb-5f4e-41a8-aea8-077a48587e31",
        "envelope_metadata": {},
        "recipient_type": "signer",
        "recipient_key": "client",
        "session_id": "ses_2X6eHBCL84MDGrLQX0mHI72"
      }
    },
    //...
  ]
}
```

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

### Create an Envelope Request

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

Examples of minimal and full request payloads for creating an envelope.

```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"
  }
}
```

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

### Upload PDF using Go (net/http)

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

This Go example demonstrates uploading a PDF file using the standard net/http package. It reads the file content into a byte slice and constructs the HTTP request.

```go
package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  file, err := os.Open("/path/to/file.pdf")
  if err != nil {
    panic(err)
  }
  defer file.Close()

  data, err := io.ReadAll(file)
  if err != nil {
    panic(err)
  }

  req, err := http.NewRequest("POST", "https://api.signatureapi.com/v1/uploads", bytes.NewReader(data))
  if err != nil {
    panic(err)
  }
  req.Header.Set("Content-Type", "application/pdf")
  req.Header.Set("X-API-Key", "key_test_...")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}
```

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

### Dropdown capture

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

This example demonstrates capturing a selection from a predefined list using a dropdown place. It shows how to specify options and capture the selected value.

```json
// Request places
[
  {
    "key": "state_selection",
    "type": "dropdown",
    "recipient_key": "applicant",
    "options": "us_states_2_letter_codes",
    "capture_as": "state",
    "requirement": "required"
  }
]

// Response captures
{
  "captures": {
    "state": "CA"
  }
}
```

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

### Configure Hints and Prompts

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

Use hint and prompt properties to provide guidance to recipients within the text input field.

```json
{
  //...
  "hint": "Your 8-digit reference code",
  "prompt": "12345678"
  //...
```

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

### Webhook Event Payload Example

Source: https://signatureapi.com/docs/api/guides/how-to/set-up-webhooks

Example JSON structure for a recipient.completed event sent to your webhook endpoint.

```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"
  }
}
```

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

### Configure Hint and Prompt for Boxed Input

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

Use `hint` for tooltips and `prompt` for placeholder text inside the first box of a boxed text input. This guides recipients on expected input.

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

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

### Start an Envelope

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

Initiates the signing process for an envelope. This endpoint is used to start the workflow for sending an envelope for signature.

```APIDOC
## POST /envelopes/start

### Description
Initiates the signing process for an envelope.

### Method
POST

### Endpoint
/envelopes/start

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

### Request Body
(No request body specified in the documentation)

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

#### Response Example
```json
{
  "Envelope Status": "processing"
}
```
```

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

### Text Input Configuration Examples

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

Various configurations for text input fields, including email validation, custom regex patterns, and layout adjustments.

```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",
          "width": 200,
          "font_size": 8
        }
      ]
      //...
    }
  ]
```

```json
"documents": [
    {
      //...
      "places": [
        {
          "key": "reference_number",
          "type": "text_input",
          "recipient_key": "applicant",
          "capture_as": "ref_number",
          "prompt": "12345678",
          "hint": "Your 8-digit reference code",
          "format": "/^[0-9]{8}$/",
          "format_message": "Must be exactly 8 digits",
          "requirement": "required",
          "width": 120
        }
      ]
      //...
    }
  ]
```

```json
"documents": [
    {
      //...
      "places": [
        {
          "key": "mailing_address",
          "type": "text_input",
          "recipient_key": "borrower",
          "capture_as": "borrower_address",
          "prompt": "123 Main St, City, State ZIP",
          "hint": "Enter your full mailing address",
          "requirement": "required",
          "width": 350,
          "font_size": 10
        }
      ]
      //...
    }
  ]
```

```json
"documents": [
    {
      //...
      "places": [
        {
          "key": "zip_code",
          "type": "text_input",
          "recipient_key": "customer",
          "capture_as": "customer_zip",
          "prompt": "90210",
          "format": "zipcode-us",
          "requirement": "required",
          "width": 80
        }
      ]
      //...
    }
  ]
```

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

### Recipient Response Examples

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

JSON response structures for different recipient roles. These examples demonstrate the fields returned for signers, approvers, and preparers.

```json
// HTTP Status 200

{
  "id": "re_26w2VVV5JVm4j459TY5BNM",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "signer",
  "key": "client",
  "name": "Emily Johnson",
  "email": "emily@example.com",
  "status": "completed",
  "status_updated_at": "2025-12-31T15:00:00.000Z",
  "completed_at": "2025-12-31T15:00:00.000Z",
  "delivery_type": "email",
  "signature_options": ["typed", "drawn"],
  "ceremony": {
    "authentication": [
      {
        "type": "email_link",
        "subject_override": null,
        "message_override": null
      }
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "embeddable_in": [],
    "url_variant": "standard",
    "url": null
  },
  "ceremony_creation": "automatic"
}
```

```json
// HTTP Status 200

{
  "id": "re_7KpQVVV5JVm4j459TY5ABC",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "approver",
  "key": "manager",
  "name": "Sarah Chen",
  "email": "sarah@example.com",
  "status": "completed",
  "status_updated_at": "2025-12-31T14:30:00.000Z",
  "completed_at": "2025-12-31T14:30:00.000Z",
  "delivery_type": "none",
  "ceremony": {
    "authentication": [
      {
        "type": "email_link",
        "subject_override": null,
        "message_override": null
      }
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "embeddable_in": [],
    "url_variant": "standard",
    "url": null
  },
  "ceremony_creation": "automatic"
}
```

```json
// HTTP Status 200

{
  "id": "re_9XtRVVV5JVm4j459TY5DEF",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "type": "preparer",
  "key": "sales_rep",
  "name": "Alex Smith",
  "email": "alex@example.com",
  "status": "completed",
  "status_updated_at": "2025-12-31T14:00:00.000Z",
  "completed_at": "2025-12-31T14:00:00.000Z",
  "delivery_type": "none",
  "ceremony": {
    "authentication": [
      {
        "type": "email_link",
        "subject_override": null,
        "message_override": null
      }
    ],
    "redirect_url": null,
    "redirect_delay": 3,
    "embeddable_in": [],
    "url_variant": "standard",
    "url": null
  },
  "ceremony_creation": "automatic"
}
```

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

### Configure Hint and Prompt for Multi-Line Text Input

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

Use 'hint' for tooltips and 'prompt' for placeholder text within a multi-line text input field. These guide recipients during the signing process.

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

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

### Sender Object Example

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

This JSON object represents a sender in the Signature API, showing an example of all attributes including ID, email, status, and creation time.

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

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

### Configure Initials Place 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
        }
      ]
      //...
    }
  ]
```

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

### Checkbox capture

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

This example shows how to use checkbox places to capture boolean consent or agreement from recipients. It includes examples for required terms acceptance and optional marketing consent.

```json
// Request places
[
  {
    "key": "accept_terms",
    "type": "checkbox",
    "recipient_key": "customer",
    "capture_as": "terms_accepted",
    "requirement": "required"
  },
  {
    "key": "marketing_opt_in",
    "type": "checkbox",
    "recipient_key": "customer",
    "capture_as": "marketing_consent"
  }
]

// Response captures
{
  "captures": {
    "terms_accepted": true,
    "marketing_consent": false
  }
}
```

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

### Example Placeholder Usage in Contract

Source: https://signatureapi.com/docs/integrations/power-automate/guides/how-to/envelope-add-row-to-dataverse

Demonstrates how to integrate dynamic fields and signature placeholders within the text of a contract document. Ensure placeholders are clearly defined.

```plaintext
> *Dear `{{employee.first_name}}` `{{employee.last_name}}`,*

> *This will be the salary amount you will receive per month: `[[salary_input]]`*

> *Employer Signature:*

> `[[employer_signature]]`

> *Employee Signature:*

> `[[employee_signature]]`
```

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

### GET Request to List Recipient Events

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

Use this GET request to retrieve all events for a specific recipient. Include your API key in the headers. The recipient ID is a required path parameter.

```http
GET https://api.signatureapi.com/v1/recipients/re_00ZeZjRaXCgT30n1eBx53N/events
X-API-Key: key_test_...
```

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

### Upload PDF using C# (HttpClient)

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

This C# example demonstrates uploading a PDF file using HttpClient. It reads the file into a stream and configures the request with the correct content type and API key.

```csharp
using System.Net.Http;
using System.Net.Http.Headers;

using var client = new HttpClient();
using var fileStream = File.OpenRead("/path/to/file.pdf");

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.signatureapi.com/v1/uploads")
{
    Content = new StreamContent(fileStream)
};
request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
request.Headers.Add("X-API-Key", "key_test_...");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET Request to Retrieve File Details (Deprecated)

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

Use this GET request to retrieve details of an existing temporary file. Replace `{file_id}` with the actual file ID. Note that this endpoint is deprecated.

```http
// GET https://api.signatureapi.com/v1/files/{file_id}
// X-API-Key: key_test_...
```

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

### Upload PDF using Ruby (Net::HTTP)

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

This Ruby example uses the Net::HTTP library to upload a PDF file. It opens the file in binary read mode and sets the necessary headers for the POST request.

```ruby
require "net/http"
require "uri"

uri = URI("https://api.signatureapi.com/v1/uploads")

File.open("/path/to/file.pdf", "rb") do |file|
  request = Net::HTTP::Post.new(uri)
  request["Content-Type"] = "application/pdf"
  request["X-API-Key"] = "key_test_..."
  request.body = file.read

  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end

  puts response.body
end
```

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

### GET /websites/signatureapi/attributes

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

Retrieves the attributes of a sender.

```APIDOC
## GET /websites/signatureapi/attributes

### Description
Retrieves the attributes of a sender.

### Method
GET

### Endpoint
/websites/signatureapi/attributes

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier of the sender.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the sender.
- **email** (string) - The email address of the sender. SignatureAPI sends signing request emails to recipients on behalf of this address.
- **status** (enum) - The current verification status of the sender. Possible values: `pending_verification`, `verified`, `failed`.
- **created_at** (string) - The time at which the sender was created, formatted as an ISO 8601 timestamp.

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

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

### Get Recipient Details

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

Retrieves recipient details by their ID.

```APIDOC
## GET /websites/signatureapi/recipients/{recipientId}

### Description
Retrieves recipient details by their ID.

### Method
GET

### Endpoint
/websites/signatureapi/recipients/{recipientId}

### Parameters
#### Path Parameters
- **Recipient ID** (string) - Required - The ID of the envelope.

### Response
#### Success Response (200)
- **Recipient Key** (string) - A user-provided key that identifies a recipient within an envelope.
- **Recipient Name** (string) - The name of the recipient.
- **Recipient Email** (string) - The email address of the recipient.
- **Recipient ID** (string) - The ID of the recipient.
- **Envelope ID** (string) - The ID of the envelope.
- **Recipient Type** (string) - The type of the recipient.
- **Recipient Status** (string) - The status of the recipient. Available options are `pending`, `sent`, `completed`, `rejected`, `soft_bounced`, `hard_bounced`, `failed`, and `replaced`.
- **Recipient Completed At** (string) - Time when the recipient completed the envelope.
- **Recipient Ceremony Creation** (string) - How the ceremonies for a recipient are created.
- **Recipient Delivery Type** (string) - How the deliverable is sent to the recipient.

#### Response Example
{
  "Recipient Key": "example_key",
  "Recipient Name": "John Doe",
  "Recipient Email": "john.doe@example.com",
  "Recipient ID": "recipient_123",
  "Envelope ID": "envelope_abc",
  "Recipient Type": "signer",
  "Recipient Status": "completed",
  "Recipient Completed At": "2023-10-27T10:00:00Z",
  "Recipient Ceremony Creation": "auto",
  "Recipient Delivery Type": "email"
}
```

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

### Add Hint and Prompt to Dropdown

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

Guide recipients with 'hint' (tooltip on hover/focus) and 'prompt' (placeholder text) properties. These enhance usability by providing context for the selection.

```json
{
  //...
  "hint": "Select your country of residence",
  "prompt": "Choose a country..."
  //...
}
```

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

### Retrieve Deliverable Request

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

Example request for fetching a deliverable by its ID.

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

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

### Create file response example

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

A successful response to the file creation request returns a `201 Created` status code along with the file's `id`, a temporary `put_url` for content upload, and an `expires_at` timestamp.

```json
// HTTP Status Code 201

{
  "id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
  "put_url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/temp...",
  "expires_at": "2025-12-31T20:00:00.000Z"
}
```

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

### Get an envelope

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

Retrieves the details of a specific envelope using its ID.

```APIDOC
## GET /websites/signatureapi/envelopes/{envelopeId}

### Description
Retrieves the details of an envelope.

### Method
GET

### Endpoint
/websites/signatureapi/envelopes/{envelopeId}

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

### Response
#### Success Response (200)
- **Envelope Title** (string) - The title of the envelope. This may be shown to recipients.
- **Envelope Message** (string) - A message to include in emails to recipients.
- **Sender Name** (string) - The name of the sender of the envelope. This overrides the account default sender name.
- **Sender Email** (string) - The email address of the sender of the envelope. This overrides the account default sender email.
- **Envelope Status** (string) - The current status of the envelope. Available options: `draft`, `processing`, `in_progress`, `completed`, `failed`, `canceled`.
- **Deliverable ID** (string) - The ID of the deliverable. If the deliverable is not generated, this value will be null.
- **Envelope ID** (string) - The ID of the envelope.
- **Completed At** (string) - Time at which the envelope was completed by all recipients, in ISO 8601 format.
- **Envelope Mode** (string) - Whether the envelope is in `live` or `test` mode. Test mode envelopes are non-binding and not billed.
- **Envelope Attestation** (string) - Regulatory or compliance attestation.
- **Envelope Topic Item** (string) - Use to classify envelopes and filter webhook notifications.
- **Envelope Label** (string) - Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
- **Envelope Routing** (string) - The order in which recipients sign the envelope. It can be `parallel`, where all recipients can sign simultaneously, or `sequential`, where recipients sign one after another.
- **Time Zone** (string) - The time zone to be used for timestamps in deliverables.
- **Timestamp Format** (string) - The date and time format to be used in timestamps for deliverables.

#### Response Example
{
  "Envelope Title": "Example Title",
  "Envelope Message": "Please sign this document.",
  "Sender Name": "John Doe",
  "Sender Email": "john.doe@example.com",
  "Envelope Status": "in_progress",
  "Deliverable ID": "deliverable-123",
  "Envelope ID": "envelope-abc",
  "Completed At": "2023-10-27T10:00:00Z",
  "Envelope Mode": "live",
  "Envelope Attestation": "Attestation details",
  "Envelope Topic Item": "Topic Item",
  "Envelope Label": "Urgent",
  "Envelope Routing": "sequential",
  "Time Zone": "America/New_York",
  "Timestamp Format": "MM/DD/YYYY HH:MM:SS"
}
```

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

### GET /get-capture

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

Retrieves a value entered by a recipient in an input place during signing.

```APIDOC
## GET /get-capture

### Description
Retrieves a value entered by a recipient in an input place during signing.

### Method
GET

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

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

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

### Create Simple Deliverable (No Audit Log)

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

Use this to create a simple deliverable without an audit log. Requires an API key and content type header.

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

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

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

### Envelope Creation with Multiple Metadata Keys

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

Demonstrates adding multiple key-value pairs to the metadata object during envelope creation for detailed tracking.

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

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

### Handle Test/Live Mode Mismatch Error

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

Response received when using the wrong environment key for the requested resource.

```json
// HTTP Status Code 200

{
  "type": "https://signatureapi.com/docs/v1/errors/mode-error",
  "title": "Mode Error",
  "status": 403,
  "detail": "You are trying to access a test-mode resource with a live API key. Please use a test API key."
}
```

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

### Retrieve Deliverable Response

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

Example response object returned when a deliverable is successfully retrieved.

```json
// HTTP Status Code 200

{
  "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"
}
```

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

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

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

Retrieves the details and current verification status of a specific sender.

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

### Description
Retrieves the details of a sender object. 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)
- **id** (string) - The unique identifier of the sender.
- **email** (string) - The email address of the sender.
- **status** (string) - The current verification status.
- **created_at** (string) - The timestamp when the sender was created.

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