> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codaclean.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Scopes

> Les scopes déterminent ce que votre clé API est autorisée à faire.

Codaclean attribue à chaque clé API un ensemble de scopes.

Chaque endpoint exige un scope, indiqué sur sa page de référence.

Sans le scope requis, l'appel renvoie `403` avec le code `forbiddenScope`.

| Scope              | Autorise à                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------- |
| `customers:read`   | Rechercher et consulter des clients, lister les banques et les secrétariats sociaux.        |
| `customers:write`  | Créer et modifier des clients, ajouter des comptes bancaires et des secrétariats sociaux.   |
| `customers:delete` | Archiver des clients, désactiver des comptes bancaires et retirer des secrétariats sociaux. |
| `mandates:read`    | Rechercher et consulter des mandats.                                                        |
| `mandates:write`   | Demander des mandats CODA et CODB.                                                          |
| `files:read`       | Lister les fichiers CODA et CODB, et confirmer leur téléchargement.                         |
| `files:write`      | Obtenir les identifiants nécessaires à l'envoi de fichiers CODA et CODB.                    |

## Scopes par défaut

Sauf configuration contraire de Codaclean, une clé API ne dispose que des scopes de lecture : `customers:read`, `mandates:read` et `files:read`.

Les scopes d'écriture et de suppression sont toujours attribués explicitement.

Pour obtenir d'autres scopes, [contactez Codaclean](https://codaclean.be/fr-be/contact).

## Restrictions imposées par la fiduciaire

Une fiduciaire peut restreindre les scopes de votre clé API pour ses propres données. Elle peut seulement les réduire, jamais les étendre.

Lorsque la fiduciaire retire un scope, les appels concernés renvoient `forbiddenScope`, mais uniquement pour les utilisateurs de cette fiduciaire.

<Note>
  Toute modification de scope prend effet en une minute environ.
</Note>

## Endpoints sans scope

`POST /token` et `GET /hello` ne nécessitent aucun scope.