Passer au contenu principal
GET
curl

Vue d’ensemble

Renvoie la tâche de suppression de sessions en lot lancée par Supprimer des sessions en lot : son statut, le nombre de sessions traitées et le nombre de sessions pour chaque résultat. Lorsque plus de 20 sessions KYC correspondent à une suppression en lot, sélectionnées via session_numbers ou avec delete_all, la requête renvoie 202 avec une tâche PENDING, et les sessions sont supprimées en arrière-plan. Interrogez cet endpoint toutes les quelques secondes jusqu’à ce que status soit COMPLETED ou FAILED. Chaque session supprimée par la tâche est supprimée exactement comme par Supprimer une session : la session, chaque tentative de vérification qu’elle contient et tous ses fichiers stockés sont supprimés, et ses URL de médias cessent de fonctionner. La suppression est définitive et irréversible. La tâche ne fournit que des totaux. Elle ne liste jamais les sessions qu’elle a supprimées.

Statut de la tâche

Une tâche delete_all ne supprime que les sessions créées avant la requête. Les sessions démarrées pendant son exécution ne sont pas supprimées.

Nombre de résultats

deleted_child_verifications compte les vérifications que des vérifications d’entreprise supprimées avaient créées et qui ont été supprimées avec elles. Sa valeur est toujours 0 pour une tâche lancée par Supprimer des sessions en lot, qui ne supprime que des sessions KYC.

Autorisations

Toute clé API active de l’application peut appeler cet endpoint. Une tâche n’est visible que par l’application qui l’a créée ; tout autre job_id renvoie 404.

Voir aussi

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

job_id
string<uuid>
requis

Le job_id renvoyé avec la réponse 202 de POST /v3/sessions/delete/.

Réponse

La tâche.

Une suppression groupée de sessions en cours en arrière-plan : progression et totaux par résultat, jamais les sessions spécifiques supprimées.

job_id
string<uuid>

Interrogez GET /v3/sessions/delete/{job_id}/ avec cet identifiant.

status
enum<string>

PENDING : accepté, pas encore démarré. PROCESSING : suppression en cours ; processed et outcomes sont en cours de mise à jour. COMPLETED : chaque session sélectionnée est prise en compte. FAILED : la tâche s'est arrêtée prématurément ; voir error.

Options disponibles:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

Sessions sélectionnées lors de la demande de suppression.

processed
integer

Sessions traitées par la tâche jusqu'à présent.

outcomes
object

Nombre de sessions s'étant terminées par chaque résultat. Chaque clé est toujours présente.

deleted_child_verifications
integer

Vérifications créées par les vérifications d'entreprise supprimées, supprimées avec elles. Vaut toujours 0 pour une tâche initiée par POST /v3/sessions/delete/, qui supprime uniquement les sessions KYC.

error
string | null

null sauf si status est FAILED ; indique alors la raison de l'interruption de la suppression. Les sessions que la tâche n'avait pas encore atteintes sont conservées : répétez la requête pour les supprimer.

created_at
string<date-time>

Date et heure auxquelles la suppression a été demandée.

completed_at
string<date-time> | null

Moment où la tâche s'est terminée ; null pendant son exécution.

Dernière modification le 7 novembre 2026