Chaque document géré par CheckHub passe par un cycle de vie représenté par un statut. Comprendre ces statuts est essentiel pour construire une intégration robuste, car ils déterminent l'état dans lequel se trouve un document et les actions qui peuvent ou doivent être entreprises.
Fonctionnement des statuts
Chaque statut de document comporte trois composants :
- Code — un identifiant numérique (ex.
100,400,901) utilisé dans l'API.
- Nom — une constante lisible (ex.
REQUESTED_BY_ADMIN,EXPIRED) qui décrit le statut spécifique.
- Méta-statut — un regroupement de niveau supérieur (ex.
REQUESTED,PENDING,VALIDATED,ERROR) qui catégorise les statuts en grandes phases du cycle de vie.
Le méta-statut est utile lorsque vous souhaitez simplifier la logique de votre intégration. Au lieu de gérer chaque code de statut individuellement, vous pouvez vous baser sur le méta-statut pour couvrir les principales phases du cycle de vie du document.
Tableau de référence des statuts
Méta-statut | Code | Nom | Description |
REQUESTED | 100 | REQUESTED_BY_ADMIN | Le document a été demandé manuellement par un administrateur via l'interface CheckHub. |
REQUESTED | 101 | REQUESTED_BY_INTEGRATION | Le document a été demandé de manière programmatique via l'API ou une intégration. |
PENDING | 300 | WAITING_MANUAL_CHECK | Le document a été téléversé et est en attente de vérification manuelle par un administrateur. |
PENDING | 301 | WAITING_AUTO_CHECK | Le document a été téléversé et est en cours de traitement par une vérification automatique. |
PENDING | 302 | WAITING_UPLOADING_END | Le fichier du document est encore en cours de téléversement et n'a pas encore été entièrement reçu. |
VALIDATED | 400 | VALIDATED_BY_ADMIN | Le document a été vérifié et approuvé par un administrateur. |
VALIDATED | 403 | VALIDATED_BY_AUTO_CHECK | Le document a été automatiquement validé par les vérifications automatiques du système. |
ERROR | 900 | REJECTED_BY_ADMIN | Le document a été vérifié et rejeté par un administrateur. |
ERROR | 901 | REJECTED_BY_AUTO_CHECK | Le document a été rejeté par les vérifications automatiques du système. |
ERROR | 905 | EXPIRED | Le document a dépassé sa période de validité et n'est plus considéré comme valide. |
Vue d'ensemble des méta-statuts
REQUESTED — Le document a été demandé mais n'a pas encore été téléversé par le collaborateur. C'est la phase initiale du cycle de vie du document.
PENDING — Le document a été téléversé et est en attente de traitement ou de vérification. Il n'est pas encore dans un état final.
VALIDATED — Le document a été accepté, soit manuellement par un administrateur, soit automatiquement par le système. C'est un état final réussi.
ERROR — Quelque chose s'est mal passé : le document a été rejeté (par un administrateur ou automatiquement) ou a expiré. Le collaborateur devra peut-être téléverser une nouvelle version.
Conseils pour les intégrateurs
- Lors du polling ou de la réception de webhooks, utilisez le code numérique pour une correspondance précise des statuts et le méta-statut pour une logique de cycle de vie plus large.
- Gérez toujours le statut
EXPIRED(905) : les documents peuvent passer automatiquement à cet état lorsque leur période de validité se termine, même s'ils étaient précédemment validés.
- Le méta-statut
PENDINGcouvre plusieurs sous-états — assurez-vous que votre intégration prend en compte le fait qu'un document peut rester dans cet état pendant son téléversement, sa vérification automatique ou en attente de vérification manuelle.