SignWell · Schema

TemplateAttachmentRequests

Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2
View JSON Schema on GitHub

JSON Schema

TemplateAttachmentRequests.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/TemplateAttachmentRequests.json",
  "title": "TemplateAttachmentRequests",
  "type": "array",
  "description": "Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "Name of the requested attachment."
      },
      "placeholder_id": {
        "type": "string",
        "description": "Unique identifier of the recipient that will view the attachment request."
      },
      "required": {
        "type": "boolean",
        "default": true,
        "description": "Whether the recipient will need to upload the attachment to successfully complete/sign the document. Defaults to `true`."
      }
    },
    "required": [
      "name",
      "placeholder_id"
    ]
  }
}