Read a loan file's custom field values

The custom field values stored on one loan file.

Every field placed on the loan file comes back, answered or not. A
field nobody has filled in is present with value: null rather than
left out, so one call is enough to render a complete form. A null
therefore means "not answered on this loan" — never "no such field".

Each item is just id, key and value. key is there to make a
response readable, not to match on — it is built from the label and
changes if the field is renamed. To render or interpret an answer you
need the field's label, type and options — call
/api/v4/custom-fields once and join on id. Those definitions are
the same for every loan, so they are not repeated here.

The shape of value depends on the field's type. Checkboxes and
multi-selects come back as an array of the chosen options; an empty
array means the field was answered with nothing ticked, which is
different from null. Dates come back as YYYY-MM-DD. Money and
percentages may come back as strings. File fields come back as a
numeric storage id, not a link.

⚠️ SSN fields and a tenant API key on "No". An SSN-type field reads as stored
for every caller, except a tenant API key whose PII setting (chosen when it was
generated) is "No": it reads every SSN-type value as null. Such a key may send
that null back; it is ignored rather than clearing the answer.

⚠️ This is the loan's copy. A field whose placement is loanAndProfile
also has a separate value on the borrower profile. They are different
records and can hold different answers, so this tells you nothing about
the borrower's.

Function fields are calculated, and calculated fresh on every read.
A Function field's value is derived from other fields on the loan, so it
is never stored and never cached here — asking for it recalculates it
from whatever the other fields currently hold. Its value is typed by
what the formula returns:

Formula returnsvalue
A date"YYYY-MM-DD"
Moneya number, e.g. 125000.50
A numbera number, e.g. 6 or 2.75
Yes/Notrue or false
Nothing — an input is blank, or a division by zeronull

A null on a Function field means the formula had nothing to work with,
which is a real answer and not a failure.

⚠️ Calculation happens in the main LendingWise application. If that
call cannot be completed, this endpoint answers 502 rather than
returning the loan with null in place of the calculated values. That
is deliberate: a null would be indistinguishable from "not answered",
and you would have no way to tell a real blank from a figure we simply
could not produce. A 502 here is usually temporary.

A loan id you cannot see answers 404, whether it does not exist,
belongs to another company, or is filed under a branch you are not
assigned to — these are deliberately the same answer.

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

The loan file id.

Query Params
integer
≥ 1

Which page to return, counting from 1. Defaults to page 1.

Leaving this off does not return every row — every list on this API
is paged. See perPage for the size, and read
meta.pagination.perPage back rather than assuming it.

⚠️ One exception: the reference and directory lists (loan types, loan
programs, statuses, sub-statuses, brokers, loan officers, branches,
back-office employees) answer a company API key with every row and
ignore this parameter. People and MCP are paged there too.

integer
1 to 100

How many rows you want per page, from 1 to 100.

Omitted, it falls back to a server-configured default (25 today).
Read the size actually applied from meta.pagination.perPage rather
than assuming this number — it is configuration, not contract, and it
has already changed once.

The number of rows in data is therefore the size of the PAGE, never
of the list. meta.pagination.total is the size of the whole list, so
a single call with perPage=1 sizes a list before you fetch it, and
hasMore says whether more remain.

⚠️ On the reference and directory lists a company API key gets every
row and this parameter is ignored, a value above 100 included.

integer
1 to 100
deprecated

Deprecated — use perPage. Removed on a date announced in the API
changelog, 90 days after the announcement; until then it is accepted and
means exactly what perPage means.

A request that sends it gets a Deprecation response header. Sending
both names with different values is a 422 naming both; with the same
value it is one value. A bad value is reported under per_page, the
name you sent.

⚠️ On the reference and directory lists a company API key gets every
row: this parameter is ignored there, with no Deprecation header.

Responses

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