{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/signatureapi-com/json-schema/signatureapi-com-deliverable-deliverable-input-schema.json",
  "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",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/signatureapi-com-deliverables-api-openapi.yml#/components/schemas/Deliverable.DeliverableInput",
  "x-schema-role": "model",
  "x-schema-direction": "input",
  "oneOf": [
    {
      "$ref": "#/$defs/Deliverable.StandardInput"
    },
    {
      "$ref": "#/$defs/Deliverable.SimpleInput"
    },
    {
      "type": "null"
    }
  ],
  "$defs": {
    "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.",
      "items": {
        "$ref": "#/$defs/Document.Key"
      },
      "minItems": 1,
      "maxItems": 10
    },
    "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": "#/$defs/Envelope.Language"
        }
      ]
    },
    "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
    },
    "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.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": "#/$defs/Deliverable.Name"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/Deliverable.Type"
            },
            {
              "const": "simple"
            }
          ]
        },
        "included_documents": {
          "$ref": "#/$defs/Deliverable.IncludedDocuments"
        },
        "password": {
          "$ref": "#/$defs/Deliverable.Password"
        }
      },
      "required": [
        "type"
      ]
    },
    "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": "#/$defs/Deliverable.Name"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/Deliverable.Type"
            },
            {
              "const": "standard"
            }
          ]
        },
        "timezone": {
          "$ref": "#/$defs/Deliverable.Timezone"
        },
        "timestamp_format": {
          "$ref": "#/$defs/Deliverable.TimestampFormat"
        },
        "language": {
          "$ref": "#/$defs/Deliverable.Language"
        },
        "included_documents": {
          "$ref": "#/$defs/Deliverable.IncludedDocuments"
        },
        "password": {
          "$ref": "#/$defs/Deliverable.Password"
        }
      },
      "required": [
        "type"
      ]
    },
    "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": "#/$defs/Envelope.TimestampFormat"
        }
      ]
    },
    "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": "#/$defs/Envelope.Timezone"
        }
      ]
    },
    "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"
    },
    "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
    },
    "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"
    },
    "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"
    },
    "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"
    }
  }
}