Clientrolefullapiv1

the type of client or group as defined in Mambu in Administration > General Settings > Client Types

canGuaranteebooleanrequired

whether this client type can guarantee loans

canOpenAccountsbooleanrequired

whether this client type can open accounts

clientTypestringrequired

which entity this type is valid for, either CLIENT or GROUP

Possible values: [GROUP, CLIENT]

createdByUserKeystring

if this client type was not one of the defaults provided by Mambu the encoded key of the user who created it will be displayed here

creationDatestring<date-time>required

timestamp of when this group was created

descriptionstring

description of this client type as provided through the Mambu UI

encodedKeystringrequired

a unique ID for this client type

idstringrequired

the machine-readable ID for this client type

idPatternstring

the pattern used to generate IDs for clients of this type, @ represents a random letter, # indicates a random number, $ represents a random letter or number

indexnumberrequired

if more than one role is assigned to this client, for example, if they are members of multiple groups, this number represents the index in the list

namestringrequired

the human-readable name of this client type

requireIDbooleanrequired

whether ID is required for this client type

useDefaultAddressbooleanrequired

whether an address can be associated with clients of this type

Clientrolefullapiv1

{
  "canGuarantee": true,
  "canOpenAccounts": true,
  "clientType": "GROUP",
  "createdByUserKey": "string",
  "creationDate": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "encodedKey": "string",
  "id": "string",
  "idPattern": "string",
  "index": 0,
  "name": "string",
  "requireID": true,
  "useDefaultAddress": true
}