Skip to main content
A customer is a borrower record. Every loan in the system is tied to exactly one customer. New customers created via this API are Active immediately — there’s no pending state for partners to manage. The remaining lifecycle transition is just Active → Closed.

​
The customer object

​
string
Unique customer identifier. Treat as opaque.
​
string
Human-readable account number assigned at creation.
​
string
Optional client-assigned external ID. Useful for correlating to your own systems.
​
string
Status label (e.g. Pending, Active, Closed).
​
boolean
Whether the customer is currently active and can hold loans.
​
string
ID of the office (branch) the customer belongs to.
​
string
Display name of the office.
​
string
​
string
​
string
​
string
Computed full name.
​
string
​
string
​
string
ISO-8601 YYYY-MM-DD.
​
string
ISO-8601 YYYY-MM-DD. Present only after activation.
​
string
ISO-8601 YYYY-MM-DD.

​
Addressing a customer

Every resource-level customer endpoint accepts two equivalent path prefixes. Prefer the externalId form — it lets you drive integrations off the identifier you already store, with no client-side mapping back to a numeric LMS id. Both forms hit the same handlers and return identical responses. An unknown externalId returns 404 not_found.

​
Endpoints

Each row below has an equivalent form under /v1/customers/external/{customer_external_id}/... — substitute the prefix when addressing the customer by externalId.