Get Document Response Contract Attributes
The following objects and attributes make up the EllieMae.LoanOpportunity.Contracts.GetDocumentResponse object, which contains the response to Get Document Request. All attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| document DocumentContract | The DocumentContract object. |
| fileId string | The ID returned by File Storage. |
| fileSignature string | The Token returned by File Storage. |
| fileUrl string | The Url returned by File Storage. |
Document Contract Attributes
The following objects and attributes make up the EllieMae.LoanOpportunity.Contracts.DocumentContract object, which represents the document contract. All attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| active boolean | Indicates whether the document active or not. The default is true, active. |
| content string | Required. The document content. |
| createdDate string($date-time) | The date the document was created. Read-only. |
| fileId string | Unique identifier assigned to the file. Read-only. |
| id string | The unique, system-generated identifier of the document. |
| loanReferenceId string | The ID to bind the entity in the loan. |
| name string | Name of the document. |
| scenarioId string | Required. Scenario ID this document is for. |
| scenarioIndicator string | Scenario indicator this document is for. |
| type string | Required. Document type (e.g., Eligibility). |
Document Tracking Log Contract Attributes
The following objects and attributes make up the EllieMae.LoanOpportunity.Contracts.DocumentTrackingLogContract object, which represents the document tracking log contract. All attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| deliveryBy string | User or entity who sent the document. |
| deliveryDate string($date-time | Date the document was sent. |
| deliveryMethod string | Method in which the document was sent. |
| documents documents[...] | Document details provided by the documents contract. |
| id string | The unique, system-generated identifier of this DocumentTrackingLog. |
| loanReferenceId string | The ID to bind the entity in the loan. |
| scenarioId string | Scenario ID specific to the document. |
File Object Response Contract Attributes
The following objects and attributes make up the EllieMae.LoanOpportunity.Contracts.FileObjectResponse object, which is the response for POST document request (Create a Document). All attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| fileId string | The ID returned by File Storage. |
| fileSignature string | The token returned by File Storage. |
| fileUrl string | The Url returned by File Storage. |
| id string | An object encapsulating the ID of the file that was just posted. |
© ICE Mortgage Technology, Inc. All rights reserved.