Contracts

Print On Demand Request Contract

The following objects and attributes make up the Print On Demand request contract. When passing this request contract, all attributes are required unless otherwise specified.

ATTRIBUTEDESCRIPTION
entity
object
Specifies the loan Guid.
entity.entityType
string
The entity identifier. For example, the loan ID: {loanId}.
entity.entityId
string
The type of entity expressed in URN format. For example: urn:elli:encompass:loan


scope
object
Specifies the borrower pair.
scope.entityType
string
Entity type in URN format. For example, urn:elli:encompass:loan:borrower.
scope.entityId
string
Borrower pair ID or application ID.


printMode
string
Print options for field values in the forms. Possible values are:
LoanData
FieldIds
forms
array
Array of documents to generate.
forms.type
string
Indicates the type of form. Possible values are:
Standard
Custom
forms.source
string
Specifies the location of the form. Possible values are:
Standard Name of the form as it appears on the Encompass Print menu (not document settings).
Custom Full file path of the .doc or .docx file
forms.additionalParams
string
Optional. Additional parameters that are specific to some Standard forms. They are case-sensitive.

Print On-Demand Response Contract

The following objects and attributes make up the Print On-Demand response contract.

ATTRIBUTEDESCRIPTION
id
string
The print order ID.
NOTE: The print order ID can be reused to retrieve the order for up to 90 days. However, keep in mind the print order is a snapshot taken at the time the print order was generated. If any data has changed in the print order, run the POST call again to regenerate the forms with the latest data.
createdDate
string
Date/Time when the transaction was created, in UTC format.
status
string
Status of the transaction. It could be either “RUNNING”, “SUCCEEDED” or “FAILED”
instanceId
string
Encompass instance ID.
createdDate
string
Date/Time when the transaction was created, in UTC format.
documents
array
List of documents and download URLs (available when the status is "SUCCEEDED").
documents.type
string
Indicates the type of form. Possible values are: Standard and Custom.
documents.source
string
Specifies the location of the form. Possible values are:
Standard - Name of the form as it appears on the Encompass Print menu (not document settings).
Custom - Full file path of the .doc or .docx file
documents.additional
Params

string
Additional parameters that are specific to some Standard forms.
documents.url
string
The pre-signed URL from which to download the requested form.


failedDocuments
array
List of failed documents.
failedDocuments.type
string
Indicates the type of form. Possible values are:
Standard and Custom
failedDocuments.source
string
Specifies the location of the form. Possible values are:
Standard - Name of the form as it appears on the Encompass Print menu (not document settings).
Custom - Full file path of the .doc or .docx file.
failedDocuments.additional
Params

string
Additional parameters that are specific to some Standard forms.
failedDocuments.code
string
Error code.
failedDocuments.detail
string
Reason for failure.