List loan primary statuses

The top-level loan statuses your company has set up, in the same order
and with the same names as the status screen in the LendingWise portal.
Send an item's id as primaryStatusId when you create or update a
loan file on /api/v4/loans.

Each item's fileTypes lists the loan types the status can be used
with, as ids from /api/v4/loan-types. One status can be set up for
several loan types, and every status you get back is set up for at
least one. By default you only get the statuses that are switched on;
add includeInactive=true to get the switched-off ones too, which is
worth doing if you are displaying older loans that still point at one.

This is not the full list of primaryStatusId values the API will
accept.
It shows what the portal shows, and the portal leaves out a
status that is not set up for any switched-on loan type. POST and
PATCH /api/v4/loans still accept that status's id. So:

  • Use this list to build a picker. These are the statuses someone
    should be choosing from, in your company's own order.
  • Do not use it to check a value before sending it. An id missing
    from this list does not mean the API will refuse it. Send the value
    and read the reply.
  • An id you already hold stays valid — whether it came from
    /api/v4/loans, from a webhook, or from your own records, and
    whether or not it appears here. Please do not drop or "tidy up" ids
    just because this list leaves them out. That is intended behaviour,
    so you can rely on it.

Match on id, never on label. id is a permanent record id
(a PSID) and it is the only thing safe to compare against. label is
the name your company chose. It can be renamed at any time from your
own settings screen, and it is null when nobody ever named the
status
— that is common enough to plan for: 448 unnamed statuses
exist across 150 companies, and real loans point at them. So label
is fine to show on screen, and code that matches on it, or that assumes
it is never blank, will break on real data.

Order. Statuses come back in the order your company arranged them
in the portal, matching what the portal itself shows: by loan type,
then by your own display order within that loan type, then by name. A
status set up for several loan types takes its position from the first
one it belongs to. A status set up for no switched-on loan type has no
arranged position, so it comes last. The order carries meaning, so do
not re-sort it unless you specifically want a different one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to include the statuses your company has switched off, as well as the ones in use. Leave it out to get only the statuses that are switched on.

string
length ≤ 10

Narrows the list to the statuses set up for one loan type. Pass an id from /api/v4/loan-types, for example HMLO. A status that is not set up for any loan type never matches.

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 per_page for the size, and read
meta.pagination.perPage back rather than assuming it.

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 per_page=1 sizes a list before you fetch it, and
hasMore says whether more remain.

Responses

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