Every document type your company collects — the list you see in the
portal under Settings → Required Docs & Conditions.
Read this to find out what already exists before you add a new type,
so you do not create a duplicate.
This is not the list for a particular loan. Which of these a given
loan actually asks for depends on that loan's own details — its loan
program, its branch, its status, the borrower. Ask for a specific
loan's documents on that loan's own endpoint instead. Use this one for
discovery, not for building a screen for one borrower.
One entry is one document type as you set it up, not one database
row. If you set up "Bank Statement" for three loan programs, you get
one entry here with three entries in loanPrograms — the same as
the one row you see in the portal. checklistModuleIds lists the underlying record
ids if you ever need to match this up with an export.
id is an opaque code. Send it back to us as-is; do not try to
read it, take it apart, or build one yourself. It is tied to your
company, so a code from one account will not work on another. Fetch it
fresh rather than storing it long-term.
An empty condition list means "applies to everything", not "applies
to nothing". This is the one thing worth reading twice. If
conditionalFilters.branches comes back empty, the document type applies to
every branch — not to none of them. The same holds for every list
under conditionalFilters: empty means unrestricted. A document type with no
filters at all is asked for on every loan of its loan type.
Only the document types for loan programs your company actually
offers. A document type set up for a loan program you no longer sell
is left out, exactly as the portal leaves it out. This matches what
Settings → Required Docs & Conditions shows with every filter on
"- All -" — that screen is scoped the same way, which is not obvious
from looking at it. Ad-hoc document types are always included, because
they are not tied to a loan program at all.
⚠️ If a type you expect is missing, check its loan programs against
/api/v4/loan-programs and /api/v4/loan-programs-internal — between
them those two list every program this applies to.
Only active document types. A type that has been made inactive in
the portal is not returned.
Order. Loan type first, then the display order you set in the
portal, then the document name — the same order the portal list uses.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

