How Do I Add External Documents to Forms?

When printing or e-signing a document, external PDF documents (attachments) can be included with the forms (e.g. drivers license photocopy, scanned documents, etc.). To perform this function for each attachment, use the attachments/upload endpoint to add the documents to your UNID.

NOTES:

The Quik! Forms Engine Execute method must be run before uploading documents in order to obtain a UNID value to associate the external document to.
Attachments must not exceed 20 MB

Security

Each document uploaded to the Quik! server is systematically encrypted during transmission and storage with a unique key per document using standard 128+bit encryption algorithms. Documents are never in the possession or available to any employee or other customer – the documents can only be un-encrypted during the process of including them into the final form package for print or signing purposes. Additionally, all documents are deleted from the server in 10 days or less, per the form package's expiration date set by the customer.

Swagger Page: Swagger UI

Attachment Endpoints:

Service	URL	TYPE	Service Description	Parameters

Service

URL

TYPE

Service Description

Parameters

Get Attachments

/attachments

GET

Get all attachments associated with a UNID

unid : The UNID value of the transaction that you wish to retrieve attachments from

Upload Attachments

/attachments/upload

POST

Upload an attachment file to a specified UNID

unid : The UNID value of the transaction that you wish to upload attachments to

Name (string): Assign a name to the attachment that will be displayed in the Attachments panel of the Form Viewer. Given name string must end with the file extension that matches the file type of the original attachment. For example, if uploading a PDF attachment, the Name parameter must end in “.pdf”.

Path (string): Leave this parameter empty

Content : The base 64 string for the byte content of the attachment

DocSortOrder (int): See details below

BeforeForm (bool): If TRUE, all attachments are placed at the beginning of the package and displayed before forms when package is printed or shown in DocuSign. In this case, if multiple attachments are used, they are ordered in ascending order based on DocSortOrder value.

If FALSE, all attachments are placed in the middle or at the end of the package when printed or shown in DocuSign. Each form in a package has a “position” which is the order they were generated in. An attachment is placed in the order with the DocSortOrder value after the form in that position.

EXAMPLE
Customer generates Forms 1 and 2 together in a package, and they have positions 1 and 2 respectively. If Attachment A is uploaded with BeforeForm = FALSE and DocSortOrder = 1, then the Attachment is placed after Form 1 and before Form 2. If customer wants it shown after Form 2 then the DocSortOrder value must be 2 or greater.

If a customer wants more than one Attachment in the same position in a package, then they must upload every attachment with the same DocSortOrder value and they will be placed in ascending order by upload order.

Delete Attachments

/attachments/{id}/remove

DELETE

{id} (int): The Attachment ID to be deleted. This Attachment ID must be entered in the URL when calling this API

unid : The UNID value of the transaction that you wish to delete an attachment from

Required Parameters

The parameters needed for each document include:

Parameter	Description	Required
UNID	The UNID representing the form package that the document is to be attached to when signing. This value is obtained from the Quik! Forms Engine after running the Execute command.	Yes
Name	The file name of the document (e.g. "DriversLicense.pdf")	Yes
Content	The base 64 string for the byte content of the attachment	Yes
DocSortOrder	The order in which to display the document relative to the forms and other documents. NOTE: Value must be a positive integer value between 0 and 999.	Yes
BeforeForm	A boolean flag indicating if the document is inserted before or after the form. If TRUE, insert the document before the form according to the SortOrder. Default is FALSE which appends the document to the Form according to the SortOrder	Yes

Example attachments/upload JSON Payload:

{
"Unid": "WRpsWX3PnO5VgWxUTUTKIN%2fKxE%2bA09amHDBBi%2fwe3vLWSZwHUY7HOgyFmrKm6BAy",
"Attachments": [
{
"Name": "testattach3.pdf",
"Path": "",
"Content": "<really long base64 string>",
"DocSortOrder": 1,
"BeforeForm": false
}
]
}