Clients
Register a client
Register your identifier for a borrower: an id, an optional label, and no field for a person.
POST
A Client is registered before the first Loan names it. The registry holds your identifier, an optional label, and nothing else — a field for a name, a birth date or a document is refused by name. Clients carries the registry’s rules in full.
Path parameters
string
required
The Tenancy registering.
Body
string
required
Your identifier for the borrower: 1–64 characters of
a–z A–Z 0–9 - _. The value every Loan, Receipt and read names as client_id.string
Optional, at most 200 characters — the only free text the Platform stores about a Client, read by nothing. Stated as
"" or null it is one refusal: a registration that carries no label states none.Response
201 with the registration: id, tenant_id, created_at, and label only where one was stated — an unlabelled Client answers with no label key at all.
Registration is idempotent under the identifier, and the comparison is exact — against what is recorded now, so a correction moves what a replay is compared against:
A registration is never deleted: the storage holds no delete, and an identifier once registered stays resolvable for as long as its record needs naming.