How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Freddie Mac Affordable Check

Help low-income borrowers choose the optimal mortgage path with an early look at Freddie Mac affordable product eligibility prior to submitting a full application to Loan Product Advisor®.

Freddie Mac Affordable Check is one of 20 APIs that Freddie Mac publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Mortgage and Origination. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 20 schemas. It is described by OpenAPI 3.0.1, at version 2.0.0.

Requests are made against a single base URL, https://api-test.freddiemac.com/single-family/affordable-check-api/v2.

1 operations 1 paths 20 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.0
Base URL
https://api-test.freddiemac.com/single-family/affordable-check-api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Freddie Mac Affordable Check declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Affordable Check 1

Affordable Check is an easy way to compare borrower income against applicable AMI values to identify candidates for recommended affordable products.

POST
/requestBorrowerEligibilityData
Retrieve borrower data supporting affordable program eligibility.
requestEligibility body → 200400401404429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AffordableCheckAPIResponse_standardizedSubjectPropertyAddress (16 properties), AffordableCheckAPIResponse_defaultedData (12 properties), AffordableCheckAPIResponse_incomeLimitsData (11 properties), AffordableCheckAPIRequest (10 properties). Each schema is shown below with its type and property counts.

AffordableCheckAPIRequest
object
10 properties 7 required
AffordableCheckAPIResponse
object
8 properties 4 required
AffordableCheckAPIErrorResponse
object
3 properties 3 required
AffordableCheckAPIRequest_loanOriginationSystem
object
2 properties
AffordableCheckAPIRequest_inputSubjectPropertyAddress
object
Subject Property Address.
4 properties 2 required
AffordableCheckAPIRequest_subjectLoanData
object
5 properties 1 required
AffordableCheckAPIRequest_subordinateLoanData
object
2 properties
AffordableCheckAPIRequest_borrowerInformation_borrowerIncome
object
Total gross income for all borrowers on the loan
2 properties 2 required
AffordableCheckAPIRequest_borrowerInformation_borrowers
object
4 properties
AffordableCheckAPIRequest_borrowerInformation
object
3 properties 1 required
AffordableCheckAPIRequest_subjectPropertyData
object
4 properties 1 required
AffordableCheckAPIRequest_affordableProgramDetails
object
1 property
AffordableCheckAPIResponse_inputSubjectPropertyAddress
object
Subject Property Address provided by submitter
4 properties 2 required
AffordableCheckAPIResponse_standardizedSubjectPropertyAddress
object
Subject Property Address determined by geo-coding.
16 properties
AffordableCheckAPIResponse_incomeLimitsData
object
11 properties
AffordableCheckAPIResponse_loanLimitsData
object
5 properties
AffordableCheckAPIResponse_borrowerEligibilityMessage
object
2 properties
AffordableCheckAPIResponse_affordableProgramDetails
object
2 properties
AffordableCheckAPIResponse_defaultedData
object
Default values are used to access eligibility when the data is not provided in the Request.
12 properties
AffordableCheckAPIErrorResponse_details
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

freddie-mac-affordable-check-openapi.json Raw ↑

Other APIs Freddie Mac publishes across the network.

Freddie Mac Beyond ACE
Freddie Mac Cash Committing
Freddie Mac Cash Pricing
Freddie Mac Cash Settlement Purchase Statement
Freddie Mac Current Mortgage Snapshot
Freddie Mac Data Share
Freddie Mac Data Share Bid Tape
Freddie Mac Guarantor Committing
Freddie Mac Guarantor Pricing
Freddie Mac Guarantor Settlement Purchase Statement
Freddie Mac Income Limits
Freddie Mac Loan Closing Advisor Loan Submission
Where this information came from

This is an independent, third-party profile of Freddie Mac Affordable Check, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.