Createorupdateclientrequest
addresses object[]
an array of addresses for this client
the type of the address, eg. home, office. Deprecated.
the city
the country
the automatically generated encoded ID for this item
the index of this address when there are multiple addresses assigned for a single entity
the latitude of the address point
the first line of the address
the second line of the address
the longitude of the address point
the encoded key of the entity to whom this address belongs, for example, the client of group
the postal (zip) code of the address
the region of the address
whether this address is marked to be deleted
client object
Description for client in CreateOrUpdateClientRequest
the date when the client was set to active, ie. an active account was created for them
the date when the client was approved
the encoded key of the client's branch
the encoded key of the client's assigned centre
the encoded key of the Mambu user associated with this client, eg. their credit officer
the date of birth of this client
clientRole object
Description for clientRole in ClientApiV1
the automatically generated encoded ID for this client or group type
the date when the client was exited or blacklisted
the date on which this client record was created
the email address of the client
the automatically generated encoded ID for this item
the first name of the client
the client's gender
Possible values: [MALE, FEMALE]
if this client is a member of a group, this number will increase by 1 each time they successfully close a loan as fully paid
a home contact number for this client
the ID for this client
the pattern that is used to generate the client ID
the date on which this client record was last modified
the last name of this client
the number of loans this client has opened and closed as fully paid as an individual
any middle names for this client
migrationEvent object
Description for migrationEvent in ClientApiV1
the date on which the data import was made
the encoded key of this data migration event
the number of centres which were imported during the data migration
the number of clients which were imported as part of the data migration
the number of general ledger accounts which were imported as part of the data migration
the number of groups which were imported as part of the data migration
the number of loan repayment transations which were imported as part of the data migration
the number of loan transactions which were imported as part of the data migration
the number of loan accounts which were imported as part of the data migration
the number of savings accounts which were imported as part of the data migration
whether the data import was accepted, is still in a draft state, or was rejected and all data reverted
Possible values: [REVERTED, DRAFT, APPROVED]
the type of migration event
Possible values: [IMPORT, EXPORT]
a mobile contact number for this client
another mobile contact number for this client
any rich text notes about this client
portalPreferences object
Description for portalPreferences in ClientApiV1
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472Description for lastLoggedInDate in PortalPreferencesApiV1
Description for password in PortalPreferencesApiV1
Description for portalState in PortalPreferencesApiV1
Possible values: [DISABLED, ENABLED]
the language which should be used when communicating with this client
Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]
the encoded key of this user's proficle picture
the encoded key of the digital copy of this client's signature
the current state of this client
Possible values: [PENDING_APPROVAL, ACTIVE, INACTIVE, EXITED, BLACKLISTED, REJECTED]
customInformation object[]
custom information relating to this client
Description for customFieldID in CustomFieldValueRequest
Description for customFieldSetGroupIndex in CustomFieldValueRequest
Description for linkedEntityKeyValue in CustomFieldValueRequest
Description for value in CustomFieldValueRequest
a list of encoded keys of groups of which this client is a member
idDocuments object[]
an array of ID documents for this client
the encoded key of the client with which this ID document is associated
the ID
the type of document, eg. passport, ID card
the automatically generated encoded ID for this item
8a19b7057471f4af017472dc0fd80472the ID template associated with this kind of ID
if there is more than one ID document attached to a single entity, this number represents the index in the list of this particular document
the institution who provided this ID document, eg, Her Majesty's Passport Authority
whether this ID document is marked for deletion
the last day on which this document can be used
validUntilDTOdate object
Description for validUntilDTOdate in IdentificationDocumentApiV1
the day of the month
the month
the year
{
"addresses": [
{
"addressType": "string",
"city": "string",
"country": "string",
"encodedKey": "string",
"indexInList": 0,
"latitude": 0,
"line1": "string",
"line2": "string",
"longitude": 0,
"parentKey": "string",
"postcode": "string",
"region": "string",
"toBeDeleted": true
}
],
"client": {
"activationDate": "string",
"approvedDate": "string",
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"birthDate": "string",
"clientRole": {
"encodedKey": "string"
},
"closedDate": "string",
"creationDate": "string",
"emailAddress": "string",
"encodedKey": "string",
"firstName": "string",
"gender": "MALE",
"groupLoanCycle": 0,
"homePhone": "string",
"id": "string",
"idPattern": "string",
"lastModifiedDate": "string",
"lastName": "string",
"loanCycle": 0,
"middleName": "string",
"migrationEvent": {
"creationDate": "2024-07-29T15:51:28.071Z",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"mobilePhone1": "string",
"mobilePhone2": "string",
"notes": "string",
"portalPreferences": {
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"lastLoggedInDate": "string",
"password": "string",
"portalState": "DISABLED"
},
"preferredLanguage": "PORTUGESE",
"profilePictureKey": "string",
"profileSignatureKey": "string",
"state": "PENDING_APPROVAL"
},
"customInformation": [
{
"customFieldID": "string",
"customFieldSetGroupIndex": 0,
"linkedEntityKeyValue": "string",
"value": "string"
}
],
"groupKeys": [
"string"
],
"idDocuments": [
{
"clientKey": "string",
"documentId": "string",
"documentType": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"identificationDocumentTemplateKey": "string",
"indexInList": 0,
"issuingAuthority": "string",
"toBeDeleted": true,
"validUntil": "string",
"validUntilDTOdate": {
"dayOfMonth": 0,
"monthOfYear": 0,
"year": 0
}
}
]
}