Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.api.bsa.ai/llms.txt

Use this file to discover all available pages before exploring further.

A customer is a borrower record. Every loan in the system is tied to exactly one customer. Customers belong to an office (branch) and can have a status lifecycle that progresses through pending → active → closed.

​
The customer object

​
id
string
Unique customer identifier. Treat as opaque.
​
accountNo
string
Human-readable account number assigned at creation.
​
externalId
string
Optional client-assigned external ID. Useful for correlating to your own systems.
​
status
string
Status label (e.g. Pending, Active, Closed).
​
active
boolean
Whether the customer is currently active and can hold loans.
​
officeId
string
ID of the office (branch) the customer belongs to.
​
officeName
string
Display name of the office.
​
firstname
string
​
middlename
string
​
lastname
string
​
displayName
string
Computed full name as LMS presents it.
​
mobileNo
string
​
emailAddress
string
​
dateOfBirth
string
ISO-8601 YYYY-MM-DD.
​
activationDate
string
ISO-8601 YYYY-MM-DD. Present only after activation.
​
submittedDate
string
ISO-8601 YYYY-MM-DD.

​
Endpoints

MethodPathPurpose
POST/v1/customersCreate a customer
GET/v1/customersList customers (paginated)
GET/v1/customers/{customer_id}Get one
PUT/v1/customers/{customer_id}Update attributes
DELETE/v1/customers/{customer_id}Delete (only in pending state)
POST/v1/customers/{customer_id}/activateActivate a pending customer
POST/v1/customers/{customer_id}/closeClose an active customer