SignWell · Schema

AdditionalFiles

E-SignatureElectronic SignatureDocumentsPDFSigningTemplatesWorkflowsHIPAASOC2
View JSON Schema on GitHub

JSON Schema

AdditionalFiles.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/AdditionalFiles.json",
  "title": "AdditionalFiles",
  "type": "array",
  "items": {
    "type": "object",
    "description": "Additional files to be appended to the document. Will not replace existing files from the template. Document files can be uploaded by specifying a file URL or base64 string. Either `file_url` or `file_base64` must be present (not both). Valid file types are: .pdf, .docx, .jpg, .png, .ppt, .xls, .pages, and .txt.",
    "properties": {
      "name": {
        "type": "string",
        "description": "Name of the file that will be uploaded."
      },
      "file_url": {
        "type": "string",
        "format": "url",
        "description": "Publicly available URL of the file to be uploaded."
      },
      "file_base64": {
        "type": "string",
        "format": "byte",
        "description": "A RFC 4648 base64 string of the file to be uploaded."
      }
    },
    "required": [
      "name"
    ]
  }
}