List every document on a loan

Everything this loan actually has — not just the documents filed into a
configured slot. Direct uploads, e-signed packages, reports we fetched
from third-party providers, inspection reports, and inbound email
attachments nobody has filed yet, all in one list.

The document checklist tells you what this loan still needs. This
tells you what it has.

This list is paged, and it is paged whether or not you ask. A call
with no page or perPage returns the first page at the server's
default size, not every document. Read meta.pagination.total for the
loan's full count and hasMore for whether more remain — a loan that
has accumulated years of correspondence can hold far more documents
than one response should carry.

Every entry says whether its contents can actually be retrieved, and
you should read that flag.
It is not decoration. Several kinds of
document on a loan hold no file we can serve: a report a provider has
not returned yet, a link to a document in Google Drive or Dropbox, an
entry whose file was never stored. They look completely ordinary
otherwise, so without retrievable the download call fails
unpredictably on rows you had no reason to doubt. Where it is false,
retrievalNote says why in one sentence.

⚠️ This list cannot see inside the document store. A file that has gone
missing from the store is reported retrievable: true until a download
of it finds it missing; from then on the list reports it false. Treat
a 404 with details.reason DOCUMENT_FILE_MISSING from the content
endpoint as final for that document.

id is an opaque code, and it is the one the download endpoint
takes.
Send it back as-is. Do not store it and do not try to read
anything out of it — fetch it fresh from this call. It is also the same
code the document checklist returns for a file filed into a slot, so
the two calls agree about what a document is.

slot is set only for a document filed into a checklist slot, and
it is the same code that checklist returns for that slot.

⚠️ This is not the same set the loan's Docs tab shows, in both
directions.
Fewer: generated packages and Document Wizard documents
are absent, because they have no stored record until something produces
them — there is nothing to list. More: this applies none of the
category filtering the portal's own screens apply to each other.

Nothing here can be changed through the API, and there is no delete
anywhere in this area.

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