AUS Partners and Samples

Use the Services API to submit requests and retrieve automated underwriting service (AUS) reports from Fannie Mae Desktop Underwriter (DU) and Freddie Mac Loan Product Advisor (LPA) services.

This page contains the common product attributes used by DU and LPA, as well as attributes and samples that are specific to each service partner.

Product Attributes

The following table lists common attributes for Fannie Mae and Freddie Mac. The attributes listed in the following table are required by Fannie Mae and Freddie Mac unless otherwise specified.

ATTRIBUTEDESCRIPTION
entityRef
object		References the entity ID and entity type. Both must include the loan ID and borrower application ID associated with the loan. Both are returned by getLoan.
entityRef.entityId
string		The entity identifier. For example, the loan ID:loan
entityRef.entityType
string		The type of entity expressed in URN format. For example:
urn:elli:encompass:{loanId}
name
string		Name of the product to order. Possible values are provided in the Partner Information table below, under Product Name - Resource_Transaction and Product Name - Resource.

For example, AUS-DU or AUS.
credentials
object		Object that encapsulates credentials and/or verification information with the AUS provider.
credentials.userName
string		Username for the service provider account.
credentials.password
string		Password for the service provider account.
credentials.creditProviderUserName
string		Account username for credit provider with whom credit will be reissued as part of the underwriting service request.
credentials.creditProviderPassword
string		Account password for credit provider with whom credit will be reissued as part of the underwriting service request.
options
object		Important! The parameters defined by the options object will be different depending on the service provider you choose.

To view options attributes and samples specific to a service provider, see:

- Fannie Mae Desktop Underwriter

- Fannie Mae Desktop Originator (DO)

- Fannie Mae EarlyCheck

- Freddie Mac Loan Product Advisor
options.requestType
string		The type of underwriting request to place with the AUS provider. This can be a request or resubmission of an existing request. For the latter, you need to pass identifier(s) for the existing request on the AUS providers platform.

Possible values are:
- newOrder - place a new underwriting service request for the referenced loan.

- resubmit - resubmit an underwriting service request for the referenced loan.

Note: For a resubmit request, a reference to an existing underwriting service request must be passed via the: options.ausReportIdentifier and options.ausReportLoanIdentifier attributes.
options.ausReportLoanIdentifier is the LPA Loan ID. It is not required, but it should be passed if available.
options.ausReportIdentifier
string		Conditionally Required. The identifier for an existing request on the AUS provider's platform. This attribute is required when requesting a resubmission of an existing underwriting request.

If newOrder is passed as the value for the requestType attribute, this field will be ignored.
options.creditProviderCode
string		AUS provider's identifier for the credit service provider that processed the credit service request(s) for the subject loan. This attribute must be provided so that the AUS provider can access the borrower credit report and process the underwriting service request.

Select the provider code for your Credit service provider by referring to AUS Credit Provider Codes.
options.orderCreditDetails
object		Object array that encapsulates details of the various credit service requests that were placed during the life of the loan (up to the point where underwriting is being requested). Each single object in the array refers to a single credit service request.
options.orderCreditDetails.applicationID
string		Reference to the borrower pair within the loan in whose context this credit service request was placed.

If using V1 Get Loan, then the id in the Application/Borrower Object can be used for the borrower and the altid can be used in the Application/CoBorrower Object for the co-borrower.

If using V3 Get Loan, then use the legacyId for the Borrower/CoBorrower Objects.
options.orderCreditDetails.creditRequestActionType
string		Possible values are:
- Submit
- Reissue
options.orderCreditDetails.creditReportIdentifier
string		This is the identifier for the credit service request on the credit providers system. It is returned by the provider in the response of the credit service request.
preferencesObject that encapsulates user preferences for service specific functionality.
preferences.importConditions
boolean		Optional. Whether or not user to import the underwriting conditions specified by Fannie Mae in its underwriting report returned in their response.
preferences.conditionType
string		Optional. Specific type of underwriting conditions to import.

Possible values are:
- preliminary
- underwriting

If a type is not specified, the condition type defaults to preliminary.
resources.entityId
string		Optional. The entity identifier for the resource.

If the resource you are passing is an eFolder attachment, the attachmentId is required.

If the resource you are passing is an eFolder document, the documentId is required.

You can retrieve these from using the eFolder Attachment and eFolder Document APIs.
resources.entityType
string		Optional. The entity type/format of the resource. Possible values include:

- For an Encompass eFolder attachment:
urn:elli:encompass:attachment

- For and Encompass eFolder document:
urn:elli:encompass:document

Partner Information

Use the Product Name listed under the Transaction_Resource or Transaction columns to create transactions that follow the respective schema.

PartnerPartner IDProduct Name - Resource_TransactionProduct Name - Resource
Fannie Mae10000034AUS-DUAUS
Fannie Mae10000034AUS-EC-PUAUS-EC
Freddie Mac10000035AUS-LPAAUS
Freddie Mac10000035AUS-LQA-PUAUS-LQA

Credit Provider Codes

Fannie Mae Credit Provider Codes

Credit Information Provider

Fannie Mae (DU) Provider Code

Parent Credit Provider

Accurate Financial Services

292

SharperLending

ACRAnet, Inc.

031

SharperLending

Advantage Credit, Inc. of Colorado

226

MeridianLink, Inc.

Advantage Credit Bureau

179

MeridianLink, Inc.

Advantage Plus Credit Reporting, Inc.

138

MeridianLink, Inc.

Alliance 2020

275

MeridianLink, Inc.

American Reporting Company, LLC

139

MeridianLink, Inc.

Avantus

051

NCRA/CSD

Birchwood Credit Services, Inc.

076

MeridianLink, Inc.

CBA

053

CredStar

CBC Innovis, Inc.

003

CBC Innovis, Inc.

Certified Credit Reporting, Inc.

283

MeridianLink, Inc.

CIC Mortgage Credit, Inc.

128

MeridianLink, Inc.

Cisco Credit

086

MeridianLink, Inc.

CIS Info Services

022

MeridianLink, Inc.

Clear Choice Credit

146

MeridianLink, Inc.

CoreLogic Credco

001

CoreLogic Credco

Credit Data Solutions

229

MeridianLink, Inc.

Credit Information Systems

298

SharperLending

Credit Link, LLC

024

MeridianLink, Inc.

Credit Plus, Inc. - MCL

017

MeridianLink, Inc.

Credit Quick Services

116

CredStar

Credit Technologies, Inc.

287

MeridianLink, Inc.

Credit Technology, Inc.

161

MeridianLink, Inc.

CredStar

049

CredStar

Data Facts, Inc

301

SharperLending

Equifax Mortgage Solutions

004

Equifax Mortgage Solutions

Factual Data / MACS

303

CBC Innovis, Inc.

Funding Suite

130

NCRA/CSD

Information Searching Company

058

MeridianLink, Inc.

