diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 161284049..3298e9739 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -488,6 +488,16 @@ var jqxhr = $.ajax({
Clients are people and businesses that have applied (or may apply) to an MFI for loans.
Field Descriptions |
| 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. |
| 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 doesnt suit the firstname,middlename,lastname structure. |
| externalId |
| A place to put an external reference for this client e.g. The ID another system uses. If provided, it must be unique. |
Mandatory Fields |
| firstname and lastname OR clientOrBusinessName , joinedDate, officeId |
| firstname and lastname OR fullname , joinedDate, officeId |