File Field API

This document contains the File field API format, supported attributes, and attachment type rules.

File field
<field type=”attachment” name=”string” roleId=”id” placeholder=”string” optional=”boolean” attachmentType=”enum”></field>

File Field attributes

• type — define if this field is attachment type, mandatory attribute.

• name — string, length from 1 up to 128 symbols, restricted symbols &, “, <, >, field name used to fill in on envelope, unique for document, mandatory attribute.

• roleId — id of the role who should fill field on envelope, mandatory attribute.

• placeholder — field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute.

• optional — boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute.

• attachmentType — enum, one of the values [all, file, document, image, archive], defines file types could be uploaded on envelope, mandatory attribute.

Supported document types

• All: .pdf, .doc, .docx, .xls, .xlsx, .xlsm, .xlsb, .xml, .dbf, .txt, .rtf, .csv, .xps, .eml, .msg, .emlx, .rpmsg, .crt, .pem, .der, .cer, .ppt, .pptx, .png, .jpg, .jpeg, .tiff, .tif, .zip, .7z, .rar, .asice

• File: .pdf, .doc, .docx, .xls, .xlsx, .xlsm, .xlsb, .xml, .dbf, .txt, .rtf, .csv, .xps, .eml, .msg, .emlx, .rpmsg, .crt, .pem, .der, .cer, .ppt, .pptx

• Document: .pdf

• Image: .png, .jpg, .jpeg, .tiff, .tif

• Archive: .zip, .7z, .rar, .asice