{
  "openapi": "3.1.0",
  "info": {
    "title": "SignatureAPI: Deliverables",
    "summary": "SignatureAPI is an API-first electronic signature platform.",
    "version": "1.18.0",
    "description": "SignatureAPI is a REST API for sending documents for electronic signature. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP verbs and status codes.\n\n### Key concepts\n\nAn **envelope** is the central object. It holds documents and recipients, and manages the signing process from start to finish.\n\nA **document** is a PDF or DOCX file within an envelope. Documents contain **places** — interactive fields like signatures, initials, text inputs, checkboxes, and dropdowns positioned at specific locations.\n\nA **recipient** is a person who receives an envelope. There are three types:\n- **Signer** — signs documents\n- **Approver** — reviews and approves without signing\n- **Preparer** — fills in fields before the signer receives the documents\n\nA **ceremony** is the interactive session where a recipient authenticates and performs their actions. SignatureAPI supports three authentication methods: email link, email code, and custom.\n\nA **deliverable** is the final output — a signed PDF with an audit trail, generated after all recipients complete their actions.\n\nA **sender** is a verified email address that SignatureAPI sends signing requests on behalf of.\n\nAn **upload** is a file stored in SignatureAPI for use as a document source in envelopes.\n\n### HTTP Semantics\n\nWe use HTTP verbs GET, POST, DELETE as defined in RFC 9110, and PATCH as defined in RFC 5789.\n\nWe use the following HTTP Status codes for successful responses:\n\n- **200 OK**: Request succeeded for a GET, POST, or PATCH call.\n- **201 Created**: Request succeeded for a POST request that created a new resource. The response includes a Location header pointing to the newly created resource.\n\n### Versioning\n\nWe use [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html):\n\n- We increment Major (the X in X.Y.Z) versions when we make a change that breaks backward compatibility. The current major version is 1.\n- We increment Minor (the Y in X.Y.Z) versions when we add backward compatible features.\n- We increment Patch (the Z in X.Y.Z) versions when we make backward compatible bug fixes or improvements in the documentation.\n\nSignatureAPI considers the following changes to break backward compatibility:\n\n- Removing or renaming fields, arguments, or enum values.\n- Removing endpoints.\n- Changing the type of fields in the response (for example, from string to integer).\n- Adding a new **required** request parameter.\n\nThese are not breaking changes:\n\n- Any additive change, such as adding endpoints, optional arguments, fields, or enum values.\n- Making a required request parameter optional.\n- Making a validation less restrictive.\n- Changes to error responses. _We do not recommend parsing error responses to perform business logic._\n- Changes to the order of fields returned in a response.\n- Changes to the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.\n- Adding new event types.\n- Changes in the structure and descriptions in this OpenAPI spec.",
    "contact": {
      "name": "Signature API, Inc.",
      "email": "support@signatureapi.com"
    },
    "termsOfService": "https://signatureapi.com/terms"
  },
  "servers": [
    {
      "description": "SignatureAPI Global Server.",
      "url": "https://api.signatureapi.com/v1"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Deliverables",
      "description": "A **deliverable** is the final signed PDF generated after an envelope completes. It contains the signed documents and an audit trail.\n"
    }
  ],
  "paths": {
    "/envelopes/{envelopeId}/deliverables": {
      "parameters": [
        {
          "$ref": "#/components/parameters/EnvelopeId"
        }
      ],
      "get": {
        "operationId": "ListEnvelopeDeliverables",
        "summary": "List deliverables",
        "x-audience": "public",
        "tags": [
          "Deliverables"
        ],
        "description": "Returns a list of deliverables for an envelope. Each envelope has at least one deliverable created automatically when the envelope completes. Additional deliverables may exist if created via the Create Deliverable endpoint.\n\nThe deliverables are sorted chronologically by creation date, with the earliest created deliverable appearing first.",
        "parameters": [
          {
            "$ref": "#/components/parameters/PaginationLimit"
          }
        ],
        "responses": {
          "200": {
            "description": "The list of deliverables was retrieved successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "links": {
                      "$ref": "#/components/schemas/Shared.PaginationLinks"
                    },
                    "data": {
                      "type": "array",
                      "description": "An array of deliverables.",
                      "items": {
                        "$ref": "#/components/schemas/Deliverable.Deliverable"
                      }
                    }
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Shared.ClientError"
          },
          "5XX": {
            "$ref": "#/components/responses/Shared.ServerError"
          }
        }
      },
      "post": {
        "operationId": "CreateDeliverable",
        "summary": "Create a deliverable",
        "x-audience": "public",
        "tags": [
          "Deliverables"
        ],
        "description": "Creates a new deliverable from a completed envelope. The envelope must have a status of `completed`.\n\nUse this endpoint to generate additional deliverables after an envelope completes. For example, you might create a simple deliverable containing only specific documents, or a password-protected copy for secure distribution.\n\nThe deliverable starts in `processing` status and transitions to `generated` once the PDF is ready. This usually takes a few seconds. Subscribe to the `deliverable.generated` webhook to be notified when the deliverable is available for download.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Deliverable.DeliverableInput"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The deliverable was created successfully.",
            "headers": {
              "Location": {
                "$ref": "#/components/headers/Location"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deliverable.Deliverable"
                }
              }
            }
          },
          "422": {
            "$ref": "#/components/responses/Shared.ValidationError"
          },
          "4XX": {
            "$ref": "#/components/responses/Shared.ClientError"
          },
          "5XX": {
            "$ref": "#/components/responses/Shared.ServerError"
          }
        }
      }
    },
    "/deliverables/{deliverableId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/DeliverableId"
        }
      ],
      "get": {
        "operationId": "GetDeliverable",
        "summary": "Retrieve a deliverable",
        "x-audience": "public",
        "tags": [
          "Deliverables"
        ],
        "description": "Retrieves the details of a deliverable, including its current status and download URL.\n\nWhen the deliverable status is `generated`, the response includes a `url` field with a download link. By default, this is a pre-signed URL that expires after 1 hour. Call this endpoint again to get a fresh URL if the previous one has expired.\n",
        "responses": {
          "200": {
            "description": "The deliverable was retrieved successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deliverable.Deliverable"
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Shared.ClientError"
          },
          "5XX": {
            "$ref": "#/components/responses/Shared.ServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Authentication to the API is performed via an API key in the `X-API-Key` header.\n\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.\n"
      }
    },
    "schemas": {
      "Shared.PaginationLinks": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "title": "Pagination Links",
        "description": "Navigation links for cursor-based pagination. All list endpoints return results in reverse chronological order. Use the `next` and `previous` URLs to move between pages. Treat these URLs as opaque strings — do not parse or construct them yourself.\n",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "next": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "A pre-built URL for fetching the next page of results. Returns `null` when you are on the last page. Send a GET request to this URL to load more results.\n",
            "example": "https://api.signatureapi.com/v1/envelopes?cursor=seq_0thJdKRhN4&limit=20"
          },
          "previous": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri",
            "description": "A pre-built URL for fetching the previous page of results. Returns `null` when you are on the first page. Send a GET request to this URL to go back.\n",
            "example": "https://api.signatureapi.com/v1/envelopes?cursor=seq_7yNl3c0t&limit=20"
          }
        },
        "required": [
          "next",
          "previous"
        ]
      },
      "Envelope.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "format": "uuid",
        "title": "Envelope Id",
        "description": "The unique identifier of the envelope, in UUID format.",
        "examples": [
          "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13"
        ]
      },
      "Envelope.Timezone": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Time Zone",
        "description": "The time zone applied to timestamps in the deliverable's audit log. Must be a valid IANA Time Zone Database identifier (e.g., `America/New_York`, `Europe/London`).\n\nIf not specified, the account's default timezone is used.\n",
        "example": "America/New_York"
      },
      "Envelope.TimestampFormat": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Timestamp Format",
        "description": "The date and time format used for timestamps in the deliverable's audit log. Uses MomentJS format tokens (e.g., `MM/DD/YYYY HH:mm:ss`).\n\nIf not specified, the account's default timestamp format is used.\n",
        "example": "MM/DD/YYYY HH:mm:ss"
      },
      "Envelope.Language": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Language",
        "enum": [
          "en",
          "es",
          "fr",
          "it",
          "pt",
          "de",
          "zh",
          "hu",
          "nl"
        ],
        "description": "The language used for the signing ceremony, recipient emails, and the audit log in deliverables.\n\nSupported languages: `en` (English), `es` (Spanish), `fr` (French), `it` (Italian), `pt` (Portuguese), `de` (German), `zh` (Chinese Simplified), `hu` (Hungarian), `nl` (Dutch).\n\nIf not specified, the account's default language will be used instead.\n",
        "examples": [
          "en"
        ]
      },
      "Document.Key": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Document Key",
        "description": "A user-provided identifier for this document within the envelope. Must be unique within the envelope. Use the key to reference this document in other parts of the API.\n\nOnly lowercase letters, numbers, and underscores are allowed. Must start with a letter.\n\nIf not provided, a key is generated automatically.",
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$",
        "minLength": 1,
        "maxLength": 32,
        "examples": [
          "agreement",
          "byod_policy"
        ]
      },
      "Deliverable.Id": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Deliverable Id",
        "description": "The unique identifier of the deliverable.",
        "examples": [
          "del_LXRDwyTeJDVrWXmjwxsAGPq"
        ]
      },
      "Deliverable.Name": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "title": "Deliverable Name",
        "description": "A user-provided name for this deliverable. Use this to identify deliverables when an envelope has more than one.\n\nMust start with a lowercase letter and contain only lowercase letters, numbers, and underscores.",
        "type": [
          "string",
          "null"
        ],
        "pattern": "^[a-z][a-z0-9_]*$",
        "minLength": 1,
        "maxLength": 32,
        "examples": [
          "hr_pack",
          "compliance_acceptance"
        ]
      },
      "Deliverable.EnvelopeId": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "allOf": [
          {
            "title": "Envelope ID",
            "description": "The unique identifier of the envelope that this deliverable belongs to."
          },
          {
            "$ref": "#/components/schemas/Envelope.Id"
          }
        ]
      },
      "Deliverable.Type": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "type": "string",
        "title": "Deliverable Type",
        "enum": [
          "simple",
          "standard"
        ],
        "description": "The type of the deliverable.\n\n- `standard` -- Includes signed documents and an audit log with a certificate of completion.\n- `simple` -- Includes signed documents only, without an audit log.\n",
        "examples": [
          "standard"
        ]
      },
      "Deliverable.Status": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "title": "Deliverable Status",
        "description": "The current status of the deliverable.\n\n- **`pending`**: The deliverable is pending generation. This occurs while the envelope is not yet completed.\n- **`processing`**: The envelope is completed and the deliverable is being generated. This usually takes a few seconds.\n- **`generated`**: The deliverable has been generated. The deliverable object includes a URL where the deliverable can be downloaded. This is the final status of the deliverable.\n- **`failed`**: The deliverable has failed to be generated. This is a rare event and support is notified automatically.\n",
        "enum": [
          "pending",
          "processing",
          "generated",
          "failed"
        ],
        "examples": [
          "generated"
        ]
      },
      "Deliverable.Url": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": [
          "string",
          "null"
        ],
        "title": "Deliverable Url",
        "format": "uri",
        "description": "The URL to download the deliverable once it has been generated. If the deliverable has not yet been generated, this will be `null`.\n\n## Pre-signed URLs (Default)\n\nBy default, this is a short-lived, pre-signed URL that requires no further authentication to download.\n\nThe URL expires after 1 hour. If the link has expired, you can generate a new one by retrieving the deliverable again.\n\n## Authenticated URLs\n\nIf you requested authenticated URLs, for example to achieve HIPAA compliance, the URL must be accessed using the API key, in the same way as other requests to this API.\n\nAuthenticated URLs do not expire.\n",
        "examples": [
          "https://www.example.com/repository/audit-log.pdf"
        ]
      },
      "Deliverable.Timezone": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "allOf": [
          {
            "title": "Deliverable Timezone",
            "description": "The timezone used for timestamps in the audit log. This does not affect the signed document content or the `created_at` and `generated_at` API fields.\n\nIf not specified, the timezone of the envelope is used.\n"
          },
          {
            "$ref": "#/components/schemas/Envelope.Timezone"
          }
        ]
      },
      "Deliverable.TimestampFormat": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "allOf": [
          {
            "title": "Timestamp Format",
            "description": "The format used for timestamps in the audit log. This controls how dates and times appear in the system-generated pages of the deliverable.\n\nIf not specified, the timestamp format of the envelope is used.\n"
          },
          {
            "$ref": "#/components/schemas/Envelope.TimestampFormat"
          }
        ]
      },
      "Deliverable.Language": {
        "x-schema-role": "property",
        "x-schema-direction": "any",
        "allOf": [
          {
            "title": "Language",
            "description": "The language used for system-generated text in the audit log, such as labels and the certificate of completion. This does not affect the signed document content.\n\nIf not specified, the language of the envelope is used.\n"
          },
          {
            "$ref": "#/components/schemas/Envelope.Language"
          }
        ]
      },
      "Deliverable.IncludedDocuments": {
        "x-schema-role": "model",
        "x-schema-direction": "any",
        "title": "Included Documents",
        "type": "array",
        "description": "The keys of the documents to include in the deliverable.\n\nBy default, all documents in the envelope are included. Use this field to create a deliverable with only a subset of documents, for example to generate separate deliverables for different recipients.",
        "examples": [
          [
            "contract",
            "addendum"
          ]
        ],
        "items": {
          "$ref": "#/components/schemas/Document.Key"
        },
        "minItems": 1,
        "maxItems": 10
      },
      "Deliverable.MaskedPassword": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "title": "Deliverable Password",
        "description": "A password used to encrypt the deliverable PDF with AES-128 encryption. Recipients must enter this password to open the file.\n\nThe password must be between 4 and 32 characters long and contain only uppercase letters (A-Z), lowercase letters (a-z), and numbers (0-9). Special characters are not supported due to PDF reader compatibility.\n\nFor strong protection, use at least 12 characters with a random mix of uppercase, lowercase, and numbers.\n\nIn API responses, the password is masked as `********`.\n\nTo use this feature, contact support to enable it on your account.\n",
        "oneOf": [
          {
            "type": "string",
            "const": "********"
          },
          {
            "type": "null"
          }
        ]
      },
      "Deliverable.CreatedAt": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "string",
        "format": "date-time",
        "title": "Deliverable Created At",
        "description": "Time at which the deliverable was created. This is set when the envelope is created or when a deliverable is created via the API.",
        "examples": [
          "2024-01-01T00:00:00Z"
        ]
      },
      "Deliverable.GeneratedAt": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": [
          "string",
          "null"
        ],
        "format": "date-time",
        "title": "Deliverable Generated At",
        "description": "Time at which the deliverable was successfully generated. This is `null` until the deliverable reaches `generated` status.",
        "examples": [
          "2024-01-01T00:01:00Z"
        ]
      },
      "Deliverable.Standard": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "type": "object",
        "title": "Standard Deliverable",
        "description": "A **standard deliverable** is a PDF that contains the signed documents and an audit log. The audit log records each action taken during the signing process and includes a certificate of completion.\n\nThe `language`, `timezone`, and `timestamp_format` fields control how system-generated text and timestamps appear in the audit log. These settings do not affect the signed document content.\n\nIf not specified, these values default to the envelope's settings.\n\nYou can customize which documents are included using the `included_documents` field. Password protection is also available.\n",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Deliverable.Id"
          },
          "name": {
            "$ref": "#/components/schemas/Deliverable.Name"
          },
          "envelope_id": {
            "$ref": "#/components/schemas/Deliverable.EnvelopeId"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Deliverable.Type"
              },
              {
                "const": "standard"
              }
            ]
          },
          "status": {
            "$ref": "#/components/schemas/Deliverable.Status"
          },
          "url": {
            "$ref": "#/components/schemas/Deliverable.Url"
          },
          "timezone": {
            "$ref": "#/components/schemas/Deliverable.Timezone"
          },
          "timestamp_format": {
            "$ref": "#/components/schemas/Deliverable.TimestampFormat"
          },
          "language": {
            "$ref": "#/components/schemas/Deliverable.Language"
          },
          "included_documents": {
            "$ref": "#/components/schemas/Deliverable.IncludedDocuments"
          },
          "password": {
            "$ref": "#/components/schemas/Deliverable.MaskedPassword"
          },
          "created_at": {
            "$ref": "#/components/schemas/Deliverable.CreatedAt"
          },
          "generated_at": {
            "$ref": "#/components/schemas/Deliverable.GeneratedAt"
          }
        },
        "required": [
          "id",
          "name",
          "envelope_id",
          "type",
          "status",
          "url",
          "timezone",
          "timestamp_format",
          "language",
          "included_documents",
          "password",
          "created_at",
          "generated_at"
        ]
      },
      "Deliverable.Simple": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "type": "object",
        "title": "Simple Deliverable",
        "description": "A **simple deliverable** is a PDF that contains only the signed documents. No audit log pages are included in the output.\n\nThe audit trail is still embedded as metadata within the PDF for verification purposes. Use a simple deliverable when you want a clean document without the audit log visible in the PDF pages.\n\nYou can customize which documents are included using the `included_documents` field. Password protection is also available.\n",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/Deliverable.Id"
          },
          "name": {
            "$ref": "#/components/schemas/Deliverable.Name"
          },
          "envelope_id": {
            "$ref": "#/components/schemas/Deliverable.EnvelopeId"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Deliverable.Type"
              },
              {
                "const": "simple"
              }
            ]
          },
          "status": {
            "$ref": "#/components/schemas/Deliverable.Status"
          },
          "url": {
            "$ref": "#/components/schemas/Deliverable.Url"
          },
          "included_documents": {
            "$ref": "#/components/schemas/Deliverable.IncludedDocuments"
          },
          "password": {
            "$ref": "#/components/schemas/Deliverable.MaskedPassword"
          },
          "created_at": {
            "$ref": "#/components/schemas/Deliverable.CreatedAt"
          },
          "generated_at": {
            "$ref": "#/components/schemas/Deliverable.GeneratedAt"
          }
        },
        "required": [
          "id",
          "name",
          "envelope_id",
          "type",
          "status",
          "url",
          "included_documents",
          "password",
          "created_at",
          "generated_at"
        ]
      },
      "Deliverable.Deliverable": {
        "x-schema-role": "model",
        "x-schema-direction": "output",
        "title": "Deliverable",
        "description": "A **deliverable** is the final PDF output generated after an envelope is completed. It contains the signed documents and may include an audit trail, depending on the type.\n\nThe `type` field determines the deliverable variant:\n\n- `standard` -- Includes signed documents and an audit log with a certificate of completion.\n- `simple` -- Includes signed documents only, without an audit log.\n\n### Lifecycle\n\nA deliverable moves through these statuses:\n\n1. `pending` -- Waiting for the envelope to complete.\n2. `processing` -- The envelope is completed and the deliverable is being generated. This usually takes a few seconds.\n3. `generated` -- The deliverable is ready. The `url` field contains a download link.\n4. `failed` -- Generation failed. This is rare and triggers an automatic alert to support.\n\n### Default behavior\n\nWhen an envelope is created without an explicit deliverable configuration, a `standard` deliverable is generated automatically upon completion. You can also create additional deliverables after the envelope completes using the Create Deliverable endpoint.\n",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Deliverable.Standard"
          },
          {
            "$ref": "#/components/schemas/Deliverable.Simple"
          },
          {
            "type": "null"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "standard": "#/components/schemas/Deliverable.Standard",
            "simple": "#/components/schemas/Deliverable.Simple"
          }
        }
      },
      "Shared.Problem": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "type": "object",
        "description": "An error response following the RFC 9457 Problem Details format. The API returns this object with a `application/problem+json` content type when a request fails. Use the `type` URL to identify the error programmatically and the `detail` field to understand what went wrong.\n",
        "additionalProperties": false,
        "properties": {
          "type": {
            "type": "string",
            "description": "A URL that identifies the problem type. Points to documentation explaining the error.",
            "format": "uri",
            "example": "https://signatureapi.com/docs/v1/errors/invalid-api-key"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type.",
            "example": "Invalid API Key"
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code for this error. Matches the status code in the HTTP response.",
            "minimum": 100,
            "maximum": 599,
            "example": 401
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "example": "Please provide a valid API key in the X-API-Key header."
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail"
        ]
      },
      "Deliverable.Password": {
        "x-schema-role": "property",
        "x-schema-direction": "input",
        "type": "string",
        "title": "Deliverable Password",
        "minLength": 4,
        "maxLength": 32,
        "pattern": "^[A-Za-z0-9]+$",
        "description": "A password used to encrypt the deliverable PDF with AES-128 encryption. Recipients must enter this password to open the file.\n\nThe password must be between 4 and 32 characters long and contain only uppercase letters (A-Z), lowercase letters (a-z), and numbers (0-9). Special characters are not supported due to PDF reader compatibility.\n\nFor strong protection, use at least 12 characters with a random mix of uppercase, lowercase, and numbers.\n\nIn API responses, the password is masked as `********`.\n\nTo use this feature, contact support to enable it on your account.\n"
      },
      "Deliverable.StandardInput": {
        "x-schema-role": "model",
        "x-schema-direction": "input",
        "title": "Standard Deliverable",
        "description": "A **standard deliverable** is a PDF that contains the signed documents and an audit log. The audit log records each action taken during the signing process and includes a certificate of completion.\n\nThe `language`, `timezone`, and `timestamp_format` fields control how system-generated text and timestamps appear in the audit log. These settings do not affect the signed document content.\n\nIf not specified, these values default to the envelope's settings.\n\nYou can customize which documents are included using the `included_documents` field. Password protection is also available.\n",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "$ref": "#/components/schemas/Deliverable.Name"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Deliverable.Type"
              },
              {
                "const": "standard"
              }
            ]
          },
          "timezone": {
            "$ref": "#/components/schemas/Deliverable.Timezone"
          },
          "timestamp_format": {
            "$ref": "#/components/schemas/Deliverable.TimestampFormat"
          },
          "language": {
            "$ref": "#/components/schemas/Deliverable.Language"
          },
          "included_documents": {
            "$ref": "#/components/schemas/Deliverable.IncludedDocuments"
          },
          "password": {
            "$ref": "#/components/schemas/Deliverable.Password"
          }
        },
        "required": [
          "type"
        ]
      },
      "Deliverable.SimpleInput": {
        "x-schema-role": "model",
        "x-schema-direction": "input",
        "title": "Simple Deliverable",
        "description": "A **simple deliverable** is a PDF that contains only the signed documents. No audit log pages are included in the output.\n\nThe audit trail is still embedded as metadata within the PDF for verification purposes. Use a simple deliverable when you want a clean document without the audit log visible in the PDF pages.\n\nYou can customize which documents are included using the `included_documents` field. Password protection is also available.\n",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "$ref": "#/components/schemas/Deliverable.Name"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Deliverable.Type"
              },
              {
                "const": "simple"
              }
            ]
          },
          "included_documents": {
            "$ref": "#/components/schemas/Deliverable.IncludedDocuments"
          },
          "password": {
            "$ref": "#/components/schemas/Deliverable.Password"
          }
        },
        "required": [
          "type"
        ]
      },
      "Deliverable.DeliverableInput": {
        "x-schema-role": "model",
        "x-schema-direction": "input",
        "title": "Deliverable",
        "description": "A **deliverable** is the final PDF output generated after an envelope is completed. It contains the signed documents and may include an audit trail, depending on the type.\n\nThe `type` field determines the deliverable variant:\n\n- `standard` -- Includes signed documents and an audit log with a certificate of completion.\n- `simple` -- Includes signed documents only, without an audit log.\n\n### Lifecycle\n\nA deliverable moves through these statuses:\n\n1. `pending` -- Waiting for the envelope to complete.\n2. `processing` -- The envelope is completed and the deliverable is being generated. This usually takes a few seconds.\n3. `generated` -- The deliverable is ready. The `url` field contains a download link.\n4. `failed` -- Generation failed. This is rare and triggers an automatic alert to support.\n\n### Default behavior\n\nWhen an envelope is created without an explicit deliverable configuration, a `standard` deliverable is generated automatically upon completion. You can also create additional deliverables after the envelope completes using the Create Deliverable endpoint.\n",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Deliverable.StandardInput"
          },
          {
            "$ref": "#/components/schemas/Deliverable.SimpleInput"
          },
          {
            "type": "null"
          }
        ],
        "discriminator": {
          "propertyName": "type",
          "mapping": {
            "standard": "#/components/schemas/Deliverable.StandardInput",
            "simple": "#/components/schemas/Deliverable.SimpleInput"
          }
        }
      },
      "Shared.ValidationProblem": {
        "x-schema-role": "property",
        "x-schema-direction": "output",
        "description": "A validation error response following the RFC 9457 Problem Details format. The API returns this object with HTTP status 422 when a request body fails validation. The `errors` array lists each field-level problem so you can fix them all in one pass.\n",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URL pointing to the validation error documentation. Always `https://signatureapi.com/docs/v1/errors/validation-error`.",
            "format": "uri",
            "const": "https://signatureapi.com/docs/v1/errors/validation-error",
            "example": "https://signatureapi.com/docs/v1/errors/validation-error"
          },
          "title": {
            "type": "string",
            "description": "A short summary of the problem type. Always `Validation Error`.",
            "const": "Validation Error",
            "example": "Validation Error"
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code. Always `422` for validation errors.",
            "const": 422,
            "example": 422
          },
          "errors": {
            "type": "array",
            "description": "A list of human-readable messages describing each validation failure.",
            "items": {
              "type": "string"
            },
            "example": [
              "documents[0].url protocol must be HTTPS",
              "recipients[0].email must be a valid email address"
            ]
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "errors"
        ]
      }
    },
    "parameters": {
      "PaginationLimit": {
        "name": "limit",
        "in": "query",
        "description": "The maximum number of objects to return in the response.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 20,
          "default": 20
        }
      },
      "EnvelopeId": {
        "name": "envelopeId",
        "in": "path",
        "description": "The unique identifier of an envelope.",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/Envelope.Id"
        }
      },
      "DeliverableId": {
        "name": "deliverableId",
        "in": "path",
        "description": "The unique identifier of a deliverable.",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/Deliverable.Id"
        }
      }
    },
    "responses": {
      "Shared.ClientError": {
        "description": "The request cannot be processed due to an issue on the client's side. This may include invalid request format, insufficient permissions, or requesting non-existent resources. The client should review and correct the request.\n\nThis error covers HTTP status codes in the 400 to 499 range. The most common are:\n\n- 400 Bad Request (`bad-request`: the request body is not valid JSON)\n- 401 Unauthorized\n- 402 Payment Required (`live-mode-paused`: live API access is paused because an invoice is unpaid; test keys keep working)\n- 403 Forbidden\n- 409 Conflict\n- 410 Gone\n- 404 Not Found\n- 413 Request Too Large (`request-too-large`: a JSON request body exceeds 1500 KiB, a form-encoded body exceeds 100 KiB, or a form-encoded body has too many parameters)\n- 415 Unsupported Media Type (`unsupported-media-type`: the request body's charset or content encoding is not supported)\n- 422 Unprocessable Content.\n",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Shared.Problem"
            },
            "example": {
              "type": "https://signatureapi.com/docs/v1/errors/api-key-required",
              "title": "The API Key is required",
              "status": 401,
              "detail": "A valid API key is required in the X-API-Key header of all requests."
            }
          }
        }
      },
      "Shared.ServerError": {
        "description": "The request cannot be processed due to an issue on the server's side. The client can retry the request in a few minutes, or contact support if the error persists.\n",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Shared.Problem"
            },
            "example": {
              "type": "https://signatureapi.com/docs/v1/errors/server-error",
              "title": "Internal Server Error",
              "status": 500,
              "detail": "There was a problem in our server and your request was not fulfilled. Try again later. If the error persists, please contact support.\n"
            }
          }
        }
      },
      "Shared.ValidationError": {
        "description": "The request cannot be processed due to validation errors. This typically involves issues like missing required fields, invalid data formats, or value constraints not being met.\n",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Shared.ValidationProblem"
            },
            "example": {
              "type": "https://signatureapi.com/docs/v1/errors/validation-error",
              "title": "Validation Error",
              "status": 422,
              "errors": [
                "The title is required",
                "The sender.email is not a valid email address",
                "The value of recipients[0].key is too long"
              ]
            }
          }
        }
      }
    },
    "headers": {
      "Location": {
        "required": true,
        "description": "The URL of the created resource",
        "schema": {
          "type": "string",
          "format": "uri"
        }
      }
    }
  }
}
