Add entity members to a loan

Adds one or more members to the borrowing entity of a loan that
already exists.

Adding is its own request because memberId is required on
PATCH /api/v4/loans/{id} — an entry there has to name the stored
member it updates, so no shape there means "add". Each route does one
job: PATCH updates the members you name, and this route adds new
ones. Properties are split the same way, with
POST /api/v4/loans/{id}/properties.

Do not send memberId here. The platform assigns it, so sending one
is refused. Send only the member's own fields — anything belonging to
the loan, or to the entity itself, is refused rather than quietly
ignored.

A success is 201, and you get back the members this call created and
nothing else — a list, in the order you sent them, each carrying the
memberId the platform assigned. Send two members and you get two
entries; send one and you get a list of one, so there is no need to
check the count before reading the reply. The entity's other members are
not included; read those with GET /api/v4/loans/{id}.

⚠️ A company API key (a tenant API key or a legacy token) gets the
reply this API has always given instead: the WHOLE loan, in the shape
GET /api/v4/loans/{id} returns, with every member on it (the new ones
carry their memberId), and no meta.count. A retry with the same
Idempotency-Key returns the whole loan again and adds nothing.

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

Loan file id.

Body Params
entity
object
required
Headers
string
length ≤ 64

A key you generate — a UUID is the usual choice — that makes it safe to
retry this request after a timeout.

The problem it solves. If a call times out you cannot tell whether
it landed. Retrying without a key creates a SECOND record. Retrying with
the same key returns the original result instead, and creates nothing.

  • Same key, same body → the original result, plus Idempotency-Replayed: true.
  • Same key, different body → 409. That means a bug in your code, not
    a safe retry, so the request is refused rather than guessed at.
  • No key → exactly the behaviour this endpoint has always had. The header
    is optional and nothing changes for callers that omit it.

A replay reflects the record's CURRENT state, not a byte-for-byte
copy of the original reply. If something else changed the record between
your first call and your retry, you see the change. We do this rather
than caching response bodies, because these replies carry borrower
personal data and we will not keep a copy of it at rest to serve a retry.

For the same reason a replay does not repeat meta.automation — the
automation ran once, on the original call, and saying otherwise would be
a lie about what just happened.

Keys are scoped to your own account and kept for 24 hours. After
that the key is forgotten and reusing it creates a new record, so retry
within a day. A key is at most 64 characters.

Responses

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