Get a loan file

Returns one loan file, with each block nested inside it. Sensitive
fields come back masked, in the shape for your kind of caller (see the
overview: company API keys get the production shapes and unmasked
dates of birth, unless a tenant key's PII setting is "No" (null) or
"Yes" (unmasked); people and MCP get one shape). You'll get a 404 if the loan is not on
your processing company's account, or, when your access is limited
to your branches, if it is filed under a branch you are not assigned
to. The two 404s are identical.

A deactivated loan file still answers 200. Archiving a file does
not put it out of reach: this call returns everything on it, with
active reading false instead of true (and the deprecated
activeStatus reading 0 instead of 1). So check active —
a deactivated file is not signalled by the status code, and never has
been. Changing one is refused: PATCH answers
409 RESOURCE_CONFLICT and says the loan file has been deactivated.
Archiving is one-way; there is no reactivation through this API.

Deactivated files are left out of GET /api/v4/loans by default.
Add includeArchived=1 to get them alongside the active ones, or
archiveState=active|archived|all to choose exactly one set. If you
send both, archiveState wins and includeArchived is ignored
rather than refused.

Every field is always there. When a field has no value you get
an explicit null — so the shape of the reply never changes from
one loan to the next. That matches PATCH, where sending null is
how you clear a field.

A field reads as null in any of these cases: nothing was ever
entered; the stored text is not a number but the field is numeric,
such as N/A, which is reported as null rather than invented as
0; or the stored value is 0 on one of the loan-terms money and
rate fields, or on loanLienPosition or propertyType, where a
genuine zero and "never entered" cannot be told apart. The back
office shows both as blank, and this API matches it. The useful
consequence: when a field is not null, the value in it is real.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Numeric loan-file id (LMRId).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json