PackageInformation

An object containing information about how the package should be processed in SmartSign Plus. This object is used when integrating with SmartSign Plus by way of EZ Config Package and Packets or a custom PKG file.

To return PackageInformation in the response, /Txn/EClosingType must be present in the transaction.

Note: The development for this object is currently in progress. Additional parameters will be added with future releases.

For more information, see the SmartSign Plus Feature Guide.

Parameter Type Description
EOriginalSSPlusGroups EOriginalSSPlusGroupsType A collection of SmartSign Plus groups.
EOriginalSSPlusGroups/EOriginalSSPlusGroup EOriginalSSPlusGroup Contains information about a Smart Sign Plus group
/EOriginalSSPlusGroups/EOriginalSSPlusGroup/GroupName string A string of data containing the Group name.
Note: Group name must be distinct.
EOriginalVaultName string This parameter is used to set up the Vault Name on the Package Post to SmartSign® Plus..
EOriginalSSPlusExpirationType EOriginalSSPlusExpirationTypeType This parameter specifies the type of timer that applies to the package using the following enumerated values:
  • NONE: No timers are applied.
  • SCHEDULED: On expiration, the status will update to “Expired”.
  • EXPIRE_TO_PRINT: The corresponding package status will be updated to "Expired Print Eligible" in SmartSign® Plus.
  • DIRECT_TO_PRINT: The corresponding package will be sent to "Direct To Print" in SmartSign® Plus.
EOriginalSSPlusAccessMethodType EOriginalSSPlusAccessMethodTypeType This parameter specifies the access type using enumerated values of "EMAIL", "API", or "SMS"
EOriginalUseClosingCenterInd boolean This parameter indicates whether or not to use Closing Center
EOriginalSSPlusPrintMailingCostCenterDesc string An optional metadata field used to determine to track packages to specific cost centers within a financial institution.
EOriginalSSPlusPrintMailingCopiesCount string This string value contains the number of copies, including original.
EOriginalSSPlusPrintMailingColorInd boolean This parameter indicates whether or not the documents / package will print in color.
EOriginalSSPlusPrintMailingCarrierName string Provider delivering the documents. Possible values consist of the following:
  • FedEx Standard Overnight
  • FedEx Priority Overnight
  • UPS Next Day Air
  • UPS Second Day Air
  • UPS Expedited, Express
    Note: A comma should be included between "Expedited" and "Express"
  • UPS Ground
  • UPS Three Day Select
  • UPS Next Day Air Saver
  • UPS Next Day Air Early AM
  • UPS Saver
  • USPS First Class
  • USPS Priority
  • USPS Priority Express
  • USPS First Class International
  • USPS Priority International
  • USPS Priority Express International
EOriginalSSPlusPrintMailingReturnAddress EOriginalSSPlusPrintMailingReturnAddress This string value contains the Return Address for SS Plus Mailing.
EOriginalSSPlusPrintMailingReturnAddressName The name of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

EOriginalSSPlusPrintMailingReturnAddressStreetAddress The string value of the (primary) Address line of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

EOriginalSSPlusPrintMailingReturnAddressStreetAddress2 The string value of the (secondary) Address line of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

EOriginalSSPlusPrintMailingReturnAddressCity The string value of the City of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

EOriginalSSPlusPrintMailingReturnAddressState The string value for the two character state abbreviation of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

EOriginalSSPlusPrintMailingReturnAddressPostalCode The string value of the Postal Code of the Financial Institution that should be used for Return Address on mailed package.

See EOriginalSSPlusPrintMailingReturnAddress for more information.

Sample PKG.Mortgage2Closing file with PackageInformation

