Download Postman Collection
API Reference

Freddie Mac Affordable Check API

Use the Freddie Mac Affordable Check API to submit a preliminary assessment for Freddie Mac affordable product eligibility prior to submitting a full application to Freddie Mac’s Loan Product Advisor®

This API added with the 25.2 release of Encompass.

POST /services/v1/partners/10000035/transactions]

📘

Additional Information

  • For an overview of Freddie Mac Affordable Check, also see Freddie Mac’s Affordable Check Developer Portal page. Please note however, the ICE MT integration with Freddie Mac Affordable Check API uses the attributes listed below, not the specifications listed by Freddie Mac.
  • See the Order Services endpoint page for more information on the POST operation.

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.

- Value is AUS-LPAffordableCheck
entityRef
object		References the entity ID and entity type. The loan ID is associated with the loan, Loan ID is returned by V3 Get Loan.
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: NewOrder
options.requestId
string		Required. Use the following in parameter value: {GUID generated by caller}
options.partyRoleType
string		Required. Use the one of following values: Broker, Seller, Servicer, Correspondent or Lender
clientEntity
object		Object that encapsulates preferences for service specific functionality.
clientEntity.configName
string		Optional. Post order submission to Freddie Mac lower environment.
Value: UAT
Note: Please remove this attribute from your production submission contracts.

Sample API Flows

Freddie Mac Affordable Check API - Sample Request

{
	"product": {
		"entityRef": {
			"entityId": "{loan_uid}",
			"entityType": "urn:elli:encompass:loan"
		},
		"name": "AUS-LPAffordableCheck",
		"credentials": {
			"userName": "{username}",
			"password": "{password}",
			"tpoAccountIdentifier": "{TPO ID if applicable}",
			"sellerServicerNumber": "{seller #}"
		},
		"options": {
			"requestType": "NewOrder",
			"requestId": "{GUID generated by caller}",
			"partyRoleType": "{Broker | Seller | Servicer | Correspondent | Lender }"
		},
		"clientEntity": {
			"configName": "{set 'UAT' point to Freddie Mac lower environment - leave blank for Prod}"
		}
	}
}

Freddie Mac Affordable Check API - Live Data Sample Response

{
    "status": "success",
    "responseDetail": {
        "requestTransactionIdentifier": "c784e373-fd6c-449a-bb06-e803c951e1b2",
        "transactionDateTime": "2025-04-13T21:52:06.055179853Z",
        "inputSubjectPropertyAddress": {
            "addressLineText": "1234 Main St",
            "cityName": "Winston Salem",
            "postalCode": "27104",
            "stateCode": "NC"
        },
        "standardizedSubjectPropertyAddress": {
            "addressLineText": "1234 S MAIN ST",
            "cityName": "WINSTON SALEM",
            "postalCode": "27101",
            "stateCode": "NC",
            "censusTractIdentifier": "001902",
            "fipsCountyCode": "067",
            "fipsStateNumericCode": "37",
            "countyName": "Forsyth",
            "coreBasedStatisticalAreaCode": "49180",
            "minorityPopulationCensusTractPercent": "40.567",
            "disasterAreaCensusTractIndicator": false,
            "minorityPopulationCensusTractIndicator": true,
            "lowIncomeCensusTractIndicator": false,
            "highNeedsRuralRegionEligibilityAndQualifiedIndicator": false,
            "ruralAreaIndicator": false,
            "highCostAreaIndicator": false
        },
        "incomeLimitsData": {
            "derivedLTVRatioPercent": "44.44",
            "derivedCombinedLTVRatioPercent": "44.44",
            "incomeToAMIPercentage": "0.00",
            "amiEffectiveDate": "2024-05-03",
            "refiPossibleIncomeLimitAmount": "81900.00",
            "homePossibleIncomeLimitAmount": "65520.00",
            "hundredAndFortyPercentHUDMedianIncomeAmount": "114660.00",
            "hundredAndTwentyPercentHUDMedianIncomeAmount": "98280.00",
            "hundredPercentHUDMedianIncomeAmount": "81900.00",
            "eightyPercentHUDMedianIncomeAmount": "65520.00",
            "fiftyPercentHUDMedianIncomeAmount": "40950.00"
        },
        "loanLimitsData": {
            "loanConformityType": "Conforming",
            "oneUnitLimitAmount": "806500.0"
        },
        "affordableProgramDetails": [
            {
                "recommendedProductIdentifier": "HomePossible",
                "borrowerEligibilityMessage": [
                    {
                        "messageCode": "AFC0038",
                        "messageDescription": "Based on the submitted information, the borrower meets the requirements for a Home Possible loan which offers flexible sources of funds, such as gifts and grants towards 3% minimum down payment requirement, no minimum borrower contribution and reduced delivery fees and mortgage insurance coverage levels to enhance affordability."
                    },
                    {
                        "messageCode": "AFC0040",
                        "messageDescription": "The Maximum loan-to-value (LTV) for Manufactured Housing loans cannot be fully assessed until submitted to LPA."
                    }
                ]
            },
            {
                "recommendedProductIdentifier": null,
                "borrowerEligibilityMessage": [
                    {
                        "messageCode": "AFC0047",
                        "messageDescription": "Based on the information provided, the loan meets the criteria of a Minority Census Tract Area transaction."
                    },
                    {
                        "messageCode": "AFC0048",
                        "messageDescription": "Based on the information provided, the loan meets the criteria of a Duty to Serve – Manufactured Housing transaction."
                    }
                ]
            }
        ],
        "defaultedData": {
            "determineHFAAdvantageEligibilityIndicator": false,
            "includesNonOccupantIncomeIndicator": false,
            "lienPriorityType": "FirstLien",
            "loanMaturityPeriodCount": "360",
            "loanMortgageType": "Conventional"
        }
    },
    "product": {
        "partnerID": "10000035",
        "productName": "AUS-LPAffordableCheck",
        "displayName": "Freddie Mac Affordable Check-UAT-1",
        "category": "AUS",
        "entityRef": {
            "entityId": "1d092c80-9319-4d78-9b7f-43a1cd8ae3ab",
            "entityType": "urn:elli:encompass:loan"
        },
        "creationDate": "2025-04-13T18:52:02Z",
        "lastUpdatedDate": "2025-04-13T18:52:09Z",
        "orderedBy": "urn:elli:encompass:BE11200089:user:farid"
    }
}
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use