Clientsrolesconfiguration

Model representation of the clients roles configuration.

rolesConfiguration object[]required

List of all roles for available account holder types. Ordered by the account holder parameter if provided, ascending otherwise

Array [

defaultRole objectrequired

Represents the client role configuration.

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.

descriptionstring

The text description for this client role.

idstringrequired

The ID of the client role, can be generated and customized, unique.

idPatternstring

The pattern used in generating the client ID.

namestringrequired

The name of the client role.

requireIdentificationDocumentsboolean

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.

roles object[]

List of all client roles, order by their appearance in the yaml file.

Array [

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.

descriptionstring

The text description for this client role.

idstringrequired

The ID of the client role, can be generated and customized, unique.

idPatternstring

The pattern used in generating the client ID.

namestringrequired

The name of the client role.

requireIdentificationDocumentsboolean

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.

]

typestringrequired

Indicated the account holder type.

Possible values: [CLIENT, GROUP]

]

Clientsrolesconfiguration

{
  "rolesConfiguration": [
    {
      "defaultRole": {
        "canGuarantee": true,
        "canOpenAccounts": true,
        "description": "string",
        "id": "string",
        "idPattern": "string",
        "name": "string",
        "requireIdentificationDocuments": true,
        "useDefaultAddress": true
      },
      "roles": [
        {
          "canGuarantee": true,
          "canOpenAccounts": true,
          "description": "string",
          "id": "string",
          "idPattern": "string",
          "name": "string",
          "requireIdentificationDocuments": true,
          "useDefaultAddress": true
        }
      ],
      "type": "CLIENT"
    }
  ]
}