Clients are people and businesses that have applied (or may apply) to an MFI for loans.
Clients can be created in Pending or straight into Active state.
| Field Description |
|---|
| accountNo If provided during client creation, its value is set as account no. for client account, otherwise an auto generated account no. is put in place based on the configured strategy. |
| externalId A place to put an external reference for this client e.g. The ID another system uses. If provided, it must be unique. |
| active Indicates whether this client is to be created as active client. If active=true, then activationDate must be provided. If active=false, then the client is created as pending. |
| activationDate The date on which the client became active. |
| firstname Facility to break up name into parts suitable for humans. |
| middlename Facility to break up name into parts suitable for humans. |
| lastname Facility to break up name into parts suitable for humans. |
| fullname Facility to set name of a client or business that doesn't suit the firstname,middlename,lastname structure. |
| mobileNo Optional: unique mobile number that is used by SMS or Mobile Money functionality. |
| staffId The staffId of the staff member dealing with the client office. The staff member is not specifically the loan officer. |
| savingsProductId Optional: Default overdraft savings account of client |
| datatables Facility to enrich client details. |