DocSpring · Schema
submission
PDFDocument GenerationPDF TemplatesE-SignaturesFormsHTML to PDFDocument Automation
Properties
| Name | Type | Description |
|---|---|---|
| batch_id | string | |
| data_requests | array | |
| editable | boolean | |
| error_message | string | |
| expired | boolean | |
| expires_at | string | |
| id | string | |
| json_schema_errors | array | |
| metadata | object | |
| password | string | |
| processed_at | string | |
| state | string | |
| template_id | string | |
| template_type | string | |
| template_version | string | |
| test | boolean | |
| truncated_text | object | |
| pdf_hash | string | |
| download_url | string | |
| permanent_download_url | string | |
| preview_download_url | string | |
| preview_generated_at | string | |
| audit_trail_download_url | string | |
| actions | array | |
| source | string | |
| referrer | string | |
| data | object |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/docspring/main/json-schema/submission.json",
"title": "submission",
"type": "object",
"properties": {
"batch_id": {
"type": "string",
"nullable": true
},
"data_requests": {
"type": "array",
"items": {
"$ref": "#/definitions/submission_data_request"
}
},
"editable": {
"type": "boolean",
"nullable": true
},
"error_message": {
"type": "string",
"nullable": true
},
"expired": {
"type": "boolean"
},
"expires_at": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"json_schema_errors": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"metadata": {
"type": "object"
},
"password": {
"type": "string",
"nullable": true
},
"processed_at": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"enum": [
"pending",
"processed",
"invalid_data",
"error",
"image_download_failed",
"image_processing_failed",
"waiting_for_data_requests",
"syntax_error",
"account_suspended",
"license_revoked",
"accidental"
]
},
"template_id": {
"type": "string",
"nullable": true
},
"template_type": {
"type": "string",
"enum": [
"pdf",
"html"
]
},
"template_version": {
"type": "string",
"nullable": true
},
"test": {
"type": "boolean"
},
"truncated_text": {
"type": "object",
"nullable": true
},
"pdf_hash": {
"type": "string",
"nullable": true
},
"download_url": {
"type": "string",
"nullable": true
},
"permanent_download_url": {
"type": "string",
"nullable": true
},
"preview_download_url": {
"type": "string",
"nullable": true
},
"preview_generated_at": {
"type": "string",
"nullable": true
},
"audit_trail_download_url": {
"type": "string",
"nullable": true
},
"actions": {
"type": "array",
"items": {
"$ref": "#/definitions/submission_action"
}
},
"source": {
"type": "string",
"enum": [
"api",
"web",
"reprocess",
"webhook"
]
},
"referrer": {
"type": "string",
"nullable": true
},
"data": {
"type": "object",
"nullable": true
}
},
"required": [
"actions",
"audit_trail_download_url",
"batch_id",
"data",
"data_requests",
"download_url",
"editable",
"error_message",
"expired",
"expires_at",
"id",
"json_schema_errors",
"metadata",
"password",
"pdf_hash",
"permanent_download_url",
"preview_download_url",
"preview_generated_at",
"processed_at",
"referrer",
"source",
"state",
"template_id",
"template_type",
"template_version",
"test",
"truncated_text"
],
"additionalProperties": false
}