API para eliminar usuaris en lot: esborrat RGPD

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"]}'

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);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.BatchDelete(ctx, didit.UsersBatchDeleteParams{
	VendorDataList: didit.Some([]string{"user-123", "user-456"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

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);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->batchDelete([
    'vendor_data_list' => ['user-123', 'user-456'],
]);
print_r($result->toArray());

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));

{
  "deleted": 2
}

POST

users

delete

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"]}'

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);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.BatchDelete(ctx, didit.UsersBatchDeleteParams{
	VendorDataList: didit.Some([]string{"user-123", "user-456"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

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);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->batchDelete([
    'vendor_data_list' => ['user-123', 'user-456'],
]);
print_r($result->toArray());

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));

{
  "deleted": 2
}

Visió general

Elimina una o més entitats d’usuari. Els registres d’usuari s’eliminen de manera permanent. Aquest endpoint no cobreix les seves sessions de verificació: sobreviuen, però se’ls elimina l’enllaç amb l’usuari; elimina-les amb Eliminar sessió o Eliminar sessions en lot. Aquest endpoint tampoc no cobreix les transaccions: elimina-les amb Eliminar transaccions en lot.

Quan utilitzar-lo

Sol·licituds de dret a l’oblit (GDPR / CCPA).
Neteja d’usuaris de prova durant el QA.
Desaprovisionament d’usuaris eliminats de la teva pròpia plataforma.

Notes

Accepta una llista de valors de vendor_data, una llista de valors de didit_internal_id o delete_all: true. Les dues llistes es poden combinar amb un OR.
Aquest endpoint mai no restringeix delete_all amb filtres, i els paràmetres en lot filter_* de la Console es rebutgen amb un 400; per tant, una intenció restringida no elimina tots els usuaris de l’aplicació. Les excepcions són filter_has_approved_sessions i filter_has_declined_sessions: no es rebutgen ni s’apliquen, així que no els enviïs amb delete_all.
Tot o res: si l’eliminació no es pot completar per als usuaris seleccionats, no se n’elimina cap i pots repetir la mateixa sol·licitud sense risc.
Idempotent: tornar a enviar la mateixa llista retorna deleted: 0 després de la primera execució.
Retorna només un recompte del que s’ha eliminat, no un informe per element. Els valors que no coincideixen amb res s’ignoren en silenci. Envia una llista sense duplicats si vols comparar deleted amb el nombre d’identificadors enviats, perquè un identificador repetit només es compta una vegada.
No s’emet cap webhook per a una eliminació. Els webhooks s’activen en canvis d’estat i de dades de l’usuari, no en l’eliminació; per tant, una integració que necessiti un senyal d’eliminació ha de registrar-lo pel seu compte.
Aquest endpoint NO elimina les sessions de verificació vinculades a l’usuari. Es mantenen, amb l’enllaç a l’usuari esborrat, així que els seus documents, rostres i fitxers multimèdia només s’eliminen quan elimines les pròpies sessions.
retain_face_embeddings (booleà, per defecte false) i face_retention_days (d’1 a 3650) són l’elecció explícita teva de conservar una plantilla biomètrica sense imatge per persona eliminada, per a la detecció de duplicats, durant aquest nombre de dies. No es conserva res més sobre la persona. Omet tots dos per eliminar les plantilles juntament amb els usuaris. face_retention_days sense retain_face_embeddings: true, o retain_face_embeddings: true sense face_retention_days, retorna 400 per a face_retention_days.
Llevat que estableixis retain_face_embeddings a true, les plantilles biomètriques conservades vinculades a l’usuari SÍ es purguen, abans que s’elimini l’usuari. Si una plantilla no es pot purgar perquè un magatzem biomètric no està disponible, la crida retorna 503, no s’elimina cap usuari de la sol·licitud, i repetir la sol·licitud acaba la feina.

Dades en un informe regulatori finalitzat

Si alguna de les persones seleccionades forma part d’un cas amb un informe regulatori finalitzat, tota la sol·licitud retorna 409 i no s’elimina res. La resposta usa code: in_filed_report i indica cada informe pel nom, perquè el puguis obrir a la Console:

{
  "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"
    }
  ]
}

Elimina cada informe amb Eliminar informe i després repeteix la mateixa sol·licitud. Treure aquesta persona de la llista no n’hi ha prou si una altra persona seleccionada encara és en un informe.

Una eliminació ja en curs

Una persona només s’elimina en una sol·licitud alhora. Si una altra sol·licitud encara està eliminant una de les persones seleccionades, aquesta sol·licitud espera com a màxim uns segons i després retorna 409 amb code: subject_deletion_in_progress i no elimina res:

{
  "detail": "This person or company is being deleted. Retry after deletion completes.",
  "code": "subject_deletion_in_progress"
}

Repeteix la mateixa sol·licitud quan l’altra eliminació hagi acabat. Una persona que ja ha estat eliminada ja no coincideix, així que la repetició només elimina el que queda.

Permisos

Qualsevol clau d’API activa de l’aplicació pot cridar aquest endpoint. Les claus d’API de Didit són limitades a l’aplicació, no a un rol: els rols i permisos de la Console (delete:users i la resta) decideixen què pot fer una persona a la Console, i no s’avaluen per al trànsit de la Management API. Controla qui pot cridar aquest endpoint controlant qui pot llegir la clau d’API de l’aplicació.

Relacionats

Autoritzacions

x-api-key

string

header

requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Cos

application/json

Proporciona vendor_data_list, didit_internal_id_list o delete_all: true. Les dues llistes es poden combinar i s'aplica una operació OR entre elles. Quan delete_all és true, té prioritat i s'ignoren totes dues llistes.

vendor_data_list

string[]

Els teus propis identificadors a eliminar, coincidits exactament com es van enviar.

didit_internal_id_list

string<uuid>[]

ID interns d'usuari de Didit per eliminar: el didit_internal_id retornat pels endpoints de creació i obtenció.

delete_all

boolean

predeterminat:false

Si és true, elimina tots els usuaris de l'aplicació.

retain_face_embeddings

boolean

predeterminat:false

La teva elecció explícita de conservar una plantilla biomètrica sense imatge de cada persona suprimida per a la detecció de duplicats, durant face_retention_days. Tota la resta sobre la persona se suprimeix. Omet-ho, o envia false, per suprimir les plantilles amb els usuaris. Quan és true, face_retention_days és obligatori.

face_retention_days

integer

Nombre de dies que es conserva la plantilla biomètrica sense imatge quan retain_face_embeddings és true. Obligatori amb aquest paràmetre, i rebutjat sense ell amb un 400 a face_retention_days.

Rang requerit: 1 <= x <= 3650

Exemple:

365

Resposta

Usuaris eliminats. Retorna el nombre d'usuaris realment eliminats.

deleted

integer

Nombre d'usuaris eliminats (exclou els valors de vendor_data que no han coincidit amb res).

Darrera modificació el 7 de novembre del 2026

​Visió general

​Quan utilitzar-lo

​Notes

​Dades en un informe regulatori finalitzat

​Una eliminació ja en curs

​Permisos

​Relacionats