Below you will find a sample PKG file containing the PackageInformation element and related child elements (in bold). 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <r:GenerateResponse xmlns:r="http://schemas.bankerssystems.com/2004/ExpereAPI/ExpereIEServices">
         <r:DocSet>
            <r:DocSetTxnIDRef/>
            <r:DocSetPackageIDRef>PKG.Mortgage2Closing</r:DocSetPackageIDRef>
            <r:PackageDocs>
               <r:PackageDoc PackageDocID="PKGD.ClosingInstructions-M2">
                  <r:DocDescriptor>
                     <r:DocID>PKGD.ClosingInstructions-M2</r:DocID>
                     <r:DocType>Dynamic</r:DocType>
                     <r:DocDisplayName>Closing Instructions</r:DocDisplayName>
                     <r:DocRootEntityName>INS.ClosingInstructions-M2</r:DocRootEntityName>
                     <r:ESignatureDocument>true</r:ESignatureDocument>
                  </r:DocDescriptor>
                  <r:DocWorkOrder>
                     <r:DocPrepare>true</r:DocPrepare>
                     <r:DocAutoselected>true</r:DocAutoselected>
                     <r:DocSuggested>false</r:DocSuggested>
                     <r:DocFormat>TaggedPDF</r:DocFormat>
                     <r:DocStyle>WKFS_StyleGuide</r:DocStyle>
                  </r:DocWorkOrder>
               </r:PackageDoc>
            </r:PackageDocs>
            <r:Packet PacketFileName="PacketName.pdf" PacketName="PacketName">
               <r:DocInstance DocIDRef="PKGD.ClosingInstructions-M2">
                  <r:DocData>
                     <r:base64>JVBER...JSVFT0YK</r:base64>
                  </r:DocData>
                  <r:InstanceDisplayName>Closing Instructions</r:InstanceDisplayName>
                  <r:InstanceFileName>PacketName-Closing_Instructions.pdf</r:InstanceFileName>
                  <r:InstanceFormattingMetadata>
                     <r:InstanceSigningInstructions>InkSign</r:InstanceSigningInstructions>
                  </r:InstanceFormattingMetadata>
                  <r:InstanceSequence>1</r:InstanceSequence>
                  <r:InstanceBarcodeValue>Barcode</r:InstanceBarcodeValue>
                  <r:InstancePageCount>3</r:InstancePageCount>
                  <r:InstanceRecordableFlag>false</r:InstanceRecordableFlag>
                  <r:InstancePageSize>Letter</r:InstancePageSize>
                  <r:DocFormat>TaggedPDF</r:DocFormat>
                  <r:AncillaryOutputOption>
                     <r:OutputType>Barcode</r:OutputType>
                     <r:Barcode>
                        <r:Type>barcode39</r:Type>
                        <r:Pattern>Barcode</r:Pattern>
                        <r:UseCoverPage>false</r:UseCoverPage>
                        <r:FirstPageOnly>false</r:FirstPageOnly>
                     </r:Barcode>
                  </r:AncillaryOutputOption>
               </r:DocInstance>
               <r:OutputDestination>SOAP</r:OutputDestination>
            </r:Packet>   
            <r:PackageInformation>
               <r:EOriginalSSPlusGroups>
                  <r:EOriginalSSPlusGroup>
                     <r:GroupName>Admin</r:GroupName>
                  </r:EOriginalSSPlusGroup>
                  <r:EOriginalSSPlusGroup>
                     <r:GroupName>AdminTwo</r:GroupName>
                  </r:EOriginalSSPlusGroup>
               </r:EOriginalSSPlusGroups>
               <r:EOriginalVaultName>TestVault</r:EOriginalVaultName>
               <r:EOriginalSSPlusExpirationType>NONE</r:EOriginalSSPlusExpirationType>
               <r:EOriginalSSPlusAccessMethodType>EMAIL</r:EOriginalSSPlusAccessMethodType>
               <r:EOriginalUseClosingCenterInd>true</r:EOriginalUseClosingCenterInd>
               <r:EOriginalSSPlusPrintMailingCostCenterDesc>CC123</r:EOriginalSSPlusPrintMailingCostCenterDesc>
               <r:EOriginalSSPlusPrintMailingCopiesCount>2</r:EOriginalSSPlusPrintMailingCopiesCount>
               <r:EOriginalSSPlusPrintMailingColorInd>true</r:EOriginalSSPlusPrintMailingColorInd>
               <r:EOriginalSSPlusPrintMailingCarrierName>UPS Ground</r:EOriginalSSPlusPrintMailingCarrierName>
               <r:EOriginalSSPlusPrintMailingReturnAddress>
                  <r:EOriginalSSPlusPrintMailingReturnAddressName>FI ABC</r:EOriginalSSPlusPrintMailingReturnAddressName>
                  <r:EOriginalSSPlusPrintMailingReturnAddressStreetAddress>123 Main Street</r:EOriginalSSPlusPrintMailingReturnAddressStreetAddress>
                  <r:EOriginalSSPlusPrintMailingReturnAddressStreetAddress2>Suite XYZ</r:EOriginalSSPlusPrintMailingReturnAddressStreetAddress2>
                  <r:EOriginalSSPlusPrintMailingReturnAddressCity>Freeport</r:EOriginalSSPlusPrintMailingReturnAddressCity>
                  <r:EOriginalSSPlusPrintMailingReturnAddressState>MN</r:EOriginalSSPlusPrintMailingReturnAddressState>
                  <r:EOriginalSSPlusPrintMailingReturnAddressPostalCode>56331</r:EOriginalSSPlusPrintMailingReturnAddressPostalCode>
               </r:EOriginalSSPlusPrintMailingReturnAddress>
            </r:PackageInformation>
         </r:DocSet>
         <r:DocSetSummary>
            <r:PacketCount>1</r:PacketCount>
            <r:DocInstanceCount>1</r:DocInstanceCount>
            <r:PageCount>3</r:PageCount>
            <r:InstanceRecordablePageCount>0</r:InstanceRecordablePageCount>
            <r:DateTimeStamp>2024-01-26T09:59:04.475212-06:00</r:DateTimeStamp>
         </r:DocSetSummary>
      </r:GenerateResponse>
   </soap:Body>
</soap:Envelope>