Expere Transaction XPaths for eOriginal
The following Expere Txn XPaths should be used when working with eOriginal transactions to ensure proper eNote creation and execution.
PackageInformation element. This element contains 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. For more information, see PackageInformation in the Hosted Expere / Expere Document Services Web Services Guide.
Package collection
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusGroups* | An object (EOriginalSSPlusGroupsType) containing
a collection of SmartSign Plus groups; this includes child Xpaths
EOriginalSSPlusGroup and
GroupName, |
| /Txn/EOriginalSSPlusGroups/EOriginalSSPlusGroup | Contains information about a Smart Sign Plus group |
| /Txn/EOriginalSSPlusGroups/EOriginalSSPlusGroup/GroupName | Group name must be distinct. |
| /Txn/EOriginalVaultName | EOriginalVaultName is an optional alpha/numeric, user-defined field. This is a pre-configured value setup within eOriginal SmartSign Plus. |
| /Txn/EOriginalTransactionTypeName | Specifies the transaction type template for an eOriginal transaction. Transaction types are reusable transaction templates. Data, settings, and document types are pre-configured and saved in a transaction type, alleviating the need to input data and add documents each time a transaction is created. This is an optional preconfigured value setup within eOriginal. |
| /Txn/EClosingType |
|
| /Txn/EClosingNoteInd | Indicates the lender wants to include the full eNote and not the
placeholder eNote.
|
| /Txn/EOriginalSSPlusFieldSupport | Renames the Expere fields in a SmartSign Plus format; used with
an ESignatureAndFieldSupport ancillary output type. Possible values
are:
Note: If moving from WKES to SmartSign
Plus, remove eSignatureWKES from the
request. |
| /Txn/EOriginalDestructionType | 0 = Do NOT execute Destruction 1 = Destruct managed doc profiles only 2 = Destruct ALL doc Profiles 3 = Destruct Transaction |
| /Txn/EOriginalSSPlusDeliveryType | Indicates how the user is requesting to have their documents
setup in SmartSign Plus for Delivery and Vaulting.
|
| /Txn/EOriginalSSPlusPackageNameDesc | Indicates a string of data that will be included in the SmartSign
Plus package name in conjunction with the package name from the
expere response. This data could include, but is not limited to:
Loan Identifier, Borrower Name, Line of Business, etc. Note: The
/Txn/EOriginalSSPlusPackageNameDesc value
appears before the Expere package name. |
| /Txn/EOriginalUseClosingCenterInd | Determines whether or not to use eOriginal Closing Center;
|
| /Txn/EOriginalSSPlusPackageMailingInd | Determines whether to use a Participant or Package-level
mailing.
|
| /Txn/EOriginalSSPlusPackageTRIDExpirationDate | Specifies the date the package is sent to print fulfillment; format should be YYYYMMDD. |
| /Txn/EOriginalUseSSPlusInd | Enables the use of SmartSign Plus;
|
| /Txn/EOriginalSSPlusPackageAvailableDateTime | The date and time (UTC) of when the package will be available to
the signers. A DateTime format would resemble the following:
20220720T9:58:44 |
| /Txn/EOriginalSSPlusParticipantSpecificSigningOrderInd |
|
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/SigningOrderValueNumber | The signing order value (integer) for the participant. |
Package mailing collection
/Txn/EOriginalSSPlusPackageMailingInd=1.| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusPrintMailingRecipientName | Recipient name to be used on package level outbound mailing. |
| /Txn/EOriginalSSPlusPrintMailingAddressCountry | Country of the recipient. Only necessary when doing international shipping. |
| Txn/EOriginalSSPlusPrintMailingStreetAddress | Mailing address of the recipient. |
| Txn/EOriginalSSPlusPrintMailingStreetAddress2 | Secondary mailing address of the recipient. |
| /Txn/EOriginalSSPlusPrintMailingCity | Mailing city of the recipient. |
| /Txn/EOriginalSSPlusPrintMailingState | Mailing state of the recipient. |
| /Txn/EOriginalSSPlusPrintMailingPostalCode | Mailing zipcode of the recipient. |
| /Txn/EOriginalSSPlusPrintMailingCostCenterDesc | An optional metadata field used to determine to track packages to specific cost centers within a financial institution. |
| /Txn/EOriginalSSPlusPrintMailingCarrierName | Provider delivering the documents. Possible values consist of the
following:
|
| /Txn/EOriginalSSPlusPrintMailingCopiesCount | This string value contains the number of copies, including original. |
| /Txn/EOriginalSSPlusPrintMailingColorInd | This parameter indicates whether or not the documents / package will print in color. |
| /Txn/EOriginalSSPlusPrintMailingBusinessReturnEnvelopeInd | Determines whether to include a Business Return Envelope (BRE).
|
| /Txn/EOriginalSSPlusPrintMailingBusinessReturnEnvelopeID | The unique ID of the Business Return Envelope (BRE). |
Expiration setup
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusExpirationType | This parameter specifies the type of timer that applies to the
package using the following enumerated values:
Note: The
/Txn/EOriginalSSPlusExpirationType XPath is
set from the Expere response or Expere EZ Config Packages and
Packets, unless overwritten by the transaction |
| /Txn/EOriginalSSPlusElectronicPackageExpirationTimeDesc | Timestamp for electronic expiration. This is dependent on the expiration type passed. |
| /Txn/EOriginalSSPlusElectronicPackageExpirationDaysCount | Package will expire in the configured number of calendar days when invites are sent out/the scheduled date. |
| /Txn/EOriginalSSPlusPackageTRIDExpirationDate | Specifies the date the package is sent to print fulfillment. |
| /Txn/EOriginalSSPlusUseManualDateInd | Determines whether to use an automated date for signature date
fields or to allow users to manually enter a date.
|
Participants collection
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusParticipants | A collection of Smart Sign Plus Participants |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant | Contains information about a Smart Sign Plus Participant |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/AccessMethodType* | Determines how users will access their package; following values
consist of the following:
Note:
|
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/SSN | A string of data including the participant social security number (SSN); string must consist of nine digits. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationCustomPINInd | If true, the custom PIN has been enabled for identity
verification.
|
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationCustomPINValue | Specifies the value of the custom PIN for identity verification. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationCustomPINHintInd | If "1", the custom PIN Hint has been enabled for identity verification. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationCustomPINHintDesc | A string of data including the custom PIN hint. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationCustomPINSMSDeliveryInd | If "1", the custom PIN SMS Delivery has been enabled. The phone number being used should be a mobile number. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/IdentityVerificationSMSOneTimePINInd | If true, the SMS One Time Pin has been enabled for identity verification. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/RembrandtIDRefs | The unique identifier(s) of the participant. Multiple RembrandtID’s can be passed, separated by a space. When multiple unique RembrandID values are present for the same person responsible for multiple roles, only one Participant ID is created in SmartSign Plus. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/RelatedPartyIDRefs | The unique identifier(s) of parties who the participant should sign/acknowledge documents on behalf of. Multiple RembrandtID’s can be passed separated by a space. When multiple unique RembrandID values are present for the same person responsible for multiple roles, only one Participant ID is created in SmartSign Plus. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/FirstName | A string of data including the participant's given name. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/LastName | A string of data including the participant's family name. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/MiddleName | A string of data including the participant's middle name. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/Suffix | A string of data including the participant's suffix. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/EmailAddress | A string of data including the participant's email. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/PhoneNumber | The phone number of the participant, this needs to be a mobile number if using SMS for ID Verification or Custom Pin delivery. This needs to be a mobile number if using SMS for ID Verification or Custom Pin delivery. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/CustomFields | A collection of SmartSign Plus participant custom fields. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/CustomFields/CustomField | Contains information about a Smart Sign Plus participant custom field. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/CustomFields/CustomField/Name | The name of the SmartSign Plus participant custom field. Custom fields are defined in SmartSign Plus > Administration> Settings > Doc and Package Management > Custom Fields. |
| /Txn/EOriginalSSPlusParticipants/EOriginalSSPlusParticipant/CustomFields/CustomField/Value | The value of the SmartSign Plus participant custom field. |
Participant mailing collection
/Txn/EOriginalSSPlusPackageMailingInd=0 (or
blank/missing).| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusPrintMailings | A collection of Smart Sign Plus Print Mailings |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing | Contains information about a Smart Sign Plus Print Mailings |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/RecipientName | Recipient name to be used on package level outbound mailing. |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/RembrandtIDRefs | The unique identifier(s) of the participant. Multiple RembrandtID’s can be passed separated by a space. |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingStreetAddress | Mailing address of the recipient |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingStreetAddress2 | Mailing address 2 of the recipient |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingCity | Mailing city of the recipient |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingState | Mailing state of the recipient |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingPostalCode | Mailing zipcode of the recipient |
| /Txn/EOriginalSSPlusPrintMailings/EOriginalSSPlusPrintMailing/MailingCountry | Country of the recipient. Only necessary when doing international shipping |
| /Txn/EOriginalSSPlusPrintMailingCostCenterDesc | An optional metadata field used to determine to track packages to specific cost centers within a financial institution. |
| /Txn/EOriginalSSPlusPrintMailingCarrierName | Provider delivering the documents. Possible values consist of the
following:
|
| /Txn/EOriginalSSPlusPrintMailingCopiesCount | This string value contains the number of copies, including original. |
| /Txn/EOriginalSSPlusPrintMailingBusinessReturnEnvelopeInd | Determines whether to include a Business Return Envelope (BRE).
|
| /Txn/EOriginalSSPlusPrintMailingBusinessReturnEnvelopeID | The unique ID of the Business Return Envelope (BRE). |
Return Address collection
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusPrintMailingReturnAddressName | The name of the Financial Institution that should be used for
Return Address on mailed package. See EOriginalSSPlusPrintMailingReturnAddress for more information. |
| /Txn/EOriginalSSPlusPrintMailingReturnAddressCountry | Country of the recipient. Only necessary when doing international shipping. |
| /Txn/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. |
| /Txn/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. |
| /Txn/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. |
| /Txn/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. |
| /Txn/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. |
Closing center assignments
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalClosingCenterAssignments | A collection of Closing Center Assignments |
| /Txn/EOriginalClosingCenterAssignments/EOriginalClosingCenterAssignment | Contains information about Closing Center Assignments. |
| /Txn/EOriginalClosingCenterAssignments/EOriginalClosingCenterAssignment/EmailAddress | A string of data including the email address for the user accessing Closing Center. |
Third Party eDelivery Service
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusThirdPartyEDeliveryInd | If true, the lender will send all documents in a package to the eDelivery participants (email address). |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries | A collection of participant information to be used for Third Party eDelivery Service. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery | Contains participant information to be used for Third Party eDelivery Service. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/EmailAddress | The email address for the single participant that will receive all documents in the package. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/FirstName | The participant's given name. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/LastName | The participant's surname. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/PhoneNumber | The phone number of the participant, this needs to be a mobile number if using SMS for ID Verification or Custom Pin delivery. This needs to be a mobile number if using SMS for ID Verification or Custom Pin delivery. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationCustomPINInd | If true, the custom PIN has been enabled for identity verification. This needs to be a mobile number if using SMS for ID Verification or Custom Pin delivery. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationCustomPINValue | Specifies the value of the custom PIN for identity verification. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationCustomPINHintInd | If true, the custom PIN Hint has been enabled for identity verification. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationCustomPINHintDesc | Describes the custom PIN hint. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationCustomPINSMSDeliveryInd | If true, the custom PIN SMS Delivery has been enabled. The phone number being used should be a mobile number. |
| /Txn/EOriginalSSPlusThirdPartyEDeliveries/EOriginalSSPlusThirdPartyEDelivery/IdentityVerificationSMSOneTimePINInd | If true, the SMS One Time Pin has been enabled for identity verification. |
Note:
`Note: SmartSign Plus eDelivery service
supports the electronic delivery of documents to
Settlement Agents/Closing Agents for printing/ wet
signing documents. A wet signature is a physical
signature made with wet ink on a document. The SmartSign
Plus eDelivery service does not support electronic
delivery of eNotes because eNotes are signed
electronically.
|
|
Document collection
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusTemplates | A collection of SmartSign Plus templates. |
| /Txn/EOriginalSSPlusTemplates/EOriginalSSPlusTemplate | Contains information about SmartSign Plus templates. |
| /Txn/EOriginalSSPlusTemplates/EOriginalSSPlusTemplate/TemplateID | A string of data containing the Template ID. |
|
Note: If a user would like to utilize Document
Templates (for example: Charm Booklet, Your Own Home Loan
Toolkit, etc) via SmartSign Plus, they must have the template
configured in SmartSign Plus> Administration >
Settings > Document Templates and include the
templateId in the transaction. The
templateId is the unique SmartSign Plus
identifier given to a template upon creation. |
|
Custom fields collection
| Txn XPath | XPath Option/Description |
|---|---|
| /Txn/EOriginalSSPlusCustomFields | A collection of SmartSign Plus custom fields. |
| /Txn/EOriginalSSPlusCustomFields/CustomField | A container for a single instance of a SmartSign Plus custom field. |
| /Txn/EOriginalSSPlusCustomFields/CustomField/Name | The name of the SmartSign Plus custom field. This is case
sensitive. Note: Custom fields must be
configured in SmartSign Plus > Administration >
Settings > Doc and Package Management >
Custom Fields. The field names must match exactly
with what is expected by SmartSign Plus custom field
configuration to avoid errors. |
| /Txn/EOriginalSSPlusCustomFields/CustomField/Value | The value of the SmartSign Plus custom field. |