List document types

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

string
length ≤ 10

Show only the document types for one loan type. Send an id from /api/v4/loan-types.

string
length ≤ 18

Show only the document types for one loan program. Send an id from /api/v4/loan-programs or /api/v4/loan-programs-internal.

⚠️ This narrows within the programs your company offers; it cannot reach past them. A program you do not offer returns an empty list rather than that program's document types.

Ad-hoc document types are included when you name a program. They belong to no program at all, so leaving them out would hide them from every program view at once — the portal includes them for the same reason. Use adHocOnly to see only those.

string
enum

Show only the document types one role has to supply. Use the labels exactly as they appear in a response's requiredBy.

Allowed:
integer
≥ 1

Show only the document types in one category. Send the category.id from a response.

boolean

Show only the document types a user can attach ad hoc.

boolean

Also show document types that have been switched off in the portal. Check active on each entry to tell them apart.

⚠️ If the same document name exists both switched on and switched off, you get two entries for it rather than one — one per state, matching the portal. Without this parameter you only ever see the switched-on one, so the count can go up by more than you expect.

Responses

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