Model MatchHelp

Loans

Get loan by ID

getapi.modelmatch.com/v1/loans/{id}

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Loan ID

Responses

200objectLoan detail
Show attributes
dataobjectrequired
Show child attributes
apnstring | null
borrowerNamestring | null
borrowerStatusenum | null
Options:CurrentPSALEPWNLOPWCLOC_PWNLOC_PWCLOR_CWNLOR_CWCLOE_CWNLOE_CWCLOREO_CWNLOREO_CWCLOUNK_NOORIGUNK_PWNLOUNK_PWCLOnull
brokerNamestring | null

Mortgage broker as written on the loan document, when third-party originated.

brokerNmlsIdstring | null
builderNamestring | null

Builder named on a sale of this property (new construction); the hasBuilder predicate.

buyer1FirstMiddlestring | null

First buyer's first + middle name (an entity's whole name, with no last).

buyer1Laststring | null

First buyer's last name.

buyer2FirstMiddlestring | null

Second buyer's first + middle name.

buyer2Laststring | null

Second buyer's last name.

citystring | null
coListAgentEmailstring | null

Co-listing agent email, same rule.

coListAgentIdstring | null

Co-listing agent id, same rule.

coListAgentNamestring | null

Co-listing agent: the agent record's name when the keys resolve to one agent, else as the recorded it.

coListAgentPhonestring | null

Co-listing agent direct phone, same rule.

companyNamestring | null
companyNmlsIdstring | null
conformingboolean | null
coordinatesobject | null
Show child attributes
latnumberrequired
lonnumberrequired
employerNamestring | null

Employer at the time of the loan (the LO's company then), as recorded. Not companyName, the funding company on the document.

employerNmlsIdstring | null

NMLS id of employerName.

fipsstring | null
idstringrequired
interestRatenumber | null
interestRateTypestring | null

Recorded rate type (e.g. FIXED, ADJUSTABLE); null when not on file.

lenderIdstring | null

Normalized lender id — the value the lender filter takes.

lenderNamestring | null
listAgentEmailstring | null

Listing agent email, same rule.

listAgentIdstring | null

Listing agent id, same rule.

listAgentNamestring | null

Listing agent: the agent record's name when the keys resolve to one agent, else as the recorded it.

listAgentPhonestring | null

Listing agent direct phone, same rule.

listPricenumber | null
loanTermMonthsnumber | null
loanTypestring | null
mmPropertyIdstring | null
mortgageAmountnumber | null
mortgageDatestring | null
originatorEmailstring | nulldeprecated

DEPRECATED — ALWAYS NULL. Loan records carry no originator email field, so this is null on every loan; it is retained only for response-shape compatibility. To get a loan officer's email, take originatorNmlsId from this response and fetch the originator (GET /v1/originators/{nmlsId}), whose email field carries it — available for roughly 14% of loan officers.

originatorNamestring | null
originatorNmlsIdstring | null
salePricenumber | null
seller1FirstMiddlestring | null

First seller's first + middle name.

seller1Laststring | null

First seller's last name.

seller2FirstMiddlestring | null

Second seller's first + middle name.

seller2Laststring | null

Second seller's last name.

sellerNamestring | null
soldAgentEmailstring | null

Buyer's agent email — the agent record's email (GET /v1/agents/{id}); null when soldAgentId is.

soldAgentIdstring | null

Buyer's agent id (GET /v1/agents/{id}) when the keys resolve to one agent.

soldAgentNamestring | null

Buyer's agent: the agent record's name when the loan's agent keys resolve to one agent, else as the recorded it; lowercase.

soldAgentPhonestring | null

Buyer's agent direct phone — the agent record's phone; null when soldAgentId is.

statestring | null
streetAddressstring | null
titleCompanyNamestring | null

Title company name.

transactionDatestring | null
transactionTypestring | null
zipCodestring | null
buyersnull[] | null
downPaymentnull
employersAtTimeOfLoanstring[] | null
equitynumber | null
estimatedPaymentnumber | null
homeValuenumber | null
listAgentnull
ltvnumber | null
mmSaleIdstring | null
propertyUseCodestring | null
recordingDatestring | null
sellersnull[] | null
soldAgentnull
titleCompanynull
404objectLoan not found
413objectResponse payload too large