# ExpereAPI Service

Phrase added for testing. Can be deleted. The root element of the request for the Assemble Document Set command. This request depends on a previous call to the AutoSelect and/or Add Documents command(s).The root element of the response for the Assemble Document Set command. The result will containe either a DocumentSet or a DocSet element, depending on the value of the ResponseDocType element submitted with the request.The root element of the request for the Assemble Documents command. This command depends on a previous call to the Create Transaction command.The root element of the response for the Assemble Documents command. The result will contain either a DocumentSet or a DocSet element, depending on the value of the ResponseDocType element submitted with the request.The root element of the response for the AutoSelect command. The result will contain either a DocumentSet or a Package, depending on the value of the ResponseDocType element submitted with the request.The root element of the request to clear the cache.The root element of the response from clearing cache.The root element of the request to compile all objects.The root element of the response from compiling all objects.The root element of the request to compile objects.The root element of the response from compiling objects.The root element of the request for the Create Transaction command.The root element of the response for the Create Transaction command.The root element of the request for the CreateValidationWorksheetRequest command.The root element of the response for the CreateValidationWorksheet command.The root element of the request for the Delete OrganizationTransaction command.The root element of the response for the Delete Organization command.The root element of the request for the Delete Transaction command.The root element of the response for the Delete Transaction command.The root element of the request for the DeleteValidationTransactionRequest command.The root element of the response for the DeleteValidationTransaction command.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.The root element of the response for the GenerateAndSave command. The root element of the request for the Get Doc Data Requirements command.The root element of the response for the Get Doc Data Requirements command.The root element of the request for the Get Doc Set Data Requirements command.The root element of the response for the Get Doc Set Data Requirements command.The root element of the request for the Get Document Set command.The root element of the response for the Get Document Set command.The root element of the request for the Get Package Data Requirements command. This call depends on a previous call to the Create Transaction command.The root element of the response for the Get Package Data Requirements command.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.The root element of the request for the Get Resolved Documents Request.The root element of the response for the Get Resolved Documents command.The root element of the request for the Get Resolved Package command. The root element of the response for the Get Resolved Package command.The root element of the request for the GetServiceInfo command.The root element of the response for the GetServiceInfo command.The root element of the request for the GetTransaction command.The root element of the response for the GetTransaction command.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.The root element of the response for the Resolve Package Data command. The result will contain either a Package or a DocumentSet element, depending on the value of the ResponseDocType element submitted with 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. An operation used to request document processing based on transaction data included in the request. The input message for the SelectAndGenerate operation. Applies a seal to the PDF document (using Adobe PDF features) that will notify the recipient of the document if a seal has been applied and if the seal was broken prior to the recipient opening the file. A broken seal might indicate modifications were made to the document after the seal was applied. The output message for the SelectAndGenerate operation. A container for Line of Business information.A container for the selection package information. On a request, a Package drives autoselection and is an input to the document assembly process.The name of the document selection package as it exists in the database.Specifies the schema used to return document assembly results. Allows you to specify the level of requirements information returned. The enumerated values include: REQ_NONE (Default), no requirements information should be returned; REQ_NAME, only the names of data requirements should be returned; REQ_QUESTION, return all available information for data requirements, including description and question information.Allows you to specify the method to return a document as one of three types; DocSet, DocumentSet, and Package.Specifies the level of requirements information that will be returned with the response. This setting has no effect on the documents being assembled that are authored using ERL markup. A container for requirements. The set of requirements applies to all documents that were processed in the DocumentSet. This element will not exist in the response if there are no missing data items.Container object used to define output options. The object is used to define document post-processing instructions included in the request. 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. A array containing Databases object as containers for database information.Array containing an unbound collection of DocCustomDataItem objects. Array containing an unbound collection of DocInstance objects. Array containing an unbound collection of DocumentSet objects. Array containing an unbound collection of Information objects. Array containing a collection of Expere objects.An array containing Libraries objects with library version information.Array containing LinesOfBusiness objects.Array containing an unbound collection of PDF objects. Array containing an unbound collection of Package objects.Array containing an unbound collection of PackageDoc objects.Array containing an unbound collection of Policy objects.Array containing an unbound collection of Organization objects. Array containing an unbound collection of Packet bjects. Array containing an unbound collection of PacketCustomDataItem objects. Array containing an unbound collection of Transaction 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. Summary of the information in the DocSet.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): 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). Scope object containing values for available format types. A container for information about 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).Object providing an float type. 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. A container for Line of Business information.The name of the Line of Business as it exists in the database.Object defining options to include the document in the document count. A container for OPPSA product information. An OPPSA product is a set of policies produced by the Expere OPPSA Tool.A container for information about a set of phases.A container for phase objects containing information about a set of phases.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. A container for policy information. Policy is not required but can be used to enable dynamic setup data. This policy refers to ERL policies, not those generated by the Expere OPPSA Tool.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 assicate 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. Provides a listof qualified default values. Object defining the pattern for GUID values. Object defining the pattern for the duration value. The transport schema in which to return the DDRs; typically ExpereTXN or VMPMISMO.A container for transaction information as a transaction identifier (TransactionID).A container for information about a set of transaction.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 root organization associated with the request. This is assigned as part of an organization'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. Control whether all rules are executed or only the data items. Values include ExecuteAll (Default) and DataItemsOnly. The object defines the execution of all rules or only data items. Select ExecuteAll (Default) to execute all rules; select DataItemsOnly to execute only the rules related to data items (for example, ExternalData, DefineName and InternalData). Submit this value to execute all rules. Submit this value to execute only rules associated with data items. This option is only available for documents authored using Expere Rule markup; using this value for documents authored using ERL markup will result in an error response. 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 encryption options as defined in the SetEncryption object. This allows you to define the PDF file encryption information and document rights management options. 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 and removes all individual documents (only returns the single merged PDF). Sets the output as a single PDF comprising a merged grouping of individual documents in a packet and also returns all individual documents. Sets the output as a compressed archive (ZIP format). Sets the output as as coordinates for the Signature Point. A description for an associated barcode pattern as a string. The string can contain text to place in the barcode and any of the following substitution parameters: %page%-individual page number of the document, %totalpages%-the total number of pages for the document, %docsequence%-the doc sequence number, %docsequencetotal%-the total doc sequence number, %docname%-the instance display name of the document, %date%-the current system date in MM/DD/YYYY format. Apply a barcode using Code 128. Code 128 is a high-density barcode that 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 is a variable length, discrete barcode that uses 43 characters including uppercase letters (A through Z), numeric digits (0 through 9) and a number of special characters (-, ., $, /, +, %, and space). Apply a barcode using a matrix (2D) barcode. The 2D barcode used in Expere is PDF417, a public domain linear barcode symbol format. Apply a barcode using Interleaved 2 of 5 (I2/5). Interleaved 2 of 5 is a continuous two-width barcode. This code uses encoded digit pairs represented in a series of narrow and wide bars where 2 out of every 5 bars (or spaces) are wide. 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 instument (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 instance file name associated with the document instance. This is generated as a conversion of the dispay name (converting the display name to a file name) in a maner that replaces any special characters or spaces in the display name with an underscore (_). 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.An object containing document reference objects. 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. Indicates the format of output documents. 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. Container for storing information about the Organization.A unique identifier for the root organization associated with the document.The name of the root organization associated with the document.A short description of the root organization associated with the document.A unique identifier for the parent 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 external PDF that is passed in. 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. An object containing packet type objects.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. Container containing information about the comment to be added.A container for information about a comparison between two XML files. An object containing ProvidedDocument objects. An object allowing a complete document to be provided for assembly. 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.The value supplied or returned on the ExpereFloat. 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 marked for 40-bit encryption.Open The output message for the SelectRequest operation.Open A unique identifier for the object. Open Open Array containing a collection of ExpereMessage objects.Array containing a collection of SBAAgent objects.Open An object containing library version information.The name of the library.The library version number.The date and time of the library build.A short description of the phase. Open Array containing an unbound collection of Organization objects.An object containing the file name and date of the customer-originated transaction.An object containing the file name and date of the baseline transaction. The Xpath of the basline transaction Comments about the basline transaction. 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).The size of the page generated from the specified instance. The value on the response is calculated as either Letter or Legal. The values are returned in the string in initial caps format (Legal, Letter). A boolean defining if the document, generated by the specified instance, is a recorded document. A TRUE value indicates the document is recorded; a FALSE value indicates it is non-recordable. An object containing the signer object (and signature points) for the signature on a document. An object containing information about the specific signature point including the location, height, width, coordinates, and other data. An object containing the SignaturePoint object(s) defining the signature point set for a signature on a document. An object containing the signer identifier (SignerID), a description as a string, and SignaturePoints object. Open Open open A unique identifier for the transaction. A boolean indicating if the transaction should be saved in the database. A string description for the HTML data. The name of the file. The name of the baseline transaction. The name of the customer transaction. The compare results. The expected results of the compare. The actual results of the compare. Any other resutls of the compare. The XPath of the basline transaction. The compiled ERL of the target document.Indicates if the XPath is a global Xpath. An object containing a precedence identifier and message objects.open A unique identifier for the precedence level of a transaction.A unique identifier for the phase.open An object providing message data as a string.open An object containing information about a particular SBA agent.Open Open Open Open Open open Indicates whether or not to include the document in the count of the number of documents returned in a package.The current date and time the DocSet was created (with timezone).Container for storing the SBA Agent information (applicable to SBA only).Contains the jurisdictions that apply to the OPPSA organization.Fully resolved XML document.Specifies whether or not to persist transaction data to the database.Specifies where or not the entire ExpereName information from the data dictionary should be returned.Specifies where or not the ExpereName information from the data dictionary should be returned.Specifies how duplicate data item information should be returned.Specifies the verbosity of data requirements information.open open open open open open open open open open Open open Open A description for the term type that is not reflected in the TermTypeDesc string (additional descriptive text).A description for the term type.An object containing information about the term type. Requested to hold values for TermTypeDesc of Bank, Lender or Other. Requested for SBA content.Open Test drag and drop conref from common file to topic in Vasont (no oxygen)An object containing database information. In the interest of security, the default configuration is to NOT include database information.Indicate whether or not to add the date field in the signature data. The page number in the document where the signature is located.Indicates the order to sign within the document and is used when someone signs the same document in more than one place. The height (in points) of the signature area.The width (in points) of the signature area.The signature text as a string (spaces permitted).The X coordinate value for the signature position on the page. This is in points from the left of the page.The Y coordinate value for the signature position on the page. This is in points from the bottom of the page.Indicates if the target signature is a certain type of signature. While a string, you should always use one of these options: Signature, Initials or Date.The name of the field generated through Expere. Element used to provide a unique identification to the field name so Expere can merge PDF documents that use signature, date, initial, and fillable text fields.The name of the fillable checkbox The text for the tooltip that is displayed when the user hovers over the field on the PDF.Indicates if the fillable checkbox is selected (true) or deselected (false). If the element is not authored, the element value in the assembly output is set to false. Automatically calculated and included in the assembly output. Represents the physical page the fillable checkbox resides on the PDF.Automatically calculated and included in the assembly output. Represents the physical location the fillable checkbox or text field resides on the PDF.The name of the fillable field.The Width of the field in points where each point is 1/72 of an inch. May be authored in points or inches. If authored as inches, the value is converted and output as points.The Height of the field in points where each point is 1/72 of an inch. May be authored in points or inches. If authored as inches, the value is converted and output as points.The name of the font authored. The font value is True Type Font (TTF). Below is the Font value authored in Requirements Editor (RE) Tool and the corresponding output value in the API response files.The size of the font authored represented in points (i.e. 10 represents 10pt font).The Number of Characters allowed. If the element is not authored, the element value in the assembly output is set to 0 (zero). The prepopulated text for the field. If FieldText element is not authored, an empty element is included in the assembly output response as follows: <r:FieldText/>Indicates the horizontal alignment so of the text in the fillable field. Values are: left, right, center. If the horizontal alignment attribute is not authored, the element value in the assembly output is set to left.Indicates if the fillable field is underlined (true) or not underlined (false). If the underline element is not authored, the element value in the assembly output is set to false.The name of the organization in OPPSA.A type of identifier (ID) for the OPPSA product name (this is not typically the name viewed by the OPPSA user).An indicator for work-in-progress items.Object defining eSignature functionality that enables and disables eSignatures, returns X/Y Coordinates, and enables and disables Non-signature fillable fields.Sets the output to render eSignature and non-signature fields.An object determining if a cover page will appear for documents that cannot handle barcodes in the taglines.An object determining if a barcode appears on the first or only page of a document.Optional settings for configuring the Barcode 2D element.The transaction file name.The transaction date as a string.The file name of the customer transaction.The date of the customer transaction as a string.The database connection URL. In the interest of security, the default configuration is to NOT return this information.The database connection user name. In the interest of security, the default configuration is to NOT return this information.The name of the DBMS product.The version of the DBMS product.The name of the JDBC driver used to connect to the DBMS.The version of the JDBC driver used to connect to the DBMS.The name of the database implementation/DSL. This is reserved for future use.The version of the database implementation/DSL. This is reserved for future use.A string of data containing a unique discrete party ID.Object defining the Signer.Object defining the Fillable Checkbox and FillableText field.Total number of packets in the DocSet.Total number of DocInstances in the DocSet.Total number of Pages in the paginated documents in the DocSet. This does NOT include any count for documents that are not paginated. Total number of recordable pages in the paginated documents in the DocSet. This does NOT include any count for documents that are duplicated.The current date and time this DocSet was created (with timezone).An object containing an AncillaryOuputOption object.If set to "true," eSignature fields are suppressed on the form and X/Y coordinates are returned.Allows users to enable or disable the date field in an eSignature. Setting the element to "true" enables the date field; setting the element to "false" disables the date field.Allows users to pass a string as a help popup.Allows users to pass a string as a help popup.If set to "true," other Non-Signatures fillable fields (textboxes and checkboxes) are suppressed on the form and X/Y coordinates are returned.A message returned by the system.The name of the field generated through Expere. The text for the tooltip that is displayed when the user hovers over the field on the PDF.Indicates if the fillable checkbox is selected (true) or deselected (false). If the element is not authored, the element value in the assembly output is set to false.Automatically calculated and included in the assembly output. Represents the physical page the fillable checkbox resides on the PDF.Automatically calculated and included in the assembly output. Represents the physical location the fillable checkbox resides on the PDF. An object containing information about the specific FillableField including height, weight, field name, tooltip, font, font size, etc. An object containing information about the specific FillabeCheckbox including field name, tooltip, page number, and checked data.A short description of the phase associated with the line of business.(Default) No requirements information should be returned. Only the names of data requirements should be returned.Return all available information for data requirements, including description and question information.A string of data containing the Signer's user name.The email address of the Signer.A string of data containing the description of the Signer (e.g. borrower)The Content URI value.The username and password.A string of data containing the username. This parameter is optional; however, if providing a username, a password must be provided.A string of data containing the password. This parameter is optional.A string of data containing the name of the Document Generation Services certificate. This parameter is optional; if not supplied, no certificate will be sent with the callback request.A string of information containing the product name.Form default attribute restricted to int An object containing a document (binary) and location information about the attached document.The output document as a PDF.An object containing the name and ID for a particular form.An object containing information about the recipient: name, address, city, state, zip Information about the submitted transaction: state, API call, Delivery Status, Delivery Date.An object containing information about a particular package of forms and an array containing document information (ArrayOfDocumentInfo).An array, ArrayofDocumentInfo, containing DocumentInfo objects for each document in the requested packet. An object containing information about a particular form including the label, name, number of copies included, and an identifier (ID).The unique identifier for the form.The label associated with the form.The number of copies of the form generated.An object containing a name-value pairs or sets (NVSet).The name of the submitted NVset.The value of the submitted NVset.An object indicating the Callback URL, Username, and Password.An object containing return address information, including: name, address, city, state, zip An object containing information about configuration settings.This is new description Makes each field unique so Expere can merge PDF documents that use signature, date, initial, and fillable text fields The document display name associated with the document. Container object used to pass base64 encoded attachments.