Download Postman Collection
API Reference

Freddie Mac Datashare APIs

Use the Freddie Mac Datashare APIs to retrieve Loan Closing Advisor (LCLA)/Loan Product Advisor (LPA)/ Loan Quality Advisor (LQA) documents for a previously submitted loan using LPA Key (AUS Identifier) and Primary Borrower Last name.
Datashare API will request the data using the AUS key for the Freddie Mac Service (LCLA/LPA/LQA) and then verify that the submitted Borrower Last name and property Address matches the record in the Freddie Mac document storage repository. If a match is made the system will retrieve LCLA/LPA/LQA Data or PDF associated with that AUS key for requested loan. If a match is not made an error message will be returned.

POST https://api.elliemae.com/services/v1/partners/10000035/transactions]

📘

Additional information

For more information on the POST API, see Order Services.

Product Attributes

The following table lists Freddie Mac attributes under the product object. The attributes listed in the following table are required by Freddie Mac unless otherwise specified.

ATTRIBUTEDESCRIPTION
name
string		Required. Name of the product to order.
- For LCLA, value is AUS-LCLA
- For LPA: AUS-LPA
- For LQA: AUS-LQA
entityRef
object		References the entity ID and entity type. The loan ID is associated with the loan, Loan ID is returned by getLoan.
entityRef.entityId
string		Required. The entity identifier. For example, the loan ID:
{loanId}
entityRef.entityType
string		Required. The type of entity value is urn:elli:encompass:loan
credentials
object		Object that encapsulates credentials and/or verification information with the AUS provider.
credentials.userName
string		Required. Username for the service provider account.
credentials.password
string		Required. Password for the service provider account.
credentials.sellerServicerNumber
string		Required. 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.
credentials.branchID
string		Optional. Branch identifier for the service provider account.
options
object		Important! The parameters defined by the options object will be different depending on the service provider you choose.
options.requestType
string		Required. Use the following in parameter value for retrieving DataShare Documents.
- For LCLA: Use GetLCLADataShare
- For LPA: Use GetLPADataShare
- For LQA: Use GetLQADataShare
options.ausReportIdentifier
string		Required. The LPA Key Number for an existing order (available from the previous order).
Example: A1234567.
clientEntity
object		Object that encapsulates preferences for service specific functionality.
clientEntity.configName
string		Optional. Post order submission to Freddie Mac lower environment.
Value: QA
Note: Please remove this attribute from your production submission contracts.

📘

NOTE

To retrieve LCLA/LPA/LQA data through API, users must send minimum number of identifying data points, such as:

  • Primary Borrower Last Name
  • Full Property Address (Street, City, State and Zipcode)
  • AUS Key/ LPA Key

Users need to ensure Loan data must include matching Borrower Last Name and full Property Address. Only then Freddie Mac DataShare API gives successful response.

Partner Information

Use the Product Name listed below to create transactions that follow the respective schema.

PartnerPartner IDServiceProduct Name
Freddie Mac10000035Loan Closing AdvisorAUS-LCLA
Freddie Mac10000035Loan Product AdvisorAUS-LPA
Freddie Mac10000035Loan Quality AdvisorAUS-LQA

Sample API Flows

Freddie Mac Loan Closing Advisor

Step 1: Request for retrieving last transaction of Loan Closing Advisor

{
    "product": {
        "entityRef": {
            "entityId": "{{loanId}}",
            "entityType": "urn:elli:encompass:loan"
        },
        "name": "AUS-LCLA",
        "credentials": {
            "userName": "xxxxxxx",
            "password": "xxxxxxxxx",
            "tpoAccountIdentifier": "",
            "sellerServicerNumber": "000165",
            "branchId": ""
        },
        "options": {
            "requestType": "GetLCLADataShare",
            "ausReportIdentifier": "A0013437"
        }
    }
}

Step 2: Retrieve an LCLA underwriting service response

