Freddie Mac Resolve Workout Options
Request real-time eligibility decisions for multiple workout options in a single response.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/resolve-workout-options"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
{
"openapi" : "3.0.1",
"info" : {
"title" : "Resolve Workout Options",
"version" : "1.3.0"
},
"servers" : [ {
"url" : "https://api-test.freddiemac.com/singlefamily/v1/servicing/workoutservice/workout-service"
} ],
"security" : [ {
"bearerAuth" : [ ]
} ],
"tags" : [ {
"name" : "Resolve Workout Options",
"description" : "Get a quick view of borrower eligibility for multiple workout options, rationale and workout terms before moving to approval and settlement."
} ],
"paths" : {
"/api/evaluateWorkout" : {
"post" : {
"tags" : [ "Resolve Workout Options" ],
"summary" : "Delivers upfront eligibility check for multiple workout options simultaneously, with a single request.",
"description" : "Interface to support processing of loan evaluation for workouts.",
"operationId" : "evaluateWorkoutUsingPOST",
"requestBody" : {
"description" : "workoutOptionRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WorkoutOptionRequest"
},
"examples" : {
"EligibilityDecisionRequest" : {
"summary" : "Scenario 1 - Request with a new eligibility decision",
"description" : "Property value is available, hardship reason is Divorce",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S1.0.1",
"createdDatetime" : "2021-12-09T13:45:00.000Z",
"description" : "workoutoptions"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "DraftReq",
"workoutProgramType" : "workoutoptions",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"servicerLoanIdentifier" : "ab03123490308",
"borrowerResponsePackageReceivedDate" : "05-01-2020",
"loanImminentDefaultIndicator" : "N",
"rightPartyContactIndicator" : "Y",
"reportedFirstPaymentDueDate" : null,
"collectionInfo" : [ {
"collectionInfoCategory" : "RightPartyContact",
"collectionContactDate" : "04-10-2020"
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Divorce",
"reasonForExtenuatingCircumstances" : ""
} ],
"disasterInfo" : {
"disasterType" : "",
"disasterDeclarationDate" : "",
"disasterCountyCode" : ""
},
"propertyInfo" : {
"propertyConditionType" : "N/A",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC",
"propertyType" : "",
"grossRentalIncome" : 1000
},
"partyInfo" : {
"totalCashReserveAmount" : 50000,
"totalMonthlyLiabilities" : 2000,
"party" : [ {
"borrowerType" : "Primary",
"borrowerInfo" : {
"borrowerDetail" : {
"creditScoreDate" : "12-10-2018",
"creditScoreValue" : 500
},
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 250000,
"incomeType" : "GrossMonthlyIncome"
}
} ]
}
} ]
},
"premodHousingExpense" : [ {
"housingExpenseType" : "TotalMonthlyExpenses",
"housingExpensePaymentAmount" : 200
}, {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ],
"workouts" : {
"escrow" : {
"escrowDetail" : {
"escrowShortagePaymentAmount" : 0.1,
"projectedEscrowShortageAmount" : 0.1,
"capitalizedEscrowAmount" : 0.1,
"restrictedEscrowBalanceAmount" : 0.1,
"actualEscrowShortageSpreadAmount" : 0.1
}
},
"capitalizedArrears" : [ {
"category" : "LegalFeesandCosts",
"amount" : 100
}, {
"category" : "BorrowerContribution",
"amount" : 200
} ],
"closingData" : [ {
"category" : "BuyerFirstName",
"value" : "John"
} ],
"propertyContractInfo" : {
"contractSalesDate" : "",
"contractSalesPrice" : 0.1,
"mLSListDate" : "",
"aRMSLengthTransactionIndicator" : ""
},
"additionalData" : {
"newMortgages" : "",
"secondLienUPB" : 0.1,
"secondLienMortgageLender" : "",
"isInsufficientContributionJustified" : "",
"reasonForInsufficientContribution" : ""
},
"valuationData" : [ {
"category" : "ServicerContactFirstName",
"value" : ""
} ]
},
"eligibilityQuestionnaire" : {
"reinstatementViable" : "N",
"repaymentWithActiveOffer" : "N",
"willingToRetainProperty" : "Y",
"hardshipResolved" : "Y",
"ableToMakeContractualPayment" : "Y",
"leaseholdPropertyTermsRemain" : "Y"
},
"workoutCommentsText" : "workout request additional comments"
}
} ]
}
}
}
},
"ConditionalRequest" : {
"summary" : "Scenario 2 - Request with a 'Conditional' eligibility decision",
"description" : "Submission with limited data provided in the request",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S1.0.1",
"createdDatetime" : "2021-12-09T13:45:00.000Z",
"description" : "workoutoptions"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "DraftReq",
"workoutProgramType" : "workoutoptions",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "222222222",
"servicerLoanIdentifier" : "ab03123490308",
"borrowerResponsePackageReceivedDate" : "05-01-2020",
"loanImminentDefaultIndicator" : "N",
"rightPartyContactIndicator" : "Y",
"reportedFirstPaymentDueDate" : null,
"collectionInfo" : [ {
"collectionInfoCategory" : "RightPartyContact",
"collectionContactDate" : "04-10-2020"
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Divorce",
"reasonForExtenuatingCircumstances" : ""
}, {
"hardshipReasonType" : "Other",
"reasonForExtenuatingCircumstances" : ""
} ],
"disasterInfo" : {
"disasterType" : "",
"disasterDeclarationDate" : "",
"disasterCountyCode" : ""
},
"propertyInfo" : {
"propertyConditionType" : "N/A",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC",
"propertyType" : "",
"grossRentalIncome" : 1000
},
"partyInfo" : {
"totalCashReserveAmount" : 50000,
"totalMonthlyLiabilities" : 2000,
"party" : [ {
"borrowerType" : "Primary",
"borrowerInfo" : {
"borrowerDetail" : {
"creditScoreDate" : "12-10-2018",
"creditScoreValue" : 500
},
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 250000,
"incomeType" : "GrossMonthlyIncome"
}
} ]
}
} ]
},
"premodHousingExpense" : [ {
"housingExpenseType" : "TotalMonthlyExpenses",
"housingExpensePaymentAmount" : 200
}, {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ],
"workouts" : {
"escrow" : {
"escrowDetail" : {
"escrowShortagePaymentAmount" : 0.1,
"projectedEscrowShortageAmount" : 0.1,
"capitalizedEscrowAmount" : 0.1,
"restrictedEscrowBalanceAmount" : 0.1,
"actualEscrowShortageSpreadAmount" : 0.1
}
},
"capitalizedArrears" : [ {
"category" : "LegalFeesandCosts",
"amount" : 100
}, {
"category" : "BorrowerContribution",
"amount" : 200
} ],
"closingData" : [ {
"category" : "BuyerFirstName",
"value" : "John"
} ],
"propertyContractInfo" : {
"contractSalesDate" : "",
"contractSalesPrice" : 0.1,
"mLSListDate" : "",
"aRMSLengthTransactionIndicator" : ""
},
"additionalData" : {
"newMortgages" : "",
"secondLienUPB" : 0.1,
"secondLienMortgageLender" : "",
"isInsufficientContributionJustified" : "",
"reasonForInsufficientContribution" : ""
},
"valuationData" : [ {
"category" : "ServicerContactFirstName",
"value" : ""
} ]
},
"eligibilityQuestionnaire" : {
"reinstatementViable" : "N",
"willingToRetainProperty" : "Y",
"hardshipResolved" : "Y",
"ableToMakeContractualPayment" : "Y",
"leaseholdPropertyTermsRemain" : ""
},
"workoutCommentsText" : "workout request additional comments"
}
} ]
}
}
}
},
"InvalidRequest" : {
"summary" : "Scenario 3 - Request with atleast one upfront validation error",
"description" : "upfront data / schema validation",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S1.0.1",
"createdDatetime" : "2021-12-09T13:45:00.000Z",
"description" : "workoutoptions"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "DraftReq",
"workoutProgramType" : "workoutoptions",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "444444444",
"servicerLoanIdentifier" : "ab03123490308",
"borrowerResponsePackageReceivedDate" : "05/01/2020",
"loanImminentDefaultIndicator" : "N",
"rightPartyContactIndicator" : "Y",
"reportedFirstPaymentDueDate" : "",
"collectionInfo" : [ {
"collectionInfoCategory" : "RightPartyContact",
"collectionContactDate" : "04-10-2020"
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Unemmp",
"reasonForExtenuatingCircumstances" : ""
} ],
"disasterInfo" : {
"disasterType" : "",
"disasterDeclarationDate" : "",
"disasterCountyCode" : ""
},
"propertyInfo" : {
"propertyConditionType" : "N/A",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC",
"propertyType" : "",
"grossRentalIncome" : 1000
},
"partyInfo" : {
"totalCashReserveAmount" : 50000,
"totalMonthlyLiabilities" : 2000,
"party" : [ {
"borrowerType" : "Primary",
"borrowerInfo" : {
"borrowerDetail" : {
"creditScoreDate" : "12-10-2018",
"creditScoreValue" : 500
},
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 250000,
"incomeType" : "GrossMonthlyIncome"
}
} ]
}
} ]
},
"premodHousingExpense" : [ {
"housingExpenseType" : "TotalMonthlyExpenses",
"housingExpensePaymentAmount" : 200
}, {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ],
"workouts" : {
"escrow" : {
"escrowDetail" : {
"escrowShortagePaymentAmount" : 0.1,
"projectedEscrowShortageAmount" : 0.1,
"capitalizedEscrowAmount" : 0.1,
"restrictedEscrowBalanceAmount" : 0.1,
"actualEscrowShortageSpreadAmount" : 0.1
}
},
"capitalizedArrears" : [ {
"category" : "LegalFeesandCosts",
"amount" : 100
}, {
"category" : "BorrowerContribution",
"amount" : 200
} ],
"closingData" : [ {
"category" : "BuyerFirstName",
"value" : "John"
} ],
"propertyContractInfo" : {
"contractSalesDate" : "",
"contractSalesPrice" : 0.1,
"mLSListDate" : "",
"aRMSLengthTransactionIndicator" : ""
},
"additionalData" : {
"newMortgages" : "",
"secondLienUPB" : 0.1,
"secondLienMortgageLender" : "",
"isInsufficientContributionJustified" : "",
"reasonForInsufficientContribution" : ""
},
"valuationData" : [ {
"category" : "ServicerContactFirstName",
"value" : ""
} ]
},
"eligibilityQuestionnaire" : {
"reinstatementViable" : "N",
"repaymentWithActiveOffer" : "N",
"willingToRetainProperty" : "Y",
"hardshipResolved" : "Y",
"ableToMakeContractualPayment" : "Y",
"leaseholdPropertyTermsRemain" : "N"
},
"workoutCommentsText" : "workout request additional comments"
}
} ]
}
}
}
},
"UndeterminedDecision" : {
"summary" : "Scenario 4 - Request with an 'Undetermined' eligibility decision",
"description" : "Property usage is unavailable, hardship reason is national emergency",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S1.0.1",
"createdDatetime" : "2021-12-09T13:45:00.000Z",
"description" : "workoutoptions"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "DraftReq",
"workoutProgramType" : "workoutoptions",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "444444444",
"servicerLoanIdentifier" : "ab03123490308",
"borrowerResponsePackageReceivedDate" : "05-01-2020",
"loanImminentDefaultIndicator" : "N",
"rightPartyContactIndicator" : "Y",
"reportedFirstPaymentDueDate" : "",
"collectionInfo" : [ {
"collectionInfoCategory" : "RightPartyContact",
"collectionContactDate" : "04-10-2020"
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Other",
"reasonForExtenuatingCircumstances" : ""
} ],
"disasterInfo" : {
"disasterType" : "",
"disasterDeclarationDate" : "",
"disasterCountyCode" : ""
},
"propertyInfo" : {
"propertyConditionType" : "N/A",
"propertyUsageType" : "",
"propertyOccupancyType" : "OC",
"propertyType" : "",
"grossRentalIncome" : 1000
},
"partyInfo" : {
"totalCashReserveAmount" : 50000,
"totalMonthlyLiabilities" : 2000,
"party" : [ {
"borrowerType" : "Primary",
"borrowerInfo" : {
"borrowerDetail" : {
"creditScoreDate" : "12-10-2018",
"creditScoreValue" : 500
},
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 250000,
"incomeType" : "GrossMonthlyIncome"
}
} ]
}
} ]
},
"premodHousingExpense" : [ {
"housingExpenseType" : "TotalMonthlyExpenses",
"housingExpensePaymentAmount" : 200
}, {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ],
"workouts" : {
"escrow" : {
"escrowDetail" : {
"escrowShortagePaymentAmount" : 0.1,
"projectedEscrowShortageAmount" : 0.1,
"capitalizedEscrowAmount" : 0.1,
"restrictedEscrowBalanceAmount" : 0.1,
"actualEscrowShortageSpreadAmount" : 0.1
}
},
"capitalizedArrears" : [ {
"category" : "LegalFeesandCosts",
"amount" : 100
}, {
"category" : "BorrowerContribution",
"amount" : 200
} ],
"closingData" : [ {
"category" : "BuyerFirstName",
"value" : "John"
} ],
"propertyContractInfo" : {
"contractSalesDate" : "",
"contractSalesPrice" : 0.1,
"mLSListDate" : "",
"aRMSLengthTransactionIndicator" : ""
},
"additionalData" : {
"newMortgages" : "",
"secondLienUPB" : 0.1,
"secondLienMortgageLender" : "",
"isInsufficientContributionJustified" : "",
"reasonForInsufficientContribution" : ""
},
"valuationData" : [ {
"category" : "ServicerContactFirstName",
"value" : ""
} ]
},
"eligibilityQuestionnaire" : {
"reinstatementViable" : "N",
"repaymentWithActiveOffer" : "N",
"willingToRetainProperty" : "Y",
"hardshipResolved" : "Y",
"ableToMakeContractualPayment" : "Y",
"leaseholdPropertyTermsRemain" : "Y"
},
"workoutCommentsText" : "workout request additional comments"
}
} ]
}
}
}
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "<b>OK</b> Request succeeded.\r\n\n <b>Sample Eligibility Messages</b> <br/> <ul> <li><strong>LM000026</strong> Loan is eligible for the Flex modification. \r\n\n </li><li><strong>LM000027</strong> Loan is not eligible for Flex modification. Please review the Freddie Mac response and validate the terms submitted. Please resubmit the correct terms for processing or submit to Freddie Mac for non-delegated review. \r\n\n </li><li><strong>LM000028</strong> Loan is approved for Flex modification settlement. Please review the final modified terms and submit for settlement. \r\n\n </li><li><strong>LM000029</strong> Loan cannot be processed for Flex modification settlement. Please review the Freddie Mac response and resubmit the corrected information or submit for manual review. \r\n\n </li><li><strong>LM000030</strong> Loan has been successfully submitted for settlement. Please review your Manager Series reports for updates. \r\n\n </li><li><strong>LM000001</strong> Loan originated less than 12 months ago. \r\n\n </li><li><strong>LM000002</strong> Loan has been modified three or more times. \r\n\n </li><li><strong>LM000003</strong> Prior Flex Modification for this loan defaulted within 12 months from the current Evaluation Date. \r\n\n </li><li><strong>LM000004</strong> Loan has failed Prior Flex Modification trial within 12 months from current Evaluation Date. \r\n\n </li><li><strong>LM000005</strong> Loan is Credit Enhanced with Indemnification. \r\n\n </li><li><strong>LM000006</strong> Borrower is not indicated to be in Imminent Default and the loan is insufficietly delinquent. \r\n\n </li><li><strong>LM000018</strong> Modification results in P&I increase. \r\n\n </li><li><strong>LM000019</strong> Modified UPB is less than Current UPB. \r\n\n </li><li><strong>LM000020</strong> The modification First Payment Due Date is same as prior modification First Payment Due Date. \r\n\n </li><li><strong>LM000021</strong> The Pre Modification UPB provided in the request does not match the Pre Modification UPB reported to Freddie Mac as of modification effective cycle. \r\n\n </li><li><strong>LM000022</strong> The Pre Modification UPB provided in the request does not match the Pre Modification UPB reported to Freddie Mac as of modification effective cycle. \r\n\n </li><li><strong>LM000023</strong> The Delinquent Interest from DDLPI to Modification Effective Date provided in the request does not match the Freddie Mac expected Delinquent Interest. \r\n\n </ul>\r\n\n<b>Sample Data Validation Messages</b><br/> <ul> <li><strong>RE001104</strong> Workout Program Type is required.\r\n\n </li><li><strong>RE001106</strong> Seller Servicer Number is required.\r\n\n </li><li><strong>RE001109</strong> Freddie Mac Loan Number is invalid.\r\n\n </li><li><strong>RE002001</strong> Requested Loan Number does not belong to Freddie Mac.\r\n\n </li><li><strong>RE002002</strong> Freddie Mac Loan Number does not belong to the Servicer.\r\n\n",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WorkoutOptionResponse"
},
"examples" : {
"Response 1 - Request with an eligibility decision" : {
"summary" : "Response 1 - Request with a new eligibility decision",
"description" : "Property value is available, hardship reason is Divorce",
"value" : "{\n \"message\": {\n \"aboutVersions\": {\n \"aboutVersion\": {\n \"aboutVersionIdentifier\": \"S1.0.01\",\n \"createdDatetime\": \"2026-06-18T14:51:34.619Z\",\n \"Description\": \"workoutoptions\"\n }\n },\n \"responseData\": {\n \"isRequestValid\": true,\n \"requestResponseIdentifier\": 743716,\n \"errorList\": [],\n \"responseWorkoutList\": [\n {\n \"loanIdentifier\": \"111111111\",\n \"servicerAccountIdentifier\": \"111111\",\n \"servicerLoanIdentifier\": \"ab03123490308\",\n
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/freddie-mac/refs/heads/main/openapi/freddie-mac-resolve-workout-options-openapi.json