curl -X DELETE \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \
-H 'x-api-key: YOUR_API_KEY'{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "deleted",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}API per eliminar sessions: dret a l'oblit (RGPD)
Didit elimina una sessió KYC o KYB i les seves dades; per defecte, també l’embedding facial. Opcionalment, conserva una plantilla biomètrica.
curl -X DELETE \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \
-H 'x-api-key: YOUR_API_KEY'{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "deleted",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}Suport per a KYC i KYB
Funciona tant per a sessions de Verificació d’usuaris (KYC) com per a sessions de Verificació d’empreses (KYB). L’session_id es resol amb els dos tipus de sessió, i el comportament d’eliminació és el mateix per a tots dos. La retenció de la plantilla biomètrica només s’aplica a les sessions KYC, perquè només aquestes contenen un embedding facial.
Comportament
- La sessió s’elimina juntament amb tots els intents de verificació que conté, inclosos els resultats que una nova presentació ha substituït: la seva decisió, les dades extretes, els registres de les funcionalitats associades (verificacions d’identitat, consultes al registre, documents, AML, anàlisi d’IP, etc.), les revisions i el registre d’activitat, i tots els seus fitxers emmagatzemats.
- Eliminar una sessió de Verificació d’empreses (KYB) també elimina, de manera recursiva, les verificacions que s’han creat per a les seves persones clau (KYC) i per als seus propietaris corporatius (KYB). La resposta indica quantes n’hi ha al camp
deleted_child_verifications. Una verificació només enllaçada, com un KYC aprovat existent que s’hagi reutilitzat, no s’elimina. - Les dades de signatura electrònica s’eliminen amb la sessió: els documents per signar i els seus fitxers originals de Word, els PDF signats, els PDF d’evidències, les imatges de signatura i tots els valors dels camps. Les seves rutes de descàrrega retornen
404. - La sessió deixa d’aparèixer immediatament a les respostes de llista i de decisió, i les URL de contingut multimèdia emeses abans de la crida deixen de resoldre’s.
- Els lliuraments de webhook pendents de la sessió, i els seus reintents, es descarten.
- El monitoratge AML continu i el monitoratge del registre KYB iniciats per les verificacions eliminades s’aturen.
- L’eliminació és permanent i irreversible. No hi ha cap endpoint per restaurar la sessió, de manera que has d’exportar tot el que necessitis, com ara un PDF de la decisió, abans de cridar-lo.
- La resposta és
200 OK, enviada un cop completada l’eliminació, amb un cos JSON que indica què ha passat amb les dades biomètriques facials de la sessió. Consulta la Migració si el teu client encara espera204.
Dades en un informe regulatori finalitzat
Si la sessió forma part d’un cas amb un informe regulatori finalitzat, la sol·licitud retorna409 i no s’elimina res. La resposta utilitza code: in_filed_report i nomena cada informe:
{
"detail": "This session is part of a finalized 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"
}
]
}
Dades biomètriques facials: eliminar o conservar
Cada sessió KYC amb un selfie de prova de vida conté un embedding facial que alimenta la Cerca facial 1:N i la detecció de duplicats. Per defecte, aquest embedding s’elimina amb la sessió (face_retention_policy: delete_with_session), de manera que una persona la sessió de la qual has eliminat pot tornar a verificar-se sense que el sistema la marqui com a duplicat.
Les aplicacions que necessiten que la detecció de duplicats sobrevisqui a l’eliminació de la sessió poden optar per la retenció de plantilla biomètrica. Didit aleshores elimina la sessió i totes les seves dades com de costum, i conserva una plantilla biomètrica facial sense imatges, gestionada per separat i vinculada a l’usuari de la sessió.
| Retingut | Mai retingut |
|---|---|
| La plantilla facial numèrica utilitzada per a la comparació | La imatge facial, el vídeo de prova de vida, les imatges del document, els retalls del retrat i qualsevol altre contingut multimèdia |
Un nou identificador aleatori de la plantilla i un provenance_reference opac | L’identificador, el número, la decisió, els camps d’identitat extrets i els payloads de funcionalitats de la sessió eliminada |
L’usuari propietari (vendor_user_uuid, vendor_data actual) | L’estat de la llista de bloqueig, les coincidències prèvies, les etiquetes de frau o les afirmacions d’identitat entre organitzacions |
Metadades de retenció: retained_at, expires_at, política, substitució, classe d’instrucció, instruction_id i l’identificador del principal que actua | Adreces de correu electrònic dels actors |
- Política de l’aplicació a Business Console → App Settings → Data retention o mitjançant
PATCH /v3/webhook/(face_retention_policy,face_retention_days). Consulta Conservació de dades. - Substitució per crida amb
retain_face_embeddingsen aquest endpoint i a Eliminar sessions en lot. - Classe d’instrucció amb
deletion_instruction. Una instruccióprivacy_erasuresempre preval: purga totes les plantilles retingudes d’aquest usuari i mai no en retén de noves.
Cos de la sol·licitud
Tots els camps són opcionals. Omet el cos per seguir la política de l’aplicació.| Camp | Tipus | Descripció |
|---|---|---|
retain_face_embeddings | booleà o null | Substitueix la política de l’aplicació per a aquesta eliminació. true reté una plantilla, false elimina l’embedding amb la sessió, null o omès segueix la política. |
face_retention_days | enter (1-3650) | Durada finita de conservació de la plantilla. És obligatori quan es reté una plantilla, tret que l’aplicació ja defineixi face_retention_days. |
face_retention_deadline | datetime (ISO 8601) | Caducitat màxima opcional. Ha de ser en el futur. |
deletion_instruction | operational_session_delete (per defecte) o privacy_erasure | La classe d’instrucció que dones. privacy_erasure purga totes les plantilles retingudes de l’usuari de la sessió abans d’eliminar-la i no es pot combinar amb retain_face_embeddings: true. |
instruction_id | cadena (màx. 255) | La teva referència duradora per a aquesta instrucció, per exemple l’identificador del teu tiquet d’esborrat. Es registra a la traça d’auditoria i a qualsevol plantilla retinguda. Si l’omets, Didit en genera una, visible al detall de la plantilla. |
Resposta
{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "retained_with_user",
"biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"biometric_template_expires_at": "2027-10-09T10:15:00Z",
"deleted_child_verifications": 0
}
| Camp | Descripció |
|---|---|
session_id | La sessió eliminada. |
session_number | El número de la sessió eliminada. |
face_retention_outcome | Què ha passat amb les dades biomètriques facials de la sessió. Consulta la taula següent. |
biometric_template_uuid | Identificador de la plantilla biomètrica retinguda quan face_retention_outcome és retained_with_user; null en cas contrari. |
biometric_template_expires_at | Quan s’elimina la plantilla biomètrica retinguda; null quan no se’n reté cap. |
deleted_child_verifications | Per a una sessió KYB, quantes verificacions que va crear (les sessions KYC de les seves persones clau i les sessions KYB dels seus titulars corporatius, de manera recursiva) es van eliminar amb ella. Sempre 0 per a una sessió KYC. |
face_retention_outcome | Significat |
|---|---|
deleted | La sessió i el seu embedding facial s’eliminen. Comportament per defecte. |
retained_with_user | La sessió s’elimina. Una plantilla biomètrica sense imatges es manté vinculada a l’usuari; el seu identificador és biometric_template_uuid. Gestiona-la amb l’API de plantilles biomètriques. |
none | La sessió no tenia cap embedding facial per eliminar o retenir (per exemple, una sessió KYB, o una sessió KYC sense selfie de prova de vida). |
ineligible_no_vendor_user | S’ha demanat la retenció, però la sessió no està vinculada a cap usuari (es va crear sense vendor_data), així que no hi ha res a què vincular una plantilla. La sessió i el seu embedding s’eliminen. El resultat no elegible queda registrat a la traça d’auditoria. |
instruction_id al teu propi registre d’esborrats perquè després puguis correlacionar la traça d’auditoria.
Durada de la retenció i caducitat
Cada plantilla retinguda té unexpires_at finit. Didit el fixa al més primerenc dels valors següents:
face_retention_daysde la sol·licitud o, quan la sol·licitud l’omet, elface_retention_daysde l’aplicació;- la finestra general de conservació de dades de l’aplicació, quan n’hi ha una de configurada;
face_retention_deadlinede la sol·licitud, quan se n’ha proporcionat un.
400 i no s’elimina res. Les plantilles retingudes no poden sobreviure a la instrucció del client aplicable més primerenca, a la finalització de la finalitat, a una caducitat configurada, a una instrucció d’esborrat de l’interessat ni a un termini legal aplicable a les dades biomètriques. Tu ets responsable de triar una durada que compleixi les lleis que s’apliquen als teus usuaris; tria una de més curta sempre que una norma aplicable ho exigeixi.
Esborrat per motius de privacitat
Enviadeletion_instruction: "privacy_erasure" quan actuïs en resposta a una sol·licitud de l’interessat. Didit purga totes les plantilles biomètriques retingudes vinculades a l’usuari de la sessió i, després, esborra la sessió i el seu embedding facial. La política de conservació de l’aplicació no pot anul·lar una instrucció d’esborrament per privacitat, i retain_face_embeddings: true es rebutja amb 400.
Esborrar l’usuari amb Esborrament en lot d’usuaris també purga les seves plantilles retingudes.
Què no es veu afectat
Esborrar una sessió no neteja aquests elements automàticament. Si gestiones una sol·licitud de dret de supressió, tracta’ls per separat.- Les entrades de la llista de bloqueig creades a partir de la sessió (facial o de document) es mantenen. Elimina-les de la llista de bloqueig. Una entrada facial a la llista de bloqueig conserva la seva pròpia entrada biomètrica, independent de qualsevol plantilla retinguda.
- Els tokens de compartició ja emesos per a la sessió no es revoquen, però ja no hi ha res que puguin importar: una importació amb un d’aquests tokens retorna
400amb{"share_token": ["Original session does not exist."]}. - Els webhooks ja lliurats de la sessió no es veuen afectats. Els lliuraments encara pendents a la cua, i els seus reintents, es descarten. No s’emet cap webhook per l’esborrament en si.
- Els crèdits ja consumits per la verificació no es reemborsen.
- Les còpies signades ja enviades per correu electrònic a un signant mitjançant un pas de signatura electrònica són a la safata d’entrada del signant i no es veuen afectades.
- L’entitat pare Usuari o Empresa no s’esborra. Utilitza Esborrar usuaris o Esborrar empreses per a aquestes. Si el retrat del perfil de l’usuari provenia de la sessió esborrada, el retrat s’elimina.
- Una plantilla biomètrica retinguda (només si hi has optat) es manté fins que caduca o fins que la purgues. Purga-la amb l’API de plantilles biomètriques, esborrant l’usuari, o repetint l’esborrament d’una altra sessió del mateix usuari amb
deletion_instruction: "privacy_erasure".
Exemples
- Per defecte (política de l'aplicació)
- Conservar una plantilla biomètrica
- Forçar l'esborrament en una aplicació que n'ha optat
- Esborrament per privacitat
- Sessió sense usuari
- Sessió de verificació d'empreses (KYB)
curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
-H "x-api-key: YOUR_API_KEY"
{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "deleted",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}
curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "cleanup-2026-08-0142"}'
{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "retained_with_user",
"biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"biometric_template_expires_at": "2027-10-09T10:15:00Z",
"deleted_child_verifications": 0
}
curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"retain_face_embeddings": false}'
{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "deleted",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}
curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142"}'
{
"session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
"session_number": 1024,
"face_retention_outcome": "deleted",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}
vendor_data no té cap usuari al qual vincular una plantilla:curl -X DELETE https://verification.didit.me/v3/session/7a1e9c2d-.../delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"retain_face_embeddings": true, "face_retention_days": 365}'
{
"session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c",
"session_number": 1031,
"face_retention_outcome": "ineligible_no_vendor_user",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 0
}
curl -X DELETE https://verification.didit.me/v3/session/bs-01HJX1.../delete/ \
-H "x-api-key: YOUR_API_KEY"
{
"session_id": "0f3c9b7e-2d1a-4e5f-8c6b-7a9d8e1f2c3b",
"session_number": 88,
"face_retention_outcome": "none",
"biometric_template_uuid": null,
"biometric_template_expires_at": null,
"deleted_child_verifications": 3
}
Errors
| Estat | Quan | Cos |
|---|---|---|
400 | privacy_erasure combinat amb retain_face_embeddings: true | {"retain_face_embeddings": ["Privacy erasure cannot retain biometric templates."]} |
400 | Es demana conservació sense una durada finita, ni a la sol·licitud ni a l’aplicació | {"detail": "A finite biometric-template retention duration is required."} |
403 | La credencial no té delete:sessions o no és propietària de la sessió | {"detail": "You do not have permission to perform this action."} |
404 | Sessió inexistent o ja esborrada | {"detail": "Not found."} |
503 | Un servei d’emmagatzematge o un proveïdor de monitoratge no estava disponible en esborrar la sessió. | {"detail": "The session could not be deleted because a storage service or a monitoring provider is unavailable. The session is still in place; repeat the request to finish deleting it."} |
503 | Un magatzem biomètric no estava disponible en conservar o purgar una plantilla. Els reintents conflueixen en una única plantilla. | {"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."} |
400 no s’esborra res. En cas de 503 la sessió encara existeix: repeteix la mateixa sol·licitud fins que retorni 200. Alguns dels seus fitxers emmagatzemats o el seu embedding facial poden ja haver estat esborrats, així que no hi confiïs després d’un 503.
Permís
Caldelete:sessions. El mateix permís cobreix les sessions de Verificació d’usuaris (KYC) i de Verificació d’empreses (KYB), i l’anul·lació de la conservació.
Esborrament en lot
Per a operacions massives sobre sessions KYC, utilitzaPOST /v3/sessions/delete/. Accepta els mateixos camps de conservació i d’instrucció. Fins a 20 sessions coincidents s’esborren en la mateixa sol·licitud, amb un resultat per sessió; les sessions addicionals es processen com a tasca d’esborrament. Consulta Esborrament en lot de sessions.
Migració des de respostes 204
Fins a aquesta versió, l’endpoint retornava204 No Content. Ara retorna 200 OK amb el cos JSON documentat més amunt, perquè cada esborrament informi del seu face_retention_outcome. Actualitza els clients que comproven 204.
El comportament per defecte no canvia: les aplicacions existents es mantenen amb delete_with_session, i cap migració activa la conservació en nom teu. Activa-la explícitament a la Console o amb PATCH /v3/webhook/.
Relacionat
Autoritzacions
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.
Paràmetres de ruta
UUID (session_id) de la sessió de Verificació d'usuaris (KYC) o de Verificació d'empreses (KYB) que cal suprimir, tal com es va retornar en crear la sessió. Ha de ser un UUID canònic separat per guions; un valor que no sigui un UUID no coincideix amb la ruta i retorna 404.
"11111111-2222-3333-4444-555555555555"
Cos
Opcional. Omet el cos completament per seguir la política de conservació de l'aplicació amb una supressió operativa.
Sobreescriu la face_retention_policy de l'aplicació per a aquesta supressió. true manté una plantilla biomètrica facial sense imatge vinculada a l'usuari de la sessió després que se suprimeixi la sessió; false suprimeix l'embedding facial amb la sessió; omet o posa null per seguir la política de l'aplicació. S'ignora en sessions de KYB i en sessions sense embedding facial.
true
Durada de conservació finita, en dies, per a una plantilla conservada. Obligatori quan es conserva una plantilla tret que l'aplicació ja defineixi face_retention_days. El camp expires_at de la plantilla és la data més primerenca entre aquesta durada, la finestra general de conservació de dades de l'aplicació i face_retention_deadline.
1 <= x <= 3650365
Caducitat estricta opcional per a una plantilla conservada. Ha de ser posterior a la data actual.
"2027-08-28T00:00:00Z"
La classe d'instrucció que estàs donant. operational_session_delete suprimeix la sessió i conserva una plantilla només quan la política o retain_face_embeddings així ho indiquen. privacy_erasure purga totes les plantilles biomètriques conservades vinculades a l'Usuari de la sessió abans de suprimir la sessió, no pot ser anul·lada per la política de l'aplicació i no es pot combinar amb retain_face_embeddings: true (400).
operational_session_delete, privacy_erasure "operational_session_delete"
La teva referència persistent per a aquesta instrucció de supressió (per exemple, l'id d'un tiquet de supressió). Es registra al registre d'auditoria i a qualsevol plantilla conservada. Didit la genera si s'omet.
255"dsar-2026-0142"
Resposta
Sessió suprimida. El cos informa de què ha passat amb les dades biomètriques facials de la sessió i, per a una sessió de KYB, quantes verificacions que va crear es van suprimir amb ella.
La sessió eliminada.
El número de la sessió eliminada.
Què ha passat amb les dades biomètriques facials de la sessió. deleted: l'embedding facial s'ha suprimit amb la sessió (per defecte). retained_with_user: la sessió se suprimeix i una plantilla biomètrica sense imatges es manté vinculada a l'usuari; consulta biometric_template_uuid. none: la sessió no tenia cap embedding facial (per exemple, una sessió de KYB o una sessió de KYC sense selfie de prova de vida). ineligible_no_vendor_user: s'ha sol·licitat la conservació però la sessió no té cap usuari enllaçat, de manera que l'embedding s'ha suprimit amb la sessió. Una fallada a l'emmagatzematge biomètric mai es notifica mitjançant aquest camp en aquest endpoint: retorna 503 i la sessió no se suprimeix.
retained_with_user, deleted, none, ineligible_no_vendor_user ID de la plantilla biomètrica conservada quan face_retention_outcome és retained_with_user; null en cas contrari. Gestiona-la mitjançant /v3/biometric-templates/{template_uuid}/.
Quan s'elimina la plantilla biomètrica conservada, quan face_retention_outcome és retained_with_user; null quan no es conserva cap plantilla.
Per a una sessió de Verificació d'empreses (KYB): quantes verificacions que va crear (les sessions de KYC de les seves persones clau i les sessions de KYB dels seus propietaris corporatius, de forma recursiva) s'han eliminat amb ella. Sempre 0 per a una sessió de KYC.