Read a borrower profile's custom field values

The custom field values stored on one borrower profile.

⚠️ These are not a loan's answers. A field shown on both the loan
file and the borrower profile holds two separate records, which can
hold different answers. This endpoint tells you nothing about any loan.

{id} is the borrower id, not a loan id.

Every field on the profile comes back, answered or not — an
unanswered one is present with value: null. Each item is id, key
and value; call /api/v4/custom-fields once and join on id for the
label, type and options.

⚠️ A tenant API key whose PII setting is "No" reads every SSN-type field as
null, and its null sent back on one is ignored rather than clearing it.

⚠️ A null can also mean the borrower has no record for that part of
the profile at all. Background, experience, assets and entity details
are stored separately, and a borrower may have none of one. There is
nothing to fix in either case.

⚠️ A Function field always reads null here, on every borrower.
Function fields are calculated from a loan's figures, and the
calculation has no borrower equivalent — there is nothing to derive one
from. So a field id that returns a number on
GET /api/v4/loans/{id}/custom-fields returns null here, and that is
the correct answer rather than missing data. ⭐ It also means this
endpoint never answers 502 for that reason: nothing is calculated, so
there is nothing to be unavailable.

A borrower you cannot see answers 404, whether it does not exist or
belongs to another company. When your access is limited to your
branches, you reach a borrower only through a loan you can reach, an
archived one included; a borrower with no loan at all answers 404
too.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The borrower id (a client id) — not a loan id.

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.

Responses

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