Informative Research

002

Informative Research

Kroll Factual Data

052

Kroll Factual Data

MCB

078

MeridianLink, Inc.

MeridianLink, Inc.

281

MeridianLink, Inc.

MFI Credit Solutions

277

SharperLending

Midwest Mortgage Credit Services, Inc.

029

MeridianLink, Inc.

NCO Credit

006

SharperLending

Online Information Services

204

SharperLending

Partners Credit and Verification Solutions

251

CredStar

Premium Credit Bureau

299

MeridianLink, Inc.

Premium Credit Bureau Data

295

MeridianLink, Inc.

SARMA

043

SharperLending

SARMA

302

MeridianLink, Inc.

Sarma / Network Credit Services

037

SharperLending

Settlement One

290

SharperLending

SharperLending

282

SharperLending

SharperLending, LLC

005

SharperLending

Strategic Information Resources, Inc.

075

SharperLending

The Credit Network / KFD

020

Kroll Factual Data

Trans Union Puerto Rico

270

NCRA/CSD

United One

063

MeridianLink, Inc.

Universal Credit Services, Inc.

092

MeridianLink, Inc.

 

Source: https://www.fanniemae.com/content/datagrid/credit_provider/cpsortbyname.html


Freddie Mac Credit Provider Codes

Credit Information Parent Provider

Freddie Mac Credit Provider Code (LPA)

CBCInnovis

1

CoreLogic CREDCO/Credstar

8

Equifax Mortgage Solutions

5

Factual Data

6

MeridianLink, Inc.

2

SharperLending

3

 

Credit Information Affiliate Provider

Freddie Mac Affiliate Provider Code (LPA)

Parent Credit Provider

ACRAnet

031

Equifax Mortgage Solutions

Advantage Credit Bureau

301

Equifax Mortgage Solutions

Advantage Credit Inc.

226

Equifax Mortgage Solutions

Advantage Plus Credit Reporting, Inc. 

138

Equifax Mortgage Solutions

Alliance 2020, Inc.

275

Equifax Mortgage Solutions

American Reporting Company LLC

016

Equifax Mortgage Solutions

Avantus LLC

091

Equifax Mortgage Solutions

Birchwood Credit Services, Inc.

076

Equifax Mortgage Solutions

Certified Credit Reporting via MeridianLink

071

Equifax Mortgage Solutions

Certified Credit Reporting via Sharper Lending

305

Equifax Mortgage Solutions

CIC Credit

128

Equifax Mortgage Solutions

Cisco

086

Equifax Mortgage Solutions

CIS, Inc.

022

Equifax Mortgage Solutions

Clear Choice Credit Corp.

146

Equifax Mortgage Solutions

Credit Information Systems

298

Equifax Mortgage Solutions

Credit Link LLC

024

Equifax Mortgage Solutions

Credit Plus, Inc. 

017

Equifax Mortgage Solutions

Credit Technologies, Inc.

181

Equifax Mortgage Solutions

CTI - Credit Technology, Inc.

161

Equifax Mortgage Solutions

Data Facts Inc.

306

Equifax Mortgage Solutions

EGS Global Solutions, Inc.

313

Equifax Mortgage Solutions

Equifax Mortgage Solutions

004

Equifax Mortgage Solutions

Funding Suite

130

Equifax Mortgage Solutions

Informative Research

308

Equifax Mortgage Solutions

Information Searching Company, LLC

058

Equifax Mortgage Solutions

KCB Information Services

309

Equifax Mortgage Solutions

Merchants Credit Bureau/MCB

078

Equifax Mortgage Solutions

MFI Credit Solutions

277

Equifax Mortgage Solutions

Midwest Mortgage Credit Services, Inc.

029

Equifax Mortgage Solutions

Online Information Services, Inc.

314

Equifax Mortgage Solutions

Partners Credit & Verification Solutions

251

Equifax Mortgage Solutions

Premium Credit Bureau

294

Equifax Mortgage Solutions

SARMA - via MeridianLink

302

Equifax Mortgage Solutions

SARMA - via Sharper Lending

043

Equifax Mortgage Solutions

Service 1st Information Systems, A Credit Data Solutions Company

229

Equifax Mortgage Solutions

Settlement One via MeridianLink

290

Equifax Mortgage Solutions

Settlement One via Sharper Lending

315

Equifax Mortgage Solutions

Strategic Information Resources, Inc 

075

Equifax Mortgage Solutions

Trans Union de Puerto Rico

270

Equifax Mortgage Solutions

United One, Inc.

063

Equifax Mortgage Solutions

Universal Credit Services

127

Equifax Mortgage Solutions

 

Source:
http://www.freddiemac.com/loanadvisorsuite/loanproductadvisor/crc.html

Fannie Mae Desktop Underwriter

Product Attributes

The following section lists the request attributes used by Fannie Mae's underwriting service and includes requests demonstrating their use.

AttributeDescription
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.
credentials.institutionID
string		Optional. The ID that Fannie Mae assigns to identify and authenticate your institution on their underwriting platform. To retrieve your DU institution ID, please contact Fannie Mae.
options.productDescription
string		Optional. The underwriting product request. Currently, the only supported value is: Standard LCOR

If Standard LCOR is passed as the value, the loan will be considered a standard limited cash out refinance.

Otherwise, the loan is analyzed for DU ReFi Plus qualification - this qualification allows for high loan-to-value ratios (outside of standard underwriting guidelines) when the loan can be verified as owned by Fannie Mae.

Additional information can be found here:

https://www.fanniemae.com/singlefamily/high-ltv-refinance-option

Sample API Flow

Step 1: Place a DU underwriting service request 

{  
  "product":{  
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    },
    "name":"AUS",
    "credentials":{  
      "userName":"xxxxxxxx",
      "password":"xxxxxxx",
      "institutionID":"xxxxxxx",
      "creditProviderUserName":"",
      "creditProviderPassword":""
    },
    "options":{  
      "requestType":"newOrder",
      "productDescription":"Standard LCOR",
      "ausReportIdentifier":"",
      "creditProviderCode":"3",
      "orderCreditDetails":[  
        {  
          "applicationID":"_borrower1",
          "creditReportIdentifier":""
        }
      ]
    },
    "preferences":{  
      "importConditions":true,
      "conditionType":""
    }
  }
}

{  
  "product":{  
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    },
    "name":"AUS-DU",
    "credentials":{  
      "userName":"xxxxxxxx",
      "password":"xxxxxxx",
      "institutionID":"xxxxxxx",
      "creditProviderUserName":"",
      "creditProviderPassword":""
    },
    "options":{  
      "requestType":"newOrder",
      "productDescription":"Standard LCOR",
      "ausReportIdentifier":"",
      "creditProviderCode":"3",
      "orderCreditDetails":[  
        {  
          "applicationID":"_borrower1",
          "creditReportIdentifier":""
        }
      ]
    },
    "preferences":{  
      "importConditions":"",
      "conditionType":""
    }
  }
}

