Clientrolefullapiv1

encodedKeystringrequired

a unique ID for this client type

namestringrequired

the human-readable name of this client type

idstringrequired

the machine-readable ID for this client type

clientTypestringrequired

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

Possible values: [GROUP, CLIENT]

creationDatestring<date-time>required

timestamp of when this group was created

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

canOpenAccountsbooleanrequired

whether this client type can open accounts

canGuaranteebooleanrequired

whether this client type can guarantee loans

requireIDbooleanrequired

whether ID is required for this client type

useDefaultAddressbooleanrequired

whether an address can be associated with clients of this type

indexnumberrequired

Description for index in ClientRoleFullApiV1

descriptionstring

description of this client type as provided through the Mambu UI

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

Clientrolefullapiv1

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