> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # API de suppression en lot des utilisateurs (RGPD) > Supprimez en masse les utilisateurs Didit par vendor_data, ou tous les utilisateurs d'une application. Conforme au RGPD et au CCPA (droit à l'oubli). Prompt de suppression par lot d'utilisateurs Copier le prompt dans le presse-papiers \

\`Goal: Permanently delete one or many Didit User entities. The matching user records, their tag links, their comment history, and every retained biometric template anchored to them are removed permanently. Verification sessions are NOT removed by this endpoint; delete those separately with POST /v3/sessions/delete/.

Endpoint: POST https://verification.didit.me/v3/users/delete/
Auth header: x-api-key: 
Content-Type: application/json

Request body — provide at least one selector:
\- vendor_data_list: string[] — your own identifiers (case-insensitive after normalisation).
\- didit_internal_id_list: string[] — Didit internal user IDs, the didit_internal_id returned by the create and get endpoints. Can be combined with vendor_data_list; the two are OR'd.
\- delete_all: true — wipe every user in this application. No confirmation, no undo. Takes precedence: when delete_all is true, the two lists are ignored.

\- retain_face_embeddings: boolean, default false — your explicit choice to keep one image-free biometric template of each deleted person for duplicate detection. Everything else about the person is deleted. Requires face_retention_days.
\- face_retention_days: integer 1 to 3650 — how many days that template is kept. Sent without retain_face_embeddings: true it returns 400 on face_retention_days.

This endpoint never narrows delete_all with filters. The Console's filter_* batch params (filter_search, filter_status, filter_country, filter_date_from, filter_date_to, filter_tag, filter_latest_verification_status, filter_risk, filter_has_sessions, filter_has_open_alerts, filter_aml_monitoring, filter_can_sign_in, filter_auth_status, filter_auth_method, filter_auth_mfa_enabled) are NOT supported here. Any of them sent with a value, even false, is rejected with a 400 keyed by that field, and any other unknown filter_* key with "Unknown filter.", so a narrowed intent does not wipe the whole application. Exception: filter_has_approved_sessions and filter_has_declined_sessions are neither rejected nor applied, so with delete_all they still delete every user. Do not send them.

curl:
curl -X POST 'https://verification.didit.me/v3/users/delete/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data_list": ["user-123", "user-456"]}'

Response 200:
\{
"deleted": 
}

Biometric templates: unless you set retain_face_embeddings to true, if the application retained image-free biometric templates for these users after session deletion (see /management-api/biometric-templates/overview), Didit purges every one of them before the user is deleted, so the person stops matching in duplicate detection and Face Search. The purge is audited with instruction_source: vendor_user_delete.

Idempotency: re-sending the same list returns deleted: 0 after the first run (unmatched IDs are silently skipped). There is no undo.

Failure modes:
\- 400 — no selector supplied, or a Console-only filter_* param was sent.
No selector: {"vendor_data_list": ["This field is required unless delete_all is true."]}. An unknown filter_* key: {"filter_": ["Unknown filter."]}.
\- 401 — missing/invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 409 — the selection includes a person in a finalized regulatory report. Nothing is deleted. The body has code: in_filed_report and reports[] with uuid, report_number, report_type and case_uuid. Delete the reports, then repeat the request.
\- 409 — code: subject_deletion_in_progress: another request is still deleting one of the selected people. This request deleted nothing; repeat it once that deletion has finished.
\- 429 — rate-limited.
\- 503 — {"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."} A retained biometric template could not be purged. No user in the request is deleted; the affected template is already excluded from matching. Repeat the same request.

WARNING — delete_all: true: there is no confirmation step and no undo. Restrict to API keys you intentionally provision for batch maintenance.

When to prefer status change instead:
\- For day-to-day blocking, use PATCH /v3/users/{vendor_data}/update-status/ with {"status": "BLOCKED"} — it keeps the audit trail intact while rejecting future sessions for the same identifier.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Coller dans ## Vue d'ensembleSupprime une ou plusieurs [entités utilisateur](https://docs.didit.me/fr/entities/users/overview.md). Les enregistrements des utilisateurs sont supprimés de façon définitive. Leurs sessions de vérification ne sont pas couvertes par cet endpoint : elles subsistent, leur lien vers l'utilisateur étant effacé. Supprimez-les avec [Supprimer une session](https://docs.didit.me/fr/sessions-api/delete-session.md) ou [Supprimer des sessions par lot](https://docs.didit.me/fr/management-api/sessions/batch-delete.md). Les transactions ne sont pas non plus couvertes ; supprimez-les avec [Supprimer des transactions par lot](https://docs.didit.me/fr/management-api/transactions/delete.md).## Quand l'utiliser- **Demandes de droit à l'effacement** (RGPD / CCPA). - **Nettoyage** des utilisateurs de test pendant les tests qualité. - **Déprovisionnement** des utilisateurs retirés de votre propre plateforme.## Remarques- Accepte une liste de valeurs `vendor_data`, une liste de valeurs `didit_internal_id`, ou `delete_all: true`. Les deux listes peuvent être combinées et sont reliées par un OU logique. - Cet endpoint ne restreint jamais `delete_all` avec des filtres, et les paramètres de lot `filter_*` de la Console sont rejetés avec un `400`, de sorte qu'une intention restreinte ne supprime pas tous les utilisateurs de l'application. Les exceptions sont `filter_has_approved_sessions` et `filter_has_declined_sessions` : ils ne sont ni rejetés ni appliqués, donc ne les envoyez pas avec `delete_all`. - Tout ou rien : si la suppression ne peut pas être menée à bout pour les utilisateurs sélectionnés, aucun d'entre eux n'est supprimé, et vous pouvez renvoyer la même requête sans risque. - Idempotent : renvoyer la même liste retourne `deleted: 0` après la première exécution. - Ne renvoie que le nombre d'éléments supprimés, et non un rapport par élément. Les valeurs sans correspondance sont ignorées silencieusement. Envoyez une liste dédupliquée si vous voulez comparer `deleted` au nombre d'identifiants envoyés, car un identifiant répété n'est compté qu'une fois. - Aucun webhook n'est émis pour une suppression. Les webhooks se déclenchent lors des changements de statut et de données des utilisateurs, et non lors d'une suppression ; une intégration qui a besoin d'un signal de suppression doit donc l'enregistrer de son côté. - Les sessions de vérification liées à l'utilisateur ne sont PAS supprimées par cet endpoint. Elles subsistent, leur lien vers l'utilisateur étant effacé ; leurs documents, visages et médias ne sont donc supprimés que lorsque vous supprimez les sessions elles-mêmes. - `retain_face_embeddings` (booléen, `false` par défaut) et `face_retention_days` (1 à 3650) traduisent votre choix explicite de conserver, pour chaque personne supprimée, un gabarit biométrique sans image, pour la détection de doublons, pendant ce nombre de jours. Aucune autre donnée sur la personne n'est conservée. Omettez les deux pour supprimer les gabarits avec les utilisateurs. `face_retention_days` sans `retain_face_embeddings: true`, ou `retain_face_embeddings: true` sans `face_retention_days`, renvoie `400` sur `face_retention_days`. - Sauf si vous définissez `retain_face_embeddings` à `true`, les [gabarits biométriques](https://docs.didit.me/fr/management-api/biometric-templates/overview.md) conservés liés à l'utilisateur SONT purgés, avant la suppression de l'utilisateur. Si un gabarit ne peut pas être purgé parce qu'un espace de stockage biométrique est indisponible, l'appel renvoie `503`, aucun utilisateur de la requête n'est supprimé, et renvoyer la requête termine le travail.## Données figurant dans un rapport réglementaire finaliséSi une personne sélectionnée fait partie d'un dossier comportant un rapport réglementaire finalisé, toute la requête renvoie `409` et rien n'est supprimé. La réponse utilise `code: in_filed_report` et nomme chaque rapport, afin que vous puissiez l'ouvrir dans la Console :```json theme={null} { "detail": "A case about this person or company has a filed regulatory report, so it cannot be deleted.", "code": "in_filed_report", "reports": [ { "uuid": "5ec00000-0000-4000-8000-000000000007", "report_number": "SAR-0001", "report_type": "SAR", "case_uuid": "c1a5e000-0000-4000-8000-000000000001" } ] } ```Supprimez chaque rapport avec [Supprimer un rapport](https://docs.didit.me/fr/management-api/regulatory-reports/delete.md), puis renvoyez la même requête. Retirer cette personne de la liste ne suffit pas si une autre personne sélectionnée figure encore dans un rapport.## Une suppression déjà en coursUne personne est supprimée par une seule requête à la fois. Si une autre requête supprime encore l'une des personnes sélectionnées, cette requête attend quelques secondes au maximum, puis renvoie `409` avec `code: subject_deletion_in_progress` et ne supprime rien :```json theme={null} { "detail": "This person or company is being deleted. Retry after deletion completes.", "code": "subject_deletion_in_progress" } ```Renvoyez la même requête une fois l'autre suppression terminée. Une personne déjà supprimée par cette autre requête ne correspond plus, donc la requête ne supprime que ce qui reste.## AutorisationsToute clé API active de l'application peut appeler cet endpoint. Les clés API Didit sont **limitées à l'application, et non au rôle** : les [rôles et autorisations](https://docs.didit.me/fr/console/roles-permissions.md) de la Console (`delete:users` et les autres) déterminent ce qu'une *personne* peut faire dans la Console, et ne sont pas évalués pour le trafic de l'API de gestion. Pour contrôler qui peut appeler cet endpoint, contrôlez qui peut lire la clé API de l'application.## Liens connexes- [Conservation des données](https://docs.didit.me/fr/console/data-retention.md) - [Journaux d'audit](https://docs.didit.me/fr/console/audit-logs.md) - [Opérations sur les utilisateurs](https://docs.didit.me/fr/entities/users/operations.md) - [Gabarits biométriques](https://docs.didit.me/fr/management-api/biometric-templates/overview.md) ## OpenAPI ````yaml fr/openapi-25.json POST /v3/users/delete/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/users/delete/: post: tags: - Users summary: Supprimer des utilisateurs par lot description: >- **Supprimer définitivement** des utilisateurs : les enregistrements utilisateurs sont supprimés de façon permanente. Pour un blocage standard, préférez [Update User Status](#patch-/v3/users/-vendor_data-/update-status/) avec `BLOCKED`. Sélectionnez les utilisateurs avec `vendor_data_list`, avec `didit_internal_id_list`, ou avec les deux à la fois ; ou transmettez `delete_all: true`. Cet endpoint ne restreint jamais `delete_all` avec des filtres. Les filtres Personnes de la Console sont refusés avec un code `400` (voir la réponse `400`), afin qu'une intention ciblée ne se transforme pas en suppression totale. Deux exceptions : `filter_has_approved_sessions` et `filter_has_declined_sessions` ne sont pas refusés et ne sont pas appliqués, donc avec `delete_all: true`, ils suppriment tout de même tous les utilisateurs ; ne les envoyez pas. **Gabarits biométriques :** à moins que vous ne définissiez `retain_face_embeddings` sur `true`, chaque gabarit biométrique sans image conservé pour ces utilisateurs après la suppression de la session (voir `/v3/biometric-templates/`) est purgé avant la suppression de l'utilisateur, afin que la personne ne corresponde plus dans la détection des doublons et la Recherche faciale. Avec `retain_face_embeddings: true` et `face_retention_days`, vous choisissez de conserver un gabarit biométrique sans image par personne pendant ce nombre de jours, et rien d'autre concernant la personne n'est conservé. Si un gabarit ne peut pas être purgé parce qu'un système de stockage biométrique est indisponible, l'appel renvoie `503`, aucun utilisateur de la requête n'est supprimé, et répéter la requête permet de finaliser l'opération. **Rapports réglementaires déposés :** si les données sélectionnées figurent dans un rapport réglementaire finalisé, l'ensemble de la requête est refusé avec `409` et rien n'est supprimé. Le corps utilise `code: in_filed_report` et nomme chaque rapport avec `uuid`, `report_number`, `report_type` et `case_uuid`. Supprimez les rapports, puis réessayez la requête. operationId: batch_delete_users requestBody: required: true content: application/json: schema: type: object description: >- Fournissez `vendor_data_list`, `didit_internal_id_list` ou `delete_all: true`. Les deux listes peuvent être combinées et sont évaluées avec un OU logique (OR). Lorsque `delete_all` est `true`, il a la priorité et les deux listes sont ignorées. properties: vendor_data_list: type: array items: type: string description: >- Vos propres identifiants à supprimer, mis en correspondance exacte avec ceux transmis. didit_internal_id_list: type: array items: type: string format: uuid description: >- Identifiants internes d'utilisateur Didit à supprimer - le `didit_internal_id` renvoyé par les endpoints de création et d'obtention. delete_all: type: boolean default: false description: Si `true`, supprime tous les utilisateurs de l'application. retain_face_embeddings: type: boolean default: false description: >- Votre choix explicite de conserver un gabarit biométrique sans image de chaque personne supprimée pour la détection des doublons, pendant `face_retention_days`. Tout le reste concernant la personne est supprimé. Omettez-le, ou envoyez `false`, pour supprimer les gabarits avec les utilisateurs. Lorsque la valeur est `true`, `face_retention_days` est obligatoire. face_retention_days: type: integer minimum: 1 maximum: 3650 description: >- Nombre de jours pendant lesquels le gabarit biométrique sans image est conservé lorsque `retain_face_embeddings` est `true`. Requis avec ce dernier, et rejeté sans lui avec une erreur `400` sur `face_retention_days`. example: 365 examples: Specific users: summary: Supprimer les utilisateurs par vendor_data value: vendor_data_list: - user-123 - user-456 By Didit internal ID: summary: Supprimer les utilisateurs par didit_internal_id value: didit_internal_id_list: - 3f1c0d3e-8f0a-4c2e-9a3d-9b1f5f4a2c11 All users: summary: Effacer tous les utilisateurs de cette application value: delete_all: true Keep face templates: summary: >- Supprimer les utilisateurs et conserver les modèles faciaux anonymes pendant 365 jours value: vendor_data_list: - user-123 retain_face_embeddings: true face_retention_days: 365 responses: '200': description: >- Utilisateurs supprimés. Renvoie le nombre d'utilisateurs réellement supprimés. content: application/json: schema: type: object properties: deleted: type: integer description: >- Nombre d'utilisateurs supprimés (exclut les valeurs vendor_data qui ne correspondaient à rien). examples: Deleted some: value: deleted: 2 Nothing matched: value: deleted: 0 '400': description: >- Erreur de validation ; rien n'est supprimé. Les erreurs sont indexées par nom de champ. Sans sélecteur (aucune liste et `delete_all` n'étant pas à `true`), le corps est `{"vendor_data_list": ["This field is required unless delete_all is true."]}` ; une liste vide est refusée sous sa propre clé avec `"This list may not be empty."`. Un filtre exclusif à la Console (`filter_search`, `filter_status`, `filter_country`, `filter_date_from`, `filter_date_to`, `filter_tag`, `filter_latest_verification_status`, `filter_risk`, `filter_has_sessions`, `filter_has_open_alerts`, `filter_aml_monitoring`, `filter_can_sign_in`, `filter_auth_status`, `filter_auth_method` ou `filter_auth_mfa_enabled`) est refusé dès lors qu'il contient une valeur, même `false`, avec un objet indexé par chacun de ces champs. Toute autre clé `filter_*` inconnue est refusée avec `"Unknown filter."`. content: application/json: examples: Missing selector: summary: Ni list ni delete_all n'ont été fournis value: vendor_data_list: - This field is required unless delete_all is true. Console-only filter: value: filter_has_sessions: >- This filter is Console-only and is not supported by this endpoint. '401': description: >- Aucun identifiant fourni. Les requêtes vers les chemins `/v3/users/*` sans en-tête `x-api-key` (ou token `Authorization: Bearer`) sont rejetées par le middleware d'authentification avant d'atteindre l'API. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- Clé API non valide ou révoquée, ou la clé ne peut pas supprimer d'utilisateurs pour cette application. Une clé manquante renvoie `403` ; une clé erronée, révoquée ou expirée renvoie `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '409': description: >- Rien n'est supprimé. `code` en indique la raison : `in_filed_report` lorsque la sélection inclut une personne présente dans un rapport réglementaire finalisé, `subject_deletion_in_progress` lorsqu'une autre requête est encore en train de supprimer l'une des personnes sélectionnées. Réessayez la requête une fois cette suppression terminée. content: application/json: schema: oneOf: - $ref: '#/components/schemas/InFiledReportError' - $ref: '#/components/schemas/SubjectDeletionInProgressError' '429': description: >- Limite de débit dépassée ; réduisez la cadence et réessayez après l'intervalle indiqué dans `Retry-After`. content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. '503': description: "Un service de stockage biométrique était indisponible lors de la conservation ou de la suppression définitive d'un gabarit biométrique. Rien n'est supprimé\_; réitérez la même requête. Les nouvelles tentatives sont idempotentes et convergent vers un seul gabarit." content: application/json: schema: type: object properties: detail: type: string examples: Retryable: value: detail: >- The biometric-template operation could not finish because an external store is unavailable. The operation is retryable. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST 'https://verification.didit.me/v3/users/delete/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"vendor_data_list": ["user-123", "user-456"]}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.batch_delete( vendor_data_list=["user-123", "user-456"], ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.users.batchDelete({ vendor_data_list: ["user-123", "user-456"], }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.BatchDelete(ctx, didit.UsersBatchDeleteParams{\n\tVendorDataList: didit.Some([]string{\"user-123\", \"user-456\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.util.List; import me.didit.Didit; import me.didit.types.UsersBatchDeleteParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().batchDelete(UsersBatchDeleteParams.builder() .vendorDataList(List.of("user-123", "user-456")) .build()); System.out.println(result); - lang: php label: PHP source: |- users->batchDelete([ 'vendor_data_list' => ['user-123', 'user-456'], ]); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.batch_delete(vendor_data_list: ["user-123", "user-456"]) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Users.BatchDeleteAsync(new UsersBatchDeleteParams { VendorDataList = new string[] { "user-123", "user-456" }, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: InFiledReportError: type: object description: >- La suppression est refusée car les données sélectionnées figurent dans un rapport réglementaire finalisé. Rien n'est supprimé. Supprimez le rapport, puis réessayez la requête. required: - detail - code properties: detail: type: string code: type: string enum: - in_filed_report description: >- Code d'erreur stable pour une suppression bloquée par un rapport réglementaire finalisé. reports: type: array items: $ref: '#/components/schemas/FiledRegulatoryReport' description: >- Rapports qui bloquent la suppression d'une personne, d'une entreprise, d'un dossier ou d'une session. transactions: type: array items: $ref: '#/components/schemas/FiledReportTransaction' description: >- Transactions qui bloquent la suppression d'une transaction, chacune accompagnée des rapports qui la répertorient. SubjectDeletionInProgressError: type: object description: "Une autre requête est toujours en train de supprimer cette personne ou cette entreprise. Cette requête n'a rien supprimé et peut être réessayée une fois cette suppression terminée\_; une nouvelle tentative supprimera alors ce qui est encore sélectionné." required: - detail - code properties: detail: type: string code: type: string enum: - subject_deletion_in_progress description: >- Code d'erreur stable pour une personne ou une entreprise qu'une autre requête est toujours en train de supprimer. FiledRegulatoryReport: type: object description: Un rapport réglementaire finalisé qui empêche la suppression demandée. required: - uuid - report_number - report_type - case_uuid properties: uuid: type: string format: uuid description: UUID du rapport. report_number: type: string description: Numéro de rapport affiché dans la Console (par exemple, SAR-0001). report_type: type: string enum: - SAR - STR - CTR - TTR - UTR - IFT - CBR - TFR description: Type de rapport réglementaire. case_uuid: type: string format: uuid description: Dossier auquel appartient le rapport. FiledReportTransaction: type: object description: >- Une transaction qui ne peut pas être supprimée car un rapport réglementaire finalisé la répertorie. required: - uuid - transaction_id - reports properties: uuid: type: string format: uuid description: UUID de transaction Didit. transaction_id: type: string description: >- L'identifiant de la transaction fourni lors de la création de la transaction. reports: type: array items: $ref: '#/components/schemas/FiledRegulatoryReport' description: Rapports finalisés répertoriant cette transaction. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.