Skip to main content

Clientrole

Represents a client or group role.

canGuaranteeboolean

TRUE if clients with this client role can be used as guarantors, FALSE otherwise.

canOpenAccountsboolean

TRUE if new accounts for this client type can be created, FALSE otherwise.

clientTypestring

Indicated the account holder type.

Possible values: [CLIENT, GROUP]

creationDatestring<date-time>

The creation date of the client role.

Example: 2016-09-06T13:37:50+03:00
descriptionstring

The text description for this client role.

encodedKeystring

The encoded key of the client, which is unique and generated.

idstring

The ID of the client role, which can be generated and customized - but must be unique.

idPatternstring

The pattern used in generating the client ID.

namestring

The name of the client role.

requireIDboolean

TRUE if identification documents must be provided for the client to be created, FALSE otherwise. Does not apply for groups.

useDefaultAddressboolean

TRUE if the Mambu default address section is available, FALSE otherwise.

Clientrole
{
"canGuarantee": true,
"canOpenAccounts": true,
"clientType": "CLIENT",
"creationDate": "2016-09-06T13:37:50+03:00",
"description": "string",
"encodedKey": "string",
"id": "string",
"idPattern": "string",
"name": "string",
"requireID": true,
"useDefaultAddress": true
}