Worked Example - Overview

Working examples help users bridge the gap between reading documentation and actually making a successful API call. Specifically they help users understand:

• What fields are truly required vs. optional in practice — The field reference table tells you what's required, but examples show you the minimum viable payload for a real scenario, so you're not guessing what you can leave out.
• How fields interact with each other — For instance, that first_time_homebuyer: true triggers affordability programs, or that loan_amount exceeding the conforming limit automatically triggers jumbo pricing without any extra flag. These cause-and-effect relationships are hard to convey in a field table alone.
• What the response actually looks like for their loan type — Each example includes a sample response so users know what fields to expect back, what they mean, and how to use them in their UI — like surfacing program_name to distinguish HomeReady from standard conventional, or mip_monthly for FHA loans.
• How to format field values correctly — Things like whether loan_term should be an integer or a string, that zipcode is a string not a number, or that loan_type is case-sensitive. These are the small mistakes that cause 400 errors and slow down integration.
• That the API handles complexity for them — Examples make it clear what the API derives automatically (LTV, state from zip, jumbo detection, AMI eligibility) so users don't over-engineer their request or send fields they don't need.
• How to adapt a working request to their scenario — Rather than building a payload from scratch, users can find the closest example, copy it, and make targeted changes — reducing integration time significantly.

For more use cases and value combinations, navigate through the example tabs on the right.