Request relief options and retention workouts via the API to Resolve, the integrated default management platform. Directly integrate to maintain your user experience and receive rapid, rules-based eligibility decisions without leaving your existing default management tool, enabling faster resolution for homeowners.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/resolve-retention"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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" : "3.0.0",
"info" : {
"title" : "Resolve Retention API",
"version" : "3.0.0"
},
"servers" : [ {
"url" : "https://api-test.freddiemac.com/singlefamily/v3/servicing/workoutservice/workout-service"
} ],
"security" : [ {
"bearerAuth" : [ ]
} ],
"tags" : [ {
"name" : "Resolve Retention",
"description" : "Get clear and actionable responses for retention workouts such as eligibility, trial approval, settlement and supporting data."
} ],
"paths" : {
"/api/v3/requestWorkout" : {
"post" : {
"tags" : [ "Resolve Retention" ],
"summary" : "Delivers real-time decisions and supporting data for Payment Deferrals, Flex Modifications, Forbearance, and Repayment Plan, including exception decisioning.",
"description" : "Submit single or bulk requests for borrower eligibility on Payment Deferrals, Flex Modifications, Forbearance, and Repayment Plan, including exception decisioning. In a single response, you’ll receive eligibility decisions, rationale, actionable messages and workout terms, if applicable. The API provides transparency into mortgage relief and speeds up case management.",
"operationId" : "requestWorkoutV3UsingPOST",
"requestBody" : {
"description" : "workoutServiceRequest",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WorkoutServiceRequest"
},
"examples" : {
"DelegatedReviewRequest" : {
"summary" : "Scenario 1 - Request for a delegated review",
"description" : "Exception Review Request Indicator is not populated",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"solicitationFlag" : "Y",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"hardshipReasons" : [ {
"hardshipReasonType" : "Other"
} ],
"propertyInfo" : {
"propertyConditionType" : "Abandoned",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC"
},
"premodHousingExpense" : [ {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ]
}
} ]
}
}
}
},
"FatalEligibilityError" : {
"summary" : "Scenario 2 - New Request for an exception review when fatal eligibility error is triggered",
"description" : "Exception Review Request Indicator is 'Y'",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"solicitationFlag" : "Y",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIndicator" : "Y",
"hardshipReasons" : [ {
"hardshipReasonType" : "Unemp"
} ],
"propertyInfo" : {
"propertyConditionType" : "Condemned",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC"
},
"premodHousingExpense" : [ {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ]
}
} ]
}
}
}
},
"InquireStatusProgress" : {
"summary" : "Scenario 3 - Inquire on the status of in progress exception review request",
"description" : "Valid Exception Review Request Identifier for the loan is populated",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIdentifier" : "FX012345"
}
} ]
}
}
}
},
"InquireStatusDecision" : {
"summary" : "Scenario 4 - Inquire on the status of decisioned exception review request",
"description" : "Valid Exception Review Request Identifier for the loan is populated",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T14:00:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIdentifier" : "FX012345"
}
} ]
}
}
}
},
"FlexModifications(FLXM)forTrialApproval" : {
"summary" : "Scenario 5 - Request for a Flex Modifications (FLXM) for Trial Approval",
"description" : "Valid Flex Modifications (FLXM) workout request for Trial Approval",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"solicitationFlag" : "Y",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIndicator" : "N",
"hardshipReasons" : [ {
"hardshipReasonType" : "Unemp"
} ],
"propertyInfo" : {
"propertyConditionType" : "Abandoned",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC"
},
"premodHousingExpense" : [ {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ]
}
} ]
}
}
}
},
"DisasterFlexModifications(FLXDM)forTrialApproval" : {
"summary" : "Scenario 6 - Request for a Disaster Flex Modifications (FLXDM) for Trial Approval",
"description" : "Valid Disaster Flex Modifications (FLXDM) workout request for Trial Approval",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXDM",
"solicitationFlag" : "Y",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIndicator" : "N",
"hardshipReasons" : [ {
"hardshipReasonType" : "Disaster"
} ],
"disasterInfo" : {
"disasterDeclarationDate" : "11-11-2021"
},
"propertyInfo" : {
"propertyConditionType" : "Abandoned",
"propertyUsageType" : "PR",
"propertyOccupancyType" : "OC"
},
"premodHousingExpense" : [ {
"housingExpensePaymentAmount" : 150,
"housingExpenseType" : "HomeownersInsurance"
}, {
"housingExpensePaymentAmount" : 200,
"housingExpenseType" : "RealEstateTax"
} ]
}
} ]
}
}
}
},
"FlexModifications(FLXM)forAppeals" : {
"summary" : "Scenario 7 - Appeal on a Flex Modification that was Trial Approved then cancelled ",
"description" : "Servicer can appeal to restore a prior approved Trial period that was cancelled using the Appeal Review Request Identifier",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIndicator" : "N",
"workoutCommentsText" : "Approved Trial was cancelled by accident",
"appealReviewRequestIdentifier" : 1
}
} ]
}
}
}
},
"FlexModifications(FLXM)forAppealsInvalid" : {
"summary" : "Scenario 8 - Invalid Appeal request on a Flex Modification ",
"description" : "For Retention workouts, Workout Comments are mandatory for an Appeal request",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2022-01-26T13:45:00.000Z",
"description" : "Retention"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutReportingStatusType" : "TPAReq",
"workoutProgramType" : "FLXM",
"servicerAccountIdentifier" : "111111",
"loanIdentifier" : "111111111",
"exceptionReviewRequestIndicator" : "N",
"workoutCommentsText" : "",
"appealReviewRequestIdentifier" : 2
}
} ]
}
}
}
},
"ForbearanceRequest(FB)forApproval" : {
"summary" : "Scenario 9 - Request for a Forbearance (FB) for approval ",
"description" : "Valid Forbearance (FB) request",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"description" : "Retention",
"createdDatetime" : "2025-09-23T13:45:00.000Z"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutProgramType" : "FB",
"workoutReportingStatusType" : "FRBReq",
"loanIdentifier" : "111111111",
"servicerAccountIdentifier" : "111111",
"exceptionReviewRequestIndicator" : "N",
"forbearanceInfo" : {
"forbearanceExtensionIndicator" : "N",
"forbearanceStartDate" : "09-01-2025",
"paymentDuringForbearance" : 1000,
"forbearanceEndDate" : "11-30-2025"
},
"collectionInfo" : [ {
"collectionContactDate" : "05-01-2025",
"collectionContactMode" : "Phone",
"collectionInfoCategory" : "RightPartyContact"
}, {
"collectionContactDate" : "05-01-2025",
"collectionContactMode" : "Email",
"collectionInfoCategory" : "LastRightPartyContact"
} ],
"servicerContactInfo" : {
"servicerEmailAddress" : "abcd@mmail.com",
"servicerContactNumber" : "123-456-7890",
"servicerContactName" : "Joe Mars"
},
"propertyInfo" : {
"grossRentalIncome" : 100,
"propertyConditionType" : "N/A",
"propertyUsageType" : "PR"
},
"premodHousingExpense" : [ {
"housingExpenseType" : "CurrentTIAS",
"housingExpensePaymentAmount" : 107
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Unemp"
} ]
}
} ]
}
}
}
},
"RepaymentPlanRequest(RP)forApproval" : {
"summary" : "Scenario 10 - Request for a Repayment Plan (RP) for approval ",
"description" : "Valid Repayment Plan (RP) request for approval",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"description" : "Retention",
"createdDatetime" : "2025-09-03T13:45:00.000Z"
}
},
"requestData" : {
"workoutList" : [ {
"externalData" : {
"workoutProgramType" : "RP",
"workoutReportingStatusType" : "RPReq",
"loanIdentifier" : "111111111",
"servicerAccountIdentifier" : "111111",
"exceptionReviewRequestIndicator" : "N",
"borrowerResponsePackageReceivedDate" : "09-01-2025",
"repaymentPlanInfo" : {
"repaymentPlanStartDate" : "10-01-2025",
"repaymentPlanEndDate" : "01-31-2026",
"monthlyRepaymentPlanAmount" : "700.00",
"totalOutstandingAmount" : "2800.00",
"areDelinquentTaxesPaidAndEscrowSetup" : "Y"
},
"collectionInfo" : [ {
"collectionContactDate" : "05-01-2025",
"collectionContactMode" : "Phone",
"collectionInfoCategory" : "RightPartyContact"
}, {
"collectionContactDate" : "05-01-2025",
"collectionContactMode" : "Email",
"collectionInfoCategory" : "LastRightPartyContact"
} ],
"servicerContactInfo" : {
"servicerEmailAddress" : "abcd@mmail.com",
"servicerContactNumber" : "123-456-7890",
"servicerContactName" : "Joe Mars"
},
"propertyInfo" : {
"propertyConditionType" : "N/A",
"propertyUsageType" : "PR"
},
"partyInfo" : {
"party" : [ {
"borrowerInfo" : {
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 205,
"incomeType" : "GrossMonthlyIncome"
}
} ]
},
"borrowerType" : "Primary"
}, {
"borrowerInfo" : {
"currentIncomeItem" : [ {
"currentIncomeItemDetail" : {
"currentIncomeMonthlyTotalAmount" : 105,
"incomeType" : "GrossMonthlyIncome"
}
} ]
},
"borrowerType" : "Secondary"
} ]
},
"premodHousingExpense" : [ {
"housingExpenseType" : "CurrentTIAS",
"housingExpensePaymentAmount" : 107
} ],
"hardshipReasons" : [ {
"hardshipReasonType" : "Other",
"expectedDateOfHardshipResolution" : "10-31-2025",
"reasonForExtenuatingCircumstances" : "Homeowner was temporarily furloughed by govt job"
} ]
}
} ]
}
}
}
}
}
}
},
"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 insufficiently delinquent. \r\n\n </li><li><strong>LM000017</strong> Requested Trial Plan is greater than 12 months. \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 </li><li><strong>LM000031</strong> Requested Trial Plan is less than 3 months. </li></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 </li><li><strong>RE002004</strong> Loan has a workout already in progress.\r\n\n </li><li><strong>RE002005</strong> Loan is in Closed status. Please review request and submit to Freddie Mac for non-delegated review if necessary.</li></ul>",
"content" : {
"*/*" : {
"schema" : {
"$ref" : "#/components/schemas/WorkoutServiceResponse"
},
"examples" : {
"Response 1 - Request for a delegated review" : {
"summary" : "Response 1 - Request for a delegated review",
"description" : "Exception Review Request Indicator is not populated",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2025-09-24T08:58:05.698Z",
"description" : "Retention"
}
},
"responseData" : {
"isRequestValid" : true,
"requestResponseIdentifier" : 1,
"responseWorkoutList" : [ {
"loanIdentifier" : "111111111",
"servicerAccountIdentifier" : "111111",
"workoutReportingStatusType" : "TPAReq",
"isValid" : false,
"errorWorkoutList" : [ {
"workoutErrorCode" : "RE001183",
"workoutErrorDescription" : "Exception Review Request Indicator is required.",
"workoutErrorType" : "Fatal"
}, {
"workoutErrorCode" : "RE002030",
"workoutErrorDescription" : "Reason for Extenuating Circumstances is required.",
"workoutErrorType" : "Fatal"
} ],
"workoutProgramResponses" : [ {
"workoutProgramType" : "FLXM"
} ]
} ]
}
}
}
},
"Response 2 - New Request for an exception review when fatal eligibility error is triggered" : {
"summary" : "Response 2 - New Request for an exception review when fatal eligibility error is triggered",
"description" : "Exception Review Request Indicator is 'Y'",
"value" : {
"message" : {
"aboutVersions" : {
"aboutVersion" : {
"aboutVersionIdentifier" : "S3.0.01",
"createdDatetime" : "2025-09-23T15:58:13.234Z",
"description" : "Retention"
}
},
"responseData" : {
"isRequestValid" : true,
"requestResponseIdentifier" : 2,
"responseWorkoutList" : [ {
"loanIdentifier" : "111111111",
"servicerAccountIdentifier" : "111111",
"workoutReportingStatusType" : "TPAReq",
"isValid" : true,
"workoutProgramResponses" : [ {
"workoutProgramType" : "FLXM",
"isEligible" : false,
"messageWorkoutList" : [ {
"workoutMessageCode" : "LM000018",
"workoutMessageDescription" : "Modification results in P&I increase. Pre Modification P&I is $200.00 and Post Modification P&I is $537.30.",
"workoutMessageType" : "Fatal"
}, {
"workoutMessageCode" : "LM000250",
"workoutMessageDescription" : "Data and other information contained on this web page and/or other Output provided by or through Resolve (including any associated documents or correspondence such as e-mail): (i) are not a consumer report; (ii) do not constitute or evidence Freddie Mac’s participation in a credit decision; and (iii) may only be shared or distributed as permitted by the Freddie Mac Seller/Servicer Guide Section 2401.1 and applicable Purchase Documents.",
"workoutMessageType" : "Informational"
}, {
"workoutMessageCode" : "RE002018",
"workoutMessageDescription" : "Workout has been submitted for exception review. Updates to exception review submission cannot be made during review process. Please visit Resolve for more information.",
"workoutMessageType" : "Informational"
} ],
"postWorkoutData" : {
"loanInterestRateAtModification" : 0.0325,
"loanModificationMaturityTermCount" : 480,
"ltvRatioPercent" : 288.44,
"loanPrincipalAndInterestPaymentAmountAtModification" : 537.3,
"interestBearingUPBAmountAtModification" : 144224.41,
"nonInterestBearingUPBAmountAtModification" : 61810.46,
"loanGrossUPBAmountAtModification" : 206034.87,
"totalMonthlyHousingExpenseAmountAtModification" : 887.3,
"monthlyNetRentalIncome" : 0,
"paymentRateChangeEffectiveDate" : "01-01-2026",
"paymentRateChangeEffectiveDueDate" : "02-01-2026",
"modificationTrialPlanEffectiveDate" : "11-01-2025",
"modificationTrialPlanEndDate" : "01-31-2026",
"loanMaturityDateAtModification" : "01-01-2066",
"workoutServicerProposalDecisionD
# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/freddie-mac/refs/heads/main/openapi/freddie-mac-resolve-retention-openapi.json