Retrieve Raw XML Files

After a service order has been completed, you can receive raw XML files for the following supported service reports:

  • Credit Services
  • EarlyCheck
  • Fannie Mae DU
  • Freddie Mac LPA

📘

NOTE

This is supported for admin and super admin users only.

To Receive Raw XML Files

  1. Get the Report Identifier (applies only to Fannie Mae DU)
  • In Encompass, go to the eFolder, review the documents, and look for the Case File ID. You can also read the value from field ID MORNET.X4
  • If using APIs, execute the Get Loan API (and look for the duCaseIdorLpausKey field)
  1. Create the Body Request with the object below.
ATTRIBUTEDESCRIPTION
entityRef
object		References the entity ID and entity type. Both are returned by getLoan.
entityRef.entityId
string		The entity identifier. For example:
For Credit: {loanId}#{borrowerId}
For DU and LPA: {loanId}
entityRef.entityType
string		The type of entity expressed in URN format. For example:
For Credit: urn:elli:encompass:{loan}:{borrower}
For DU and LPA: urn:elli:encompass:{loan}
name
string		Name of the service to order. See the Partner Information section to get the correct name value for the partner; either the Transaction_Resource object or Transaction object name.
options.requestType
string		Required. Indicates the request type being submitted.
Value = RetrieveReportFiles
options.applicationID
string		Optional. This is the Borrower_ID.
options.reportIdentifier
string		Required. DU Case Number. Applies to Fannie Mae DU only.
options.loanAttachments
string		Required. Reports attached to the loan.

  1. Execute the Order Services API (see the Receive Report Files example) using the Body Request created in step 2.

  2. In the Response Header, find the Location Key and get the value.
    You only need the last segment of the Location Key. For example, if the Location value is: /services/v1/partners/307827/transactions/ep3_d79c01a8-1d0a-4fb9-ae54-31d8043bb5f0 you only the following Transaction ID:
    ep3_d79c01a8-1d0a-4fb9-ae54-31d8043bb5f0

  3. Set the query parameter generateFileUrls to true in the Get Status API/
    GET API_SERVER/services/v1/partners/{{Credit_Partner_ID}}/transactions/{{Location Key from step 4}}?generateFileUrls=true

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use