Jump to main content

# Packet

The Packet object contains the name of the packet and packet information.

Parameter | Type | Description
--- | --- | ---
PacketFileName | string | The file name of the generated packet.
PacketName | string | The name of the packet.
PacketType | string | The packet type designation.
DocInstances | DocInstance | Container object used to define a given instance of a document.
OutputDestination | string | The path of the generated output. The output is pushed to this path.
DocFormat | DocumentFormatType | Object defining the format type for a document (based on an enumerated value): PDF specifies that output documents should be formatted as PDF.; RAW_XML specifies that output documents should be formatted as XML.; RTF specifies that output documents should be formatted as RTF (dynamic documents output as RTF, however static docs output as fillable PDFs).
AncillaryOutputOption | ArrayOfAncillaryOutputOption | Array containing an unbound collection of AncillaryOutputOption objects.
Recipient | string | The intended recipient of the packet.
DocData | Data | Container object for transaction data inputs and outputs in binary (base64), text, or xml format. It will include all documents in the current packet.
PacketCustomDataItems | PacketCustomDataItems | Object containing pairs of custom data associated with a packet.
SignaturePointSet | SignaturePointSet | An object containing the signer object (and signature points) for the signature on a document.
PageSize | string | The page size of the document. The value on the response is calculated as either Letter or Legal with a third value, Combo, returned on packets that contain documents of both legal and letter size. The values are returned in the string in initial caps format (Legal, Letter, Combo).