{
    "status": "success",
    "documents": {
        "id": "",
        "name": "",
        "attachments": [
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_UCDLoanXMLWithEmbeddedClosingDisclosurePDF_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5976285-08:00",
                    "attachmentFile": "c475cf17-dcc7-4a42-bede-9f09aa43ffb9"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureModelForm_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5819914-08:00",
                    "attachmentFile": "20eeb378-9549-4e38-a19d-0fb6aa4f5621"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureAlternateForm_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5976285-08:00",
                    "attachmentFile": "78b125f6-952e-491a-b1d4-b89fb0bf39df"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureBorrowerOnly_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5976285-08:00",
                    "attachmentFile": "2523d68f-ca1a-408b-94ce-60b134bc4709"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureSellerOnly_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5976285-08:00",
                    "attachmentFile": "3f858078-28bd-42c2-b0a7-80efc00303cf"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureFeedbackDetail_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5819914-08:00",
                    "attachmentFile": "3e3ab739-578e-4b40-96ea-1e5dc0f64bf5"
                }
            },
            {
                "mimeType": "emmedia/pdf",
                "name": "LCLA_ClosingDisclosureFeedbackSummary_Datashare",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2022-11-15T03:39:58.5819914-08:00",
                    "attachmentFile": "58b45c50-5ef1-418c-a644-99952026dde8"
                }
            }
        ]
    },
    "product": {
        "partnerID": "10000035",
        "productName": "AUS-LCLA",
        "displayName": "Loan Closing Advisor-DEMO-1",
        "category": "AUS",
        "entityRef": {
            "entityId": "5a234849-f486-4636-a79e-7b2d15fcb76d",
            "entityType": "urn:elli:encompass:loan"
        }
    }
}

Loan Product Advisor

Step 1: Request for retrieving last transaction of Loan Product Advisor

{
    "product": {
        "entityRef": {
            "entityId": "{83728bc0-eabe-4894-9d54-185284815ec2}",
            "entityType": "urn:elli:encompass:loan"
        },
        "name": "AUS-LPA",
        "credentials": {
            "userName": "XXXXXXXXXXX",
            "password": "XXXXXXXXXXX",
            "tpoAccountIdentifier": "",
            "sellerServicerNumber": "000165",
            "branchId": ""
        },
        "options": {
            "requestType": "GetLPADataShare",
            "ausReportIdentifier": "A1234567"
        }
    }
}

Step 2: Retrieve an LPA underwriting service response

To get the documents for a transaction.

GET https://api.elliemae.com/services/v1/partners/10000035/transactions/{transactionId}?generateFileUrls=True

{
    "status": "success",
    "resources": [
        {
            "id": "a9a8e8f6-02ed-4b46-aa6f-88ad8fd26a81",
            "name": "FullFeedback",
            "mimeType": "application/octet-stream",
            "elli-signature": "elli-signature BC5A9AEC4879C97DE0AAFBE77E6382ECE2D1FEFAE44A65C117",
            "url": "https://int.streaming.us-west-2.skydrive.rd.elliemae.io/v1/clients/3010000024/0d2707bd-f205-4800-97de-361f52c3ba3b?validity=MTY3OTAyODQ5NTY3NQ%3D%3D&sub=dXJuOmVsbGk6c2VydmljZTpldnA%3D"
        }
    ],
    "product": {
        "partnerID": "10000035",
        "productName": "AUS-LPA",
        "displayName": "Freddie Mac's Loan Product Advisor System to System",
        "category": "AUS",
        "entityRef": {
            "entityId": "3bbd3297-02d0-4711-9ce4-102325175a12",
            "entityType": "urn:elli:encompass:loan"
        }
    }
}

📘

Additional information

For more information on the GET API, see Get Service Order Status.

Loan Quality Advisor

Step 1: Request for retrieving last transaction of Loan Quality Advisor

{
    "product": {
        "entityRef": {
            "entityId": "{{LoanId}}",
            "entityType": "urn:elli:encompass:loan"
        },
        "name": "AUS-LQA",
        "credentials": {
            "userName": "XXXXXXXXX",
            "password": "XXXXXXXXX",
            "tpoAccountIdentifier": "",
            "sellerServicerNumber": "XXXXX",
            "branchId": ""
        },
        "options": {
            "requestType": "GetLQADataShare",
            "reportIdentifier": "XXXXXXXX"
        },
        "clientEntity": {
            "configName": "XXX"
        }
    }
}

Step 2: Retrieve an LQA underwriting service response

To get the documents for a transaction.

GET https://api.elliemae.com/services/v1/partners/10000035/transactions/{transactionId}?generateFileUrls=True

{
    "status": "success",
    "documents": {
        "id": "",
        "name": "",
        "attachments": [
            {
                "mimeType": "emmedia/pdf",
                "name": "LQA_ResponsePDF",
                "content": {
                    "mediatype": "attachment",
                    "createdDateTime": "2023-03-17T15:24:20.9897597+05:30",
                    "attachmentFile": "4527d362-d476-4abd-8815-fb8aac40e7f0"
                }
            }
        ]
    },
    "product": {
        "partnerID": "10000035",
        "productName": "AUS-LQA",
        "displayName": "Freddie Mac's Loan Quality Advisor",
        "category": "AUS",
        "entityRef": {
            "entityId": "{3bbd3297-02d0-4711-9ce4-102325175a12}",
            "entityType": "urn:elli:encompass:loan"
        }
    }
}

📘

Additional information

For more information on the GET API, see Get Service Order Status.

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