Skip to main content
POST
Close a customer
Closes a customer. The customer can no longer hold new loans or accounts but historical records remain queryable. Closure cannot be undone — there is no “reopen” endpoint.
Customers with open loans or active savings accounts cannot be closed. Close those first.
Two equivalent forms — see Addressing a customer.

Path parameters

string
required
LMS id, or the externalId on the /external/{customer_external_id}/close form.

Request body

string
required
ISO-8601 YYYY-MM-DD. The effective date of closure.
integer
required
Closure reason code. Valid values are configured per deployment.

Examples

Response

200 OK returns the customer object with status="Closed".

Errors