Step 2: Retrieve a DU underwriting service response

{  
  "status":"success",
  "documents":{  
    "id":"",
    "name":"",
    "attachments":[  
      {  
        "mimeType":"emmedia/pdf",
        "name":"1988637915.FINDINGS",
        "content":{  
          "createdDateTime":"2018-01-18T11:02:38.937995-08:00",
          "attachmentFile":"Attachment-a5417c54-36e0-4ad9-a081-7f2088d50b52.HTM"
        }
      },
      {  
        "mimeType":"emmedia/xml",
        "name":"1988637915.FINDINGS",
        "content":{  
          "createdDateTime":"2018-01-18T11:02:38.937995-08:00",
          "attachmentFile":"Attachment-a5417c54-36e0-4ad9-a081-7f2088d59bd2.XML"
        }
      },
      {  
        "mimeType":"emmedia/pdf",
        "name":"CREDITREPORT_FLATFILE_",
        "content":{  
          "createdDateTime":"2018-01-18T11:02:33.0941858-08:00",
          "attachmentFile":"1988637915__borrower1.CREDITFLATFILE"
        }
      },
      {  
        "mimeType":"emmedia/html",
        "name":"1988637915__borrower1.CREDITPRINTFILE",
        "content":{  
          "createdDateTime":"2018-01-18T11:02:38.937995-08:00",
          "attachmentFile":"Attachment-620687b3-4ce9-42df-887a-219c94c00c31.TXT"
        }
      }
    ]
  },
  "product":{  
    "partnerID":"10000034",
    "productName":"AUS",
    "displayName":"Fannie Mae DU",
    "category":"AUS",
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    }
  }
}

{
  "status": "success",
  "resources": [
    {
      "id": "FANNIE_MAE-FINDINGS.XML",
      "name": "UNDERWRITING_FINDINGS_XML",
      "mimeType": "emmedia/pdf"
    },
    {
      "id": "Attachment-5aa17ffd-c2e0-48e7-8d0e-4c29ec478b5e.HTM",
      "name": "1990533354.FINDINGS",
      "mimeType": "emmedia/pdf"
    },
    {
      "id": "1990533354__borrower1.CREDITFLATFILE",
      "name": "CREDITREPORT_FLATFILE_",
      "mimeType": "emmedia/pdf"
    },
    {
      "id": "Attachment-dfa5488a-e990-41c4-9b1d-20baf23c6ad2.TXT",
      "name": "1990533354__borrower1.CREDITPRINTFILE",
      "mimeType": "emmedia/html"
    }
  ],
  "product": {
    "partnerID": "10000034",
    "productName": "AUS-DU",
    "displayName": "Fannie Mae DU",
    "category": "AUS",
    "entityRef": {
      "entityId": "d45b8195-a27e-442b-b0d9-6e9b46af31fa",
      "entityType": "urn:elli:encompass:loan"
    }
  }
}

{
  "status": "success",
  "resources": [
    {
      "id": "FANNIE_MAE-FINDINGS.XML",
      "name": "UNDERWRITING_FINDINGS_XML",
      "mimeType": "emmedia/pdf",
      "url": "https://encompass-int-api.elliemae.com/v2/media/instance/BE11156274/loans/d45b8195-a27e-442b-b0d9-6e9b46af31fa/files/FANNIE_MAE-FINDINGS.XML?tokencreator=encompass&tokenexpires=1524596879&token=%2fvqjjszQYvJgvEf4gALaAbMRFoKJpLz55RyHIFtwadiiU9IkW6le86ZsjZjj2T8lJFMa%2fWzcpocSzhCspS463w%3d%3d"
    },
    {
      "id": "Attachment-5aa17ffd-c2e0-48e7-8d0e-4c29ec478b5e.HTM",
      "name": "1990533354.FINDINGS",
      "mimeType": "emmedia/pdf",
      "url": "https://encompass-int-api.elliemae.com/v2/media/instance/BE11156274/loans/d45b8195-a27e-442b-b0d9-6e9b46af31fa/files/Attachment-5aa17ffd-c2e0-48e7-8d0e-4c29ec478b5e.HTM?tokencreator=encompass&tokenexpires=1524596879&token=kCSZqvkfNQdbLCeHNYEUZncY1OEzAZz3k5eXK06Z4YA2FSpgFjD7InX0Ap0lq7e8o2K3Hm3D81akWcrXm6lmug%3d%3d"
    },
    {
      "id": "1990533354__borrower1.CREDITFLATFILE",
      "name": "CREDITREPORT_FLATFILE_",
      "mimeType": "emmedia/pdf",
      "url": "https://encompass-int-api.elliemae.com/v2/media/instance/BE11156274/loans/d45b8195-a27e-442b-b0d9-6e9b46af31fa/files/1990533354__borrower1.CREDITFLATFILE?tokencreator=encompass&tokenexpires=1524596879&token=vayYEL6VlapspHCclT6RFxNzZJ4SDQId7mr6J2OuiT8RLEmbdjyWbWfT4MlcbcgQSf70Jv%2bxeFBQp6BJOD5sOg%3d%3d"
    },
    {
      "id": "Attachment-dfa5488a-e990-41c4-9b1d-20baf23c6ad2.TXT",
      "name": "1990533354__borrower1.CREDITPRINTFILE",
      "mimeType": "emmedia/html",
      "url": "https://encompass-int-api.elliemae.com/v2/media/instance/BE11156274/loans/d45b8195-a27e-442b-b0d9-6e9b46af31fa/files/Attachment-dfa5488a-e990-41c4-9b1d-20baf23c6ad2.TXT?tokencreator=encompass&tokenexpires=1524596879&token=1VVuutsaWRj3e%2bUsVjTUhpQ20vTxM%2b2gpK6TCraFRw%2fKPcUszliA7jCumfgWQ4oCceRX%2f26919XWyxKIH%2fKQqw%3d%3d"
    }
  ],
  "product": {
    "partnerID": "10000034",
    "productName": "AUS-DU",
    "displayName": "Fannie Mae DU",
    "category": "AUS",
    "entityRef": {
      "entityId": "d45b8195-a27e-442b-b0d9-6e9b46af31fa",
      "entityType": "urn:elli:encompass:loan"
    }
  }
}

Fannie Mae Desktop Originator (DO)

Product Attributes

The following section lists the request attributes used by Fannie Mae's Desktop Originator.

AttributeDescription
options.submissionType
string		Possible values are:

- Preliminary Findings
- Interim
- Final

If the submissionType is Interim or Final, the lenderSponsorId is required. It will be sent to the lender and ownership changes with final order.
options.orderCreditDetails.
creditRequestActionType
string		The supported values include:
- Submit
- Reissue

Sample API Flow

Step 1: Create a transaction to retrieve existing DO report data file attached to Encompass loan. 

