DocSpring · Schema

combined_submission

PDFDocument GenerationPDF TemplatesE-SignaturesFormsHTML to PDFDocument Automation

Properties

Name Type Description
id string
state string
expired boolean
expires_in integer
expires_at string
processed_at string
error_message string
submission_ids array
source_pdfs array
metadata object
password string
pdf_hash string
download_url string
actions array
View JSON Schema on GitHub

JSON Schema

combined_submission.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/docspring/main/json-schema/combined_submission.json",
  "title": "combined_submission",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "processed",
        "error"
      ]
    },
    "expired": {
      "type": "boolean"
    },
    "expires_in": {
      "type": "integer",
      "nullable": true
    },
    "expires_at": {
      "type": "string",
      "nullable": true
    },
    "processed_at": {
      "type": "string",
      "nullable": true
    },
    "error_message": {
      "type": "string",
      "nullable": true
    },
    "submission_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source_pdfs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "combined_submission",
              "custom_file",
              "submission",
              "template",
              "url"
            ]
          },
          "template_version": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "type"
        ],
        "additionalProperties": false
      }
    },
    "metadata": {
      "type": "object"
    },
    "password": {
      "type": "string",
      "nullable": true
    },
    "pdf_hash": {
      "type": "string",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "nullable": true
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/combined_submission_action"
      }
    }
  },
  "required": [
    "actions",
    "download_url",
    "error_message",
    "expired",
    "expires_at",
    "expires_in",
    "id",
    "metadata",
    "password",
    "pdf_hash",
    "processed_at",
    "source_pdfs",
    "state",
    "submission_ids"
  ],
  "additionalProperties": false
}