List document statuses

The statuses your company uses to track a document — "Pending
Submission", "Pending Review", "Document OK", and any you have added
or renamed yourself.

Read this list rather than hard-coding status numbers. These are
set up per company. Your company can rename any of the ones we ship,
switch them off, or add its own, so the numbers are not the same
everywhere.

Two ids, and they answer different questions.

  • id is this status on your account. It is the value you will
    see on a document and the value you send back.
  • systemStatusId is the standard status it stands for, when it
    stands for one. If your company renamed "Pending Submission" to
    "Awaiting Borrower", that entry has your own id and a
    systemStatusId of 9.

A standard status your company has not renamed carries its own id in
both fields, so systemStatusId is filled in whenever the entry has a
standard meaning at all — whether it is a standard status or stands
in for one.

So: match on systemStatusId when you want to recognise a meaning
across different companies, and use id for anything you send back to
us. A status your company invented has no systemStatusId — it is
null, because it does not stand for a standard one, and that is the
only case where it is null.

By default you get the statuses currently in use. Add
?includeInactive=true to also get ones that have been switched off —
you will need those if you are showing a document's history, because
older documents can still be sitting in a status your company has
since retired.

Order. The order you set in the portal, then the status name.

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.

boolean
Defaults to false

Also return statuses that have been switched off. Older documents can still be in one.

Responses

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