# Expere API Parameters

Red color, shiny Orange color Yellow color Blue color An operation used to request document processing based on transaction data included in the request. The input message for the Generate operation used to request processing of a specified package. The output message for the Generate operation used to return the details of the request. An operation used to request status information about a previously submitted request based on a request identifier (RequestID). The input message for the GetRequestResult object used to define the request. The output message for the GetRequestResult operation. This operation returns a GetRequestResultOut object. The results object for the GetRequestResult operation. An asynchronous call back operation that manipulates the Generate operation to render a desired output (PDF) and merge PDF outputs. The input message for the PostProcess operation used to request processing. The output message for the PostProcess operation used to return the details of the request. An operation used to request a list of forms and the status of each form included on in a particular package. The input message for the SelectRequest operation. The output message for the SelectRequest operation. An operation used to request document processing based on transaction data included in the request. The input message for the SelectAndGenerate operation. The output message for the SelectAndGenerate operation. Container object used to define output options. Object defining the output type for a document (based on an enumerated value). Scope object containing values for available output types. Array containing an unbound collection of AncillaryOutputOption objects. Array containing an unbound collection of DocCustomDataItem objects. Array containing an unbound collection of DocInstance objects. Array containing an unbound collection of Document objects. Array containing an unbound collection of Information objects. Array containing an unbound collection of PDF objects. Array containing an unbound collection of PackageDoc objects. Array containing an unbound collection of Packet objects. Array containing an unbound collection of PacketCustomDataItem objects. Object defining the barcode output settings based on type and pattern. An object defining the type of barcode to implement. Scope object containing values for barcode definitions. Scope object containing values defining a beginning or end of an enumeration. Container object for transaction data inputs and outputs in binary (base64), text, or XML format. It will include all documents in the current packet. An object containing name and value pairs for custom data. Container object used to provide a document description. Container object used to define a given instance of a document. Container object used to define a document set by ID, package, and packet associations. Container object used to define the processing instructions for a given document. Container object used to define a document. Object defining the format type for a document (based on an enumerated value). Scope object containing values for available format types. Container object used to define a set of documents. Object defining the format type for a document type (based on an enumerated value). Scope object containing values for available document types. Object defining the rendering option for a document (based on an enumerated value). Scope object containing values for available rendering options for dynamic documents. Object providing a true/false values a boolean type (boolean). Object providing an integer type (int). Container object used to pass base64 encoded PDF documents. Container object used to define a document. Container object used to define formatting metadata for an instance. Object defining the signing instructions for an instance (based on an enumerated value). Scope object containing values for signing instructions for an instance. Object defining options to include the document in the document count. An object containing a document (binary) and location information about the attached document. Object containing the display name and file name for an instance of a document. Object containing the package identifier, a descriptor and work order reference for a package. Object containing the name of the packet and an array containing document information objects. Object containing pairs of custom data associated with a packet. Object containing pairs of custom data associated with a packet. Object containing the user and owner to submit on a request. Object defining rights to associated with the user/owner submitted on the request. Object contains a group of enumerations indicating the status of the transaction submitted on the parent request. Object defining the encryption strength, account credentials, and permissions to associate with a request. Container object defining a watermark. Object defining the target location for a watermark (based on an enumerated value). Scope object containing values for location placement of a watermark. Object defining the pattern for GUID values. Object defining the pattern for the duration value. Transaction data in the form of a XML file, confirming to the ExpereTxn schema, used to process the request. Defines the type of content to be used. A string of characters used to identify a system resource. In this implementation, the value should reflect the fully qualified URL used as the recipient of a response (the callback URI) after the document has been generated. The callback is submitted without security parameters. A unique identifier for the account associated with the request. This is assigned as part of an account's administration setup process. The type of the product associated with the instance. An identifier for the entity associated with the generated documents submitted on the transaction data. An identifier defined by the requesting application and passed as a string value. It is typically used to supply an identifier or reference value for a given request and is mapped to the RequestID. A unique identifier for the submitted request. Often used for request tracking purposes. The status of the request as a string. Sets the output to include a barcode as defined in the Barcode object. Sets the output to include a seal as defined in the CertifcateSeal object. Sets the output to include a encryption as defined in the SetEncryption object. Sets the output to include a watermark as defined in the Watermark object. Sets the output as a single PDF comprising a merged grouping of individual documents in a packet. Sets the output as a copy of all individual PDF files and a PDF comprising a merged grouping of the individual documents in a packet. Sets the output as a compressed archive (Base64 encoded ZIP format). If used with PDFmerge, a single PDF is included in the archive; else individual PDF files are included. Object providing a description for an associated barcode pattern. Apply a barcode using Code 128. Code 128 is used for alphanumeric or numeric-only barcodes and uses all 128 ASCII characters. Apply a barcode using Code 39 (3 of 9, 3.9). Code 39 uses 43 characters including uppercase letters (A through Z), numeric digits (0 through 9) and a number of special characters (-, ., $, /, +, %, and space). Apply a 2D barcode. Apply an Inter25 (2 of 5) barcode. The binary file (base64 encoded) submitted with or returned from the request/response message. The file naming convention is based the InstanceDisplayName, with any spaces and special characters removed. The transaction data submitted with or returned from the request/response message. The transaction data submitted with or returned from the request/response message. Indicates that the processor should perform validation if schema information is available. The name of the data item. The value of the data item. A unique identifier associated with a document. This is generated by the Expere engine. See DocumentType The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). The root organization associated with the document. A boolean defining if the document requires a signature from the borrower(s) or other entity. See Array The class designation associated with the document. A description associated with the document. A boolean defining if the document is a negotiated instrument (document). A boolean defining if the document is a recorded document. A TRUE value indicates the document is recorded; a FALSE value indicates it is non-recordable. The form number identifier for the document. For example, a VMP form number. A reference to the unique identifier (DocID) associated with a document. ###Don't use, use ph for Data object. The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). The InstanceDisplayName, with any spaces and special characters removed, is used as the file name in the returned document. The document display name associated with the document instance. This is authored as part of REQ authoring (Document > Properties). The type of the packet associated with the instance. The packetCountname of the packet associated with the instance. The document reference associated with the instance. The sequencing of the instance (as an integer). The barcode value associated with the instance of the document. The number of pages in the instance. See DocFormat. The number of copies of the document associated with the instance. The reference to the schema identifier for the document set. The reference to the package identifier for the document set. A boolean defining if the document is marked for autoselection. A TRUE value indicates the document is autoselected; a FALSE value indicates it is not autoselected. A boolean defining if the document is a prepared document. A TRUE value indicates the document is prepared; a FALSE value indicates it is not prepared. The document style. A boolean defining if the document is a suggested document. A TRUE value indicates the document is suggested; a FALSE value indicates it is not suggested. A unique identifier associated with a document. A reference to the unique identifier (DocID) associated with a document. A unique identifier for the root organization associated with the document. A unique identifier associate with the document instance. The number of paginated documents (not including documents that are not paginated). The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). See Document Type The document name when used as a fragment. A boolean defining if the document is marked for autoselection. A TRUE value indicates the document is autoselected; a FALSE value indicates it is not autoselected. A boolean defining if the document is a prepared document. A TRUE value indicates the document is prepared; a FALSE value indicates it is not prepared. A boolean defining if the document is a suggested document. A TRUE value indicates the document is suggested; a FALSE value indicates it is not suggested. The format of the document. Indicates if there is any DDR data associated with the document. Generates the output as a PDF. Generates the output as XML. Generates the output as a SmartDoc. This option is seldom used. Generates the output as and RTF document that can be used in the Microsoft Word desktop publishing application. Generates the output as a Tagged PDF. This is used in creating accessible documents related to ADA requirements. The name of the returned document. The document is generated as a dynamic document. The document is a template. The document is not generated. Defines the rendering option for the document as RenderX XEP. Defines the rendering option for the document as Apache FOP. A reference to the unique identifier associated with a package. The file name of the generated packet. The name of the packet. The packet type designation. The path of the generated output. The output is pushed to this path. The intended recipient of the packet. The password for the user submitted on a request. The password for the owner submitted on a request. Enables printing on the output document. Enables editing text or properties on the output document. Enables copying (copy/paste) of text on the output document. Enables annotation features on the output document. Not used. Enables form field fill-in features on the output document. Enables assembly of an output document. Enables low resolution printing of the output document. The transaction is currently in processing. The transaction has completed processing and is being generated (rendered). The transaction has completed rendering and is currently being delivered. The transaction has been processed, rendered, and delivered to the delivery destination. The transaction encountered an error during processing. The system is currently processing the error condition. The transaction encountered a critical error during processing and was unable to resolve the error. The transaction has failed processing. The transaction has been successfully completed. The transaction could not be processed because the request was submitted using incomplete or incorrectly formatted data. The location (URL) of the image to processed as part of the watermark. The text (copy) to include as the watermark text. A boolean defining if the watermark should display as rotated (at a 45 degree angle) on the output page. A TRUE value indicates the watermark is rotated on the page; a FALSE value indicates it is not rotated. Sets the watermark at the top of the page, below the defined top margin, and centered vertically. Sets the watermark at the center position (horizontally) of the page and centered vertically. Sets the watermark at the bottom of the page, above the defined bottom margin, and centered vertically. The value supplied or returned on the ExpereBoolean. The value supplied or returned on the ExpereInteger. Defines the beginning of an enumerated list. Defines the end of an enumerated list. The defined severity level of the transaction. A description for an associated severity level. A boolean defining if the document is marked for encryption as 128-bit encrypted. A TRUE value indicates the document is marked for 128-bit encryption; a FALSE value indicates it is not marked for encryption. Indicates that cover pages will be produced for all documents that cannot handle barcodes in the tagline