# ClientRole

Represents a client or group role.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**canGuarantee** | **boolean** | `TRUE` if clients with this client role can be used as guarantors, `FALSE` otherwise. | [optional] [default to undefined]
**canOpenAccounts** | **boolean** | `TRUE` if new accounts for this client type can be created, `FALSE` otherwise. | [optional] [default to undefined]
**clientType** | **string** | Indicated the account holder type. | [optional] [default to undefined]
**creationDate** | **string** | The creation date of the client role. | [optional] [readonly] [default to undefined]
**description** | **string** | The text description for this client role. | [optional] [default to undefined]
**encodedKey** | **string** | The encoded key of the client, which is unique and generated. | [optional] [readonly] [default to undefined]
**id** | **string** | The ID of the client role, which can be generated and customized - but must be unique. | [optional] [default to undefined]
**idPattern** | **string** | The pattern used in generating the client ID. | [optional] [default to undefined]
**name** | **string** | The name of the client role. | [optional] [default to undefined]
**requireID** | **boolean** | `TRUE` if identification documents must be provided for the client to be created, `FALSE` otherwise. Does not apply for groups. | [optional] [default to undefined]
**useDefaultAddress** | **boolean** | `TRUE` if the Mambu default address section is available, `FALSE` otherwise. | [optional] [default to undefined]

## Example

```typescript
import { ClientRole } from './api';

const instance: ClientRole = {
    canGuarantee,
    canOpenAccounts,
    clientType,
    creationDate,
    description,
    encodedKey,
    id,
    idPattern,
    name,
    requireID,
    useDefaultAddress,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)