Types d'événements

Les charges utiles des webhooks décrivent une transition d'état d'un processus. Cette page documente le schéma de charge utile et l'énumération complète des valeurs lastEvent.

Schéma de charge utile

Champ	Type	Description
processId	string (UUID)	Identifiant de la transaction.
state	string	État actuel de la transaction. Actuellement : PROCESS_STATE_FINISHED.
result	string	Résultat du processus terminé. Présent lorsque state=PROCESS_STATE_FINISHED. Valeurs possibles : ok, expired, invalid_identity.
flow	string	Flux exécuté pour cette transaction (ex. : id, idtoken).
lastEvent	string	Dernier événement de la transaction. Retourné uniquement lorsque result=expired.
lastEventDescription	string	Description lisible de lastEvent. Retournée uniquement lorsque result=expired.

Vocabulaire des statuts

Le champ state dans les charges utiles des webhooks utilise le préfixe PROCESS_STATE_*. Il s'agit d'un vocabulaire distinct des champs result et status retournés par le point de terminaison GetProcess, qui utilisent PROCESS_RESULT_*. Ne les traitez pas comme interchangeables.

Exemple de charge utile

Terminé — succès

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "ok"
}

Terminé — expiré

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "expired",
  "lastEvent": "EVENT_TYPE_SESSION_ENDED",
  "lastEventDescription": "Session ended by timeout or by new session created"
}

Énumération lastEvent

La liste complète des valeurs pouvant apparaître dans lastEvent :

Événement	Description
EVENT_TYPE_PROCESS_CREATED	Processus créé
EVENT_TYPE_QR_CODE_READ	Code QR lu
EVENT_TYPE_PROCESS_STARTED_BY_USER	Processus démarré par l'utilisateur
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED	Étape de validation d'identité terminée
EVENT_TYPE_DOCUMENT_STEP_STARTED	Étape de document démarrée
EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED	Photo du document prise
EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY	Document importé depuis la galerie
EVENT_TYPE_DOCUMENT_STEP_FINISHED	Étape de document terminée
EVENT_TYPE_SESSION_ENDED	Session terminée par expiration ou création d'une nouvelle session
EVENT_TYPE_ERROR_ON_DOCUMENT_STEP	Erreur lors de l'étape de document

Gestion configurable

L'ensemble des événements peut évoluer. Traitez les événements auxquels votre point de terminaison réagit comme une configuration, et non comme des constantes codées en dur — ainsi, de nouveaux événements pourront être activés sans déploiement.

Lecture du résultat complet du processus

La charge utile du webhook signale qu'un processus est terminé et inclut le résultat de haut niveau dans le champ result. Pour récupérer les détails complets — données de capture, scores biométriques, champs du document, etc. — appelez le point de terminaison GetProcess approprié :

• Pour les flux visuels / Web et Natif : voir Référence API > Web et Natif > GET /v1/process/{id}.
• Pour les flux non visuels / API : voir Référence API > API > GET /processes/v1/{id}.