{
  "product": {
    "name": "AUS-DO-PU",
    "entityRef": {
      "entityId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType": "urn:elli:encompass:loan"
    },
    "credentials": {
      "doUserId": "xxxxxxxx",
      "doPassword": "xxxxxxx",
      "institutionID": "xxxxxxx",
      "creditProviderUserName": "",
      "creditProviderPassword": ""
    },
    "options": {
      "requestType": "newOrder",
      "ausReportIdentifier": "",
      "creditProviderCode": "3",
      "submissionType": "xxxxxxxxx",
      "lenderSponsorName": "xxxxxxxxx",
      "lenderSponsorId": "xxxxxxxxx",
      "institutionName": "xxxxxxxxx",
      "orderMergeCredit": "Y",
      "orderCreditDetails": [
        {
          "applicationID": "xxxxxxxx",
          "creditRequestActionType": "Reissue",
          "creditReportIdentifier": "xxxxxxx"
        },
        {
          "applicationID": "xxxxxxxx",
          "creditRequestActionType": "Reissue",
          "creditReportIdentifier": "xxxxxxx"
        }
      ]
    },
    "preferences": {
      "importConditions": false,
      "conditionType": "xxxxxx"
    }
  }
}

Step 2: Retrieve a DO underwriting service response.

To get the documents for a transaction:

GET /services/v1/partners/10000034/transactions/{transactionId}?generateFileUrls=True

ParameterDescription
generateFileUrls
string		Optional. Value should be True. This parameter should be passed only if you need download URL’s for attachments.
{
  "status": "success",
  "resources": [
    {
      "id": "FANNIE_MAE-FINDINGS.XML",
      "name": "UNDERWRITING_FINDINGS_XML",
      "mimeType": "application/xml",
      "elli-signature": "",
      "url": "https://media-pod0-int.elliemae.com/v2/media/instance/DEBE11170913/loans/67ba8596-2943-479a-a0fa-6a80a89608cc/files/FANNIE_MAE-FINDINGS.XML?tokencreator=Encompass&tokenexpires=1581317260&token=1sybW%2fK9XEZePv0Iget%2bdQsg8BdWeZdXn71kOnAtp%2bVo8V%2b%2bF0wTO321z6R9zZICF8ZGwI10aW%2b7dMO08XCYvA%3d%3d"
    },
    {
      "id": "1232132133123213213.FINDINGS.HTML",
      "name": "UNDERWRITING_FINDINGS_HTML",
      "mimeType": "text/html",
      "elli-signature": "",
      "url": "https://media-pod0-int.elliemae.com/v2/media/instance/DEBE11170913/loans/67ba8596-2943-479a-a0fa-6a80a89608cc/files/1232132133123213213.FINDINGS.HTML?tokencreator=Encompass&tokenexpires=1581317260&token=Ny2fpZc%2b5xQS5TUJbGeMZaAwkd9P6U7yUYDrMLpsxNr1RpAiYB02s%2fA%2byp40RR%2fXjmRCoRVqLUyHt8pSs6OImg%3d%3d"
    },
    {
      "id": "1232132133123213213__borrower1.CREDITFLATFILE",
      "name": "CREDITREPORT_FLATFILE_",
      "mimeType": "application/octet-stream",
      "elli-signature": "",
      "url": "https://media-pod0-int.elliemae.com/v2/media/instance/DEBE11170913/loans/67ba8596-2943-479a-a0fa-6a80a89608cc/files/1232132133123213213__borrower1.CREDITFLATFILE?tokencreator=Encompass&tokenexpires=1581317260&token=ayIP9WRYfeUKXrz8wNpuC25V94Ru8EKtpJGBZnHDe639DaM2CpmbTBS465fqXAnTKfnGzZqIWLzroRgFbFpKmg%3d%3d"
    }
  ],
  "product": {
    "partnerID": "10000034",
    "productName": "AUS-DO-PU",
    "displayName": "Fannie Mae DO",
    "category": "AUS",
    "entityRef": {
      "entityId": "67ba8596-2943-479a-a0fa-6a80a89608cc",
      "entityType": "urn:elli:encompass:loan"
    },
    "creationDate": "2020-02-09T22:31:22Z",
    "lastUpdatedDate": "2020-02-09T22:31:40Z",
    "orderedBy": "urn:elli:encompass:DEBE11170913:user:admin"
  }
}

Fannie Mae EarlyCheck

Sample API Flow for 1003 and ULDD Submissions

📘

NOTE

URLA 2020 loans support ULDD and ULAD. URLA 2009 loans support 1003 and ULDD

Step 1: Submit a new 1003 or ULDD order to EarlyCheck and get reports from Fannie Mae

{
  "product": {
    "entityRef": {
      "entityId": "{{LoanUId}}",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "AUS-EC-PU",
    "credentials": {
      "userName": "{{username}}",
      "password": "{{password}}",
      "institutionID": "{{institutionID}}"
    },
    "options": {
      "requestType": "NewOrder",
      "fileFormat": "1003",
      "importConditions":true,
      "conditionType": "preliminary"
    }
  }
}

{
  "product": {
    "entityRef": {
      "entityId": "{{LoanUId}}",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "AUS-EC-PU",
    "credentials": {
      "userName": "{{username}}",
      "password": "{{password}}",
      "institutionID": "{{institutionID}}"
    },
    "options": {
      "requestType": "NewOrder",
      "ausReportIdentifier": "",
      "ausReportLoanIdentifier": "",
      "fileFormat": "ULDD",
      "importConditions": "true",
      "conditionType": "preliminary"
    }
  }
}

📘

NOTE

importConditions is set to “true” only if you want to import all conditions/messages. “conditionType” is applicable when "importConditions": "true". Possible values are “Preliminary” | “Underwriting”.

Step 2: Retrieve existing EarlyCheck report attached to the Encompass loan

{
  "status": "success",
  "resources": [
    {
      "id": "FNMA-EarlyCheck.htm",
      "name": "EARLYCHECKRESULTS_HTML",
      "mimeType": "text/html",
      "elli-signature": "",
      "url": "https://media-pod0-int.elliemae.com/v2/media/instance/DEBE11170913/loans/67ba8596-2943-479a-a0fa-6a80a89608cc/files/FNMA-EarlyCheck.htm?tokencreator=Encompass&tokenexpires=1581313904&token=zhtgEa9U2DuIRpNo8dARcAWgUfuDENMGZKbQcat0mn5Z3jlfAe0CzwKnSGMuLqeWbunLz58Elih4hc4L5%2bLEXQ%3d%3d"
    },
    {
      "id": "FNMA-EarlyCheck.xml",
      "name": "EARLYCHECKRESULTS_XML",
      "mimeType": "application/xml",
      "elli-signature": "",
      "url": "https://media-pod0-int.elliemae.com/v2/media/instance/DEBE11170913/loans/67ba8596-2943-479a-a0fa-6a80a89608cc/files/FNMA-EarlyCheck.xml?tokencreator=Encompass&tokenexpires=1581313904&token=rHayqbiunOPrmUyJujeNYBnMfyvj%2bggo8Yy9zitnZw3dnXFyCVgTYZkn2jVQ2usceL0WTsPFAAzuq7kgdG54Zg%3d%3d"
    }
  ],
  "product": {
    "partnerID": "10000034",
    "productName": "AUS-EC-PU",
    "displayName": "Fannie Mae EarlyCheck",
    "category": "AUS",
    "entityRef": {
      "entityId": "67ba8596-2943-479a-a0fa-6a80a89608cc",
      "entityType": "urn:elli:encompass:loan"
    },
    "creationDate": "2020-02-09T21:35:51Z",
    "lastUpdatedDate": "2020-02-09T21:36:16Z",
    "orderedBy": "urn:elli:encompass:DEBE11170913:user:admin"
  }
}

{
  "id": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
  "name": "CreateResponseAPI",
  "description": "",
  "auth": null,
  "events": null,
  "variables": [],
  "order": [
    "0602ffb5-a9af-49cd-9876-f4400dfcce17",
    "61a62493-9ed6-4b65-ae71-56e35402a342",
    "bca32e50-9642-4b2c-b896-7ff4afe2c5d8",
    "588007a6-45bf-422d-977e-655a255fff8e",
    "8324c472-029e-4d41-9b9d-cc3207e0b234",
    "0dcc49f4-9335-4dbf-8788-64ee85126dbd",
    "23ca6df7-6c25-432d-ba00-78e04917e809"
  ],
  "folders_order": [],
  "folders": [],
  "requests": [
    {
      "id": "0602ffb5-a9af-49cd-9876-f4400dfcce17",
      "name": "CreateLenderTransaction-EarlyCheck_1003_NEWORDER",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": "",
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": "",
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxlcHBzbG91c2VyX2V2cCIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1Nzk5NTQzMzIsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.nE5DdwjZmZkyp2JaVCYPP31vgCyvYWj18_9Bf468ORoRiJ-37ACt8ihBbFwRR2WQPzddS0G0nBZvWf79NQtcNg"
        },
        {
          "description": "",
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": [],
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n    \"product\": {\r\n        \"entityRef\": {\r\n            \"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n        },\r\n        \"name\": \"AUS-EC-PU\",\r\n        \"credentials\": {\r\n            \"userName\": \"c00r9enq\",\r\n            \"password\": \"Em@e46qc\",\r\n            \"institutionID\": \"724287\"\r\n        },\r\n        \"options\": {\r\n            \"requestType\": \"NewOrder\",\r\n            \"miCompany\": \"EssentGuaranty\",\r\n            \"projectType\": \"T/FannieMaeReview\",\r\n            \"ausReportIdentifier\": \"\",\r\n            \"validationId\": \"\",\r\n            \"fileFormat\": \"1003\",\r\n            \"importConditions\": \"true\",\r\n            \"conditionType\": \"underwriting\",\r\n            \"orderMode\":\"\"\r\n        },\r\n        \"clientEntity\": {\r\n            \"activeVersion\": \"\",\r\n            \"configName\": \"\"\r\n        }\r\n    }\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxlcHBzbG91c2VyX2V2cCIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1Nzk5NTQzMzIsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.nE5DdwjZmZkyp2JaVCYPP31vgCyvYWj18_9Bf468ORoRiJ-37ACt8ihBbFwRR2WQPzddS0G0nBZvWf79NQtcNg\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "0dcc49f4-9335-4dbf-8788-64ee85126dbd",
      "name": "CreateLenderTransaction-DU",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxhZG1pbiIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzkwOTQxOTQsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.N-9Oda3YdsY4Po-yDMlB0AzY27RT67q4RaBt_H7C8g_z7nQUhvqhqjZWmDi5hmuzqB4Mrum8b_H4DduX-tABtQ"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n    \"product\": {\r\n        \"entityRef\": {\r\n            \"entityId\": \"c469a550-d123-4d8b-93b7-b8a6a7eaead5\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n        },\r\n        \"name\": \"AUS-DU\",\r\n        \"credentials\": {\r\n            \"userName\": \"c00r9enq\",\r\n            \"password\": \"Em@e46qc\",\r\n            \"institutionID\": \"210043\"\r\n        },\r\n        \"options\": {\r\n            \"requestType\": \"GetFindings\",\r\n            \"ausReportIdentifier\": \"1995383448\"\r\n        },\r\n        \"preferences\": {\r\n            \"importConditions\": \"false\",\r\n            \"conditionType\": \"Preliminary\"\r\n        }\r\n    }\r\n}\r\n",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxhZG1pbiIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzkwOTQxOTQsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.N-9Oda3YdsY4Po-yDMlB0AzY27RT67q4RaBt_H7C8g_z7nQUhvqhqjZWmDi5hmuzqB4Mrum8b_H4DduX-tABtQ\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "23ca6df7-6c25-432d-ba00-78e04917e809",
      "name": "CreateLenderTransaction-CBCT",
      "url": "http://localhost:52583/services/v1/partners/10000172/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMTcyIiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzA5Njg3MDksImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.rVHDPWGKVb5bUCvBjaJPv0CAF9Wg-aY9X6SrvYSCTB0mQDIoXBmIWgr190XsEAX6NASkrAm1nXCN2ieH9pevzw"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\r\n    \"product\": {\r\n\r\n        \"entityRef\": {\r\n\r\n            \"entityId\": \"a7dad86e-3c06-41f3-af8d-6ba752ceefa4#_borrower1\",\r\n\r\n            \"entityType\": \"urn:elli:encompass:loan:borrower\"\r\n\r\n        },\r\n\r\n        \"name\": \"Credit-CBCTAvantus\",\r\n\r\n        \"credentials\": {\r\n\r\n            \"userName\": \"elliemae\",\r\n\r\n            \"password\": \"4LLi4ma$$\"\r\n\r\n        },\r\n\r\n        \"options\": {\r\n\r\n            \"requestType\": \"NewOrder\",\r\n\r\n            \"reportOn\": \"Individual\",\r\n\r\n            \"reportType\": \"Merge\",\r\n\r\n            \"note\": \"\",\r\n\r\n            \"creditReportIdentifier\": \"\",\r\n\r\n            \"creditBureauExperian\": \"true\",\r\n\r\n            \"creditBureauEquifax\": \"false\",\r\n\r\n            \"creditBureauTransUnion\": \"true\"\r\n\r\n        },\r\n\r\n        \"preferences\": {\r\n\r\n            \"importLiabilities\": \"true\",\r\n\r\n            \"excludeZeroforImportLiabilities\": \"true\"\r\n\r\n        },\r\n\r\n        \"clientEntity\": {\r\n\r\n            \"activeVersion\": \"\",\r\n\r\n            \"configName\": \"\"\r\n\r\n        }\r\n\r\n    }\r\n\r\n}\r\n",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMTcyIiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzA5Njg3MDksImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.rVHDPWGKVb5bUCvBjaJPv0CAF9Wg-aY9X6SrvYSCTB0mQDIoXBmIWgr190XsEAX6NASkrAm1nXCN2ieH9pevzw\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "588007a6-45bf-422d-977e-655a255fff8e",
      "name": "CreateLenderTransaction-EarlyCheck_ULDD_Reissue",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"Reissue\",\r\n\t\t\t\"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"1996258265\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"ULDD\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"preliminary\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "61a62493-9ed6-4b65-ae71-56e35402a342",
      "name": "CreateLenderTransaction-EarlyCheck_1003_Reissue",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"Reissue\",\r\n\t\t    \"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"1996258265\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"1003\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"underwriting\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "8324c472-029e-4d41-9b9d-cc3207e0b234",
      "name": "CreateLenderTransaction-LQA_ULDD",
      "url": "http://localhost:52583/services/v1/partners/10000035/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMDM1IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzMyMTUwODMsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.AFlWd2HjQ-dtl2-j8MhTiAKjvsUTs4y8YW24Ajm7NpIB7FiHtHA5YplmGKCwKrKwgH5JGLJ-sxNAJKUCgBfHZA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"2ea127c2-6da8-45e8-a89a-b8ef4218bb7d\",\r\n\t\t\t\"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-LQA-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"ellimaeCTE_ELQASys2Sys\",\r\n\t\t\t\"password\": \"h1X}iZ4;1\",\r\n\t\t\t\"sellerServicerNumber\": \"000165\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"NewOrder\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMDM1IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzMyMTUwODMsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.AFlWd2HjQ-dtl2-j8MhTiAKjvsUTs4y8YW24Ajm7NpIB7FiHtHA5YplmGKCwKrKwgH5JGLJ-sxNAJKUCgBfHZA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "bca32e50-9642-4b2c-b896-7ff4afe2c5d8",
      "name": "CreateLenderTransaction-EarlyCheck_ULDD_NEWORDER",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"NewOrder\",\r\n\t\t\t\"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"ULDD\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"preliminary\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    }
  ]
}

📘

Note

importConditions is set to “true” only if you want to import all conditions/messages. “conditionType” is applicable when "importConditions": "true". Possible values are “Preliminary” | “Underwriting”.

Freddie Mac Loan Product Advisor

Product Attributes

This section lists the attributes used by Freddie Mac's underwriting service and includes sample requests demonstrating their use.

ATTRIBUTEDESCRIPTION
credentials.sellerServicerNumber
string		Organization identifier that Freddie Mac assigns to identify and authenticate your institution on their underwriting platform. To retrieve your LP Seller Service Number, contact Freddie Mac.
credentials.tpoAccountIdentifier
string		Conditionally Required. Identifies the third-party originator who is requesting the underwriting service via Encompass TPO connect.
options.ausReportLoanIdentifier
string		Conditionally Required. The identifier (LPA Loan ID) for an existing request on the AUS provider's platform. This attribute should be passed if it is available.
It is required when requesting a resubmission of an existing underwriting request.

If newOrder is passed as the value for the requestType attribute, this field will be ignored.
options.creditProviderAffiliateCode
string		Conditionally Required. This is an identifier for an affiliate of a credit provider on Freddie Mac's platform. This is a 3 digit code that must be passed along with the creditProviderCode attribute (identifying the Parent provider from the list above).

Refer to Credit Provider Codes to select the affiliate provider code for your credit service provider.
options.requestType
string		The type of underwriting request to place with the AUS provider. This can be a resubmission, or a reissue of an existing request. For the latter, you need to pass identifier(s) for the existing request on the AUS providers platform.

Possible values are:
_ newOrder - place a new underwriting service request for the referenced loan.

_ resubmit - resubmit an underwriting service request for the referenced loan.

Note: For a resubmit request, a reference to an existing underwriting service request must be passed via the: options.ausReportIdentifier and options.ausReportLoanIdentifier attributes.
options.ausReportLoanIdentifier is the LPA Loan ID. It is not required, but it should be passed if available.

Sample API Flow

Step 1: Place an LPA underwriting service request

{  
  "product":{  
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    },
    "name":"AUS",
    "credentials":{  
      "userName":"xxxxxxxx",
      "password":"xxxxxxxx", 
      "tpoAccountIdentifier":"",
      "sellerServicerNumber":"xxxxxxxx",
      "creditProviderUserName":"",
      "creditProviderPassword":""
    },
    "options":{  
      "requestType":"newOrder",
      "ausReportIdentifier":"",
      "ausReportLoanIdentifier":"",
      "creditProviderCode":"6",
      "creditAffiliateCode":"",
      "orderCreditDetails":[  
        {  
          "applicationID":"_borrower1",
          "creditReportIdentifier":""
        }
      ]
    },
    "preferences":{  
      "conditionType":"Underwriting",
      "importConditions":true
    }
  }
}

Step 2: Retrieve an LPA underwriting service response

{  
    "status":"success",
    "documents":{  
        "id":"",
        "name":"",
        "attachments":[  
            {  
                "mimeType":"emmedia/html",
                "name":"FullFeedback",
                "content":{  
                    "createdDateTime":"2018-03-06T23:05:23.0593687-08:00",
                    "attachmentFile":"Attachment-c1e1be06-dd56-4d35-8d2e-ebe8240be565.html"
                }
            },
            {  
                "mimeType":"emmedia/html",
                "name":"DocCheckList",
                "content":{  
                    "createdDateTime":"2018-03-06T23:05:23.0593687-08:00",
                    "attachmentFile":"Attachment-6bce458a-d2e6-4b86-9753-8136c0575259.html"
                }
            },
            {  
                "mimeType":"emmedia/html",
                "name":"HomeValueExplorer",
                "content":{  
                    "createdDateTime":"2018-03-06T23:05:23.0593687-08:00",
                    "attachmentFile":"Attachment-87d6c7aa-544c-42d1-8941-c2e51fb2aa53.html"
                }
            },
            {  
                "mimeType":"emmedia/html",
                "name":"MergedCredit",
                "content":{  
                    "createdDateTime":"2018-03-06T23:05:23.0593687-08:00",
                    "attachmentFile":"Attachment-b56365c9-64e4-45b5-b369-53f7fb49cf7d.html"
                }
            }
        ]
    },
    "product":{  
        "partnerID":"10000035",
        "productName":"AUS",
        "displayName":"Freddie Mac's Loan Product Advisor System to System",
        "category":"AUS",
        "entityRef":{  
            "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "entityType":"urn:elli:encompass:loan"
        }
    }
}

Freddie Mac Loan Quality Advisor

Sample API Flow

Step 1: Place an LQA underwriting service request

{
  "product": {
    "entityRef": {
      "entityId": "{{LoanUId}}",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "AUS-LQA-PU",
    "credentials": {
      "userName": "{{username}}",
      "password": "{{password}}",
      "sellerServicerNumber": "{{sellerServicerNumber}}"
    },
    "options": {
      "requestType": "NewOrder"
    }
  }
}

Step 2: Retrieve existing LQA report data file attached to Encompass loan

{
  "product": {
    "entityRef": {
      "entityId": "{{LoanUID}}",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "AUS-LQA-PU",
    "options": {
      "requestType": "RetrieveReportFiles",
      "applicationID": "_borrower1",
      "loanAttachments": "{{BooleanValue}}",
      "efolderAttachments": "{{BooleanValue}}",
      "reportIdentifier": "{{ReportIdentifier}}"
    }
  }
}

Step 3: Get result of an LQA transaction

{
  "product": {
    "entityRef": {
      "entityId": "{{LoanUID}}",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "AUS-LQA-PU",
    "options": {
      "requestType": "RetrieveReportFiles",
      "applicationID": "_borrower1",
      "loanAttachments": "{{BooleanValue}}",
      "efolderAttachments": "{{BooleanValue}}",
      "reportIdentifier": "{{ReportIdentifier}}"
    }
  }
}

{
  "id": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
  "name": "CreateResponseAPI",
  "description": "",
  "auth": null,
  "events": null,
  "variables": [],
  "order": [
    "0602ffb5-a9af-49cd-9876-f4400dfcce17",
    "61a62493-9ed6-4b65-ae71-56e35402a342",
    "bca32e50-9642-4b2c-b896-7ff4afe2c5d8",
    "588007a6-45bf-422d-977e-655a255fff8e",
    "8324c472-029e-4d41-9b9d-cc3207e0b234",
    "0dcc49f4-9335-4dbf-8788-64ee85126dbd",
    "23ca6df7-6c25-432d-ba00-78e04917e809"
  ],
  "folders_order": [],
  "folders": [],
  "requests": [
    {
      "id": "0602ffb5-a9af-49cd-9876-f4400dfcce17",
      "name": "CreateLenderTransaction-EarlyCheck_1003_NEWORDER",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": "",
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": "",
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxlcHBzbG91c2VyX2V2cCIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1Nzk5NTQzMzIsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.nE5DdwjZmZkyp2JaVCYPP31vgCyvYWj18_9Bf468ORoRiJ-37ACt8ihBbFwRR2WQPzddS0G0nBZvWf79NQtcNg"
        },
        {
          "description": "",
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": [],
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n    \"product\": {\r\n        \"entityRef\": {\r\n            \"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n        },\r\n        \"name\": \"AUS-EC-PU\",\r\n        \"credentials\": {\r\n            \"userName\": \"c00r9enq\",\r\n            \"password\": \"Em@e46qc\",\r\n            \"institutionID\": \"724287\"\r\n        },\r\n        \"options\": {\r\n            \"requestType\": \"NewOrder\",\r\n            \"miCompany\": \"EssentGuaranty\",\r\n            \"projectType\": \"T/FannieMaeReview\",\r\n            \"ausReportIdentifier\": \"\",\r\n            \"validationId\": \"\",\r\n            \"fileFormat\": \"1003\",\r\n            \"importConditions\": \"true\",\r\n            \"conditionType\": \"underwriting\",\r\n            \"orderMode\":\"\"\r\n        },\r\n        \"clientEntity\": {\r\n            \"activeVersion\": \"\",\r\n            \"configName\": \"\"\r\n        }\r\n    }\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxlcHBzbG91c2VyX2V2cCIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1Nzk5NTQzMzIsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.nE5DdwjZmZkyp2JaVCYPP31vgCyvYWj18_9Bf468ORoRiJ-37ACt8ihBbFwRR2WQPzddS0G0nBZvWf79NQtcNg\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "0dcc49f4-9335-4dbf-8788-64ee85126dbd",
      "name": "CreateLenderTransaction-DU",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxhZG1pbiIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzkwOTQxOTQsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.N-9Oda3YdsY4Po-yDMlB0AzY27RT67q4RaBt_H7C8g_z7nQUhvqhqjZWmDi5hmuzqB4Mrum8b_H4DduX-tABtQ"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n    \"product\": {\r\n        \"entityRef\": {\r\n            \"entityId\": \"c469a550-d123-4d8b-93b7-b8a6a7eaead5\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n        },\r\n        \"name\": \"AUS-DU\",\r\n        \"credentials\": {\r\n            \"userName\": \"c00r9enq\",\r\n            \"password\": \"Em@e46qc\",\r\n            \"institutionID\": \"210043\"\r\n        },\r\n        \"options\": {\r\n            \"requestType\": \"GetFindings\",\r\n            \"ausReportIdentifier\": \"1995383448\"\r\n        },\r\n        \"preferences\": {\r\n            \"importConditions\": \"false\",\r\n            \"conditionType\": \"Preliminary\"\r\n        }\r\n    }\r\n}\r\n",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcREVCRTExMTcwOTEzXFxhZG1pbiIsImVsbGlfaWlkIjoiREVCRTExMTcwOTEzIiwic3ViIjoiIiwiZWxsaV9jaWQiOiIzMDEwMDAwMDI0IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJlbGxpX3VyaSI6Imh0dHBzOi8vZW5jcGxhdC1wb2QyMDFtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzkwOTQxOTQsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.N-9Oda3YdsY4Po-yDMlB0AzY27RT67q4RaBt_H7C8g_z7nQUhvqhqjZWmDi5hmuzqB4Mrum8b_H4DduX-tABtQ\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "23ca6df7-6c25-432d-ba00-78e04917e809",
      "name": "CreateLenderTransaction-CBCT",
      "url": "http://localhost:52583/services/v1/partners/10000172/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMTcyIiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzA5Njg3MDksImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.rVHDPWGKVb5bUCvBjaJPv0CAF9Wg-aY9X6SrvYSCTB0mQDIoXBmIWgr190XsEAX6NASkrAm1nXCN2ieH9pevzw"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\r\n    \"product\": {\r\n\r\n        \"entityRef\": {\r\n\r\n            \"entityId\": \"a7dad86e-3c06-41f3-af8d-6ba752ceefa4#_borrower1\",\r\n\r\n            \"entityType\": \"urn:elli:encompass:loan:borrower\"\r\n\r\n        },\r\n\r\n        \"name\": \"Credit-CBCTAvantus\",\r\n\r\n        \"credentials\": {\r\n\r\n            \"userName\": \"elliemae\",\r\n\r\n            \"password\": \"4LLi4ma$$\"\r\n\r\n        },\r\n\r\n        \"options\": {\r\n\r\n            \"requestType\": \"NewOrder\",\r\n\r\n            \"reportOn\": \"Individual\",\r\n\r\n            \"reportType\": \"Merge\",\r\n\r\n            \"note\": \"\",\r\n\r\n            \"creditReportIdentifier\": \"\",\r\n\r\n            \"creditBureauExperian\": \"true\",\r\n\r\n            \"creditBureauEquifax\": \"false\",\r\n\r\n            \"creditBureauTransUnion\": \"true\"\r\n\r\n        },\r\n\r\n        \"preferences\": {\r\n\r\n            \"importLiabilities\": \"true\",\r\n\r\n            \"excludeZeroforImportLiabilities\": \"true\"\r\n\r\n        },\r\n\r\n        \"clientEntity\": {\r\n\r\n            \"activeVersion\": \"\",\r\n\r\n            \"configName\": \"\"\r\n\r\n        }\r\n\r\n    }\r\n\r\n}\r\n",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMTcyIiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzA5Njg3MDksImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.rVHDPWGKVb5bUCvBjaJPv0CAF9Wg-aY9X6SrvYSCTB0mQDIoXBmIWgr190XsEAX6NASkrAm1nXCN2ieH9pevzw\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "588007a6-45bf-422d-977e-655a255fff8e",
      "name": "CreateLenderTransaction-EarlyCheck_ULDD_Reissue",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"Reissue\",\r\n\t\t\t\"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"1996258265\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"ULDD\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"preliminary\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "61a62493-9ed6-4b65-ae71-56e35402a342",
      "name": "CreateLenderTransaction-EarlyCheck_1003_Reissue",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"Reissue\",\r\n\t\t    \"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"1996258265\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"1003\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"underwriting\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "8324c472-029e-4d41-9b9d-cc3207e0b234",
      "name": "CreateLenderTransaction-LQA_ULDD",
      "url": "http://localhost:52583/services/v1/partners/10000035/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMDM1IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzMyMTUwODMsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.AFlWd2HjQ-dtl2-j8MhTiAKjvsUTs4y8YW24Ajm7NpIB7FiHtHA5YplmGKCwKrKwgH5JGLJ-sxNAJKUCgBfHZA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"2ea127c2-6da8-45e8-a89a-b8ef4218bb7d\",\r\n\t\t\t\"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-LQA-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"ellimaeCTE_ELQASys2Sys\",\r\n\t\t\t\"password\": \"h1X}iZ4;1\",\r\n\t\t\t\"sellerServicerNumber\": \"000165\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"NewOrder\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTIwMDkyMlxcYWRtaW4iLCJlbGxpX2lpZCI6IkJFMTEyMDA5MjIiLCJzdWIiOiIiLCJlbGxpX2NpZCI6IjEwMDAwMDM1IiwiZWxsaV9pZHQiOiJFbnRlcnByaXNlIiwicm9sZXMiOltdLCJleHAiOjE1NzMyMTUwODMsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.AFlWd2HjQ-dtl2-j8MhTiAKjvsUTs4y8YW24Ajm7NpIB7FiHtHA5YplmGKCwKrKwgH5JGLJ-sxNAJKUCgBfHZA\nContent-Type: application/json\n",
      "pathVariables": []
    },
    {
      "id": "bca32e50-9642-4b2c-b896-7ff4afe2c5d8",
      "name": "CreateLenderTransaction-EarlyCheck_ULDD_NEWORDER",
      "url": "http://localhost:52583/services/v1/partners/10000034/transactions",
      "description": null,
      "data": [],
      "dataOptions": null,
      "dataMode": "raw",
      "headerData": [
        {
          "description": null,
          "enabled": true,
          "key": "Authorization",
          "type": "text",
          "value": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA"
        },
        {
          "description": null,
          "enabled": true,
          "key": "Content-Type",
          "type": "text",
          "value": "application/json"
        }
      ],
      "method": "POST",
      "pathVariableData": [],
      "queryParams": [],
      "auth": null,
      "events": null,
      "folder": null,
      "currentHelper": null,
      "helperAttributes": null,
      "collectionId": "b1d85904-f82e-4a12-ab2c-6e8971b934fe",
      "rawModeData": "{\r\n\t\"product\": {\r\n\t\t\"entityRef\": {\r\n\t\t\t\"entityId\": \"6a00e270-704c-423e-b0c3-d4be5c99ff32\",\r\n            \"entityType\": \"urn:elli:encompass:loan\"\r\n\t\t},\r\n\t\t\"name\": \"AUS-EC-PU\",\r\n\t\t\"credentials\": {\r\n\t\t\t\"userName\": \"c00r9enq\",\r\n\t\t\t\"password\": \"Em@e46qc\",\r\n\t\t\t\"ecinstid\": \"724287\"\r\n\t\t},\r\n\t\t\"options\": {\r\n\t\t\t\"requestType\": \"NewOrder\",\r\n\t\t\t\"miCompany\": \"EssentGuaranty\",\r\n\t\t\t\"projectType\": \"T/FannieMaeReview\",\r\n\t\t\t\"ausReportIdentifier\": \"\",\r\n\t\t\t\"validationId\": \"1984155213\",\r\n\t\t\t\"fileFormat\": \"ULDD\",\r\n\t\t\t\"importConditions\": \"true\",\r\n\t\t\t\"conditionType\": \"preliminary\"\r\n\t\t},\r\n\t\t\"clientEntity\": {\r\n\t\t\t\"activeVersion\": \"\",\r\n\t\t\t\"configName\": \"\"\r\n\t\t}\r\n\t}\r\n}",
      "headers": "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJlbGxpX3VpZCI6IkVuY29tcGFzc1xcQkUxMTExNzI2NDZcXGFkbWluIiwiZWxsaV9paWQiOiJCRTExMTE3MjY0NiIsInN1YiI6IiIsImVsbGlfY2lkIjoiMTAwMDAwMzQiLCJlbGxpX2lkdCI6IkVudGVycHJpc2UiLCJyb2xlcyI6W10sImVsbGlfdXJpIjoiIGh0dHBzOi8vZW5jcGxhdC1wb2QxOTNtYWluLmludC5kY28uZWxtYWUiLCJleHAiOjE1NzEzODcxMTYsImlzcyI6InVybjplbGxpOnNlcnZpY2U6aWRzIiwiYXVkIjoidXJuOmVsbGk6c2VydmljZTplYnMsdXJuOmVsbGk6c2VydmljZTpldnAifQ.lI0o9m52V0rCoQxc1_38EehEGd60TZYI9J3siXwt0UYfDhH-wwS0qXl2KsXe-YFHB7N6LQJhcpPOfUr75VmYUA\nContent-Type: application/json\n",
      "pathVariables": []
    }
  ]
}

📘

Note

importConditions is set to “true” only if you want to import all conditions/messages. “conditionType” is applicable when "importConditions": "true". Possible values are “Preliminary” | “Underwriting”.

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