List a loan's document checklist

Every document this loan needs — the list you see on the loan file's
Docs tab. This is the one call to make before showing someone a
document-collection screen: each entry carries everything needed to
render it, and its id is exactly what the upload endpoint accepts.

Empty slots are the point. A document with nothing uploaded against
it is the most important row here, not something to skip. This is a
to-do list.

Hidden entries are returned, not left out. When a document does not
currently apply to this loan — because of its loan program, its status,
or something about the borrower — it comes back with hidden: true
rather than disappearing. The portal does the same thing: it hides the
row but still counts it. If you drop them, your completion percentages
will not match what the lender sees.

notRequired and hidden are different things. notRequired means
someone excused this document on this loan. hidden means the loan's
own details mean it does not currently apply. Neither is a status, and a
document can be neither, either, or both.

role is optional, and leaving it out is not neutral. In the portal
this list is always filtered by whoever is looking. An API key is nobody
in particular, so without role you get more than any single portal
user would see
. Each entry also lists its own requiredBy, so you can
filter on your side without calling again.

id is an opaque code, and it belongs to this loan. Send it back
as-is. Do not store it: a lender editing a document type from inside a
loan quietly re-keys the slot, and the code is built to survive that
only if you fetch it fresh from here.

This call never changes anything.

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
string
enum

Show only the documents this role is expected to supply. Leave it out to get everything.

Allowed:
Responses

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