Primers passos
Integració / SDK
Verificació d'usuaris
Verificació d'empreses
Monitoratge de transaccions
Registre de canviscurl -X POST \
https://verification.didit.me/v3/sessions/delete/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"session_numbers": ["1001", "1002", "1003"]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.batch_delete(
session_numbers=["1001", "1002", "1003"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.batchDelete({
session_numbers: ["1001", "1002", "1003"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{
SessionNumbers: didit.Some([]string{"1001", "1002", "1003"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.SessionsBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()
.sessionNumbers(List.of("1001", "1002", "1003"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->batchDelete([
'session_numbers' => ['1001', '1002', '1003'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.batch_delete(session_numbers: ["1001", "1002", "1003"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams
{
SessionNumbers = new string[] { "1001", "1002", "1003" },
});
Console.WriteLine(JsonSerializer.Serialize(result));Eliminació de sessions en lot: API de Didit
Amb Didit, elimina moltes sessions KYC per número o totes alhora. Fins a 20 donen resultat per sessió; més de 20 es fan com a tasca consultable.
curl -X POST \
https://verification.didit.me/v3/sessions/delete/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"session_numbers": ["1001", "1002", "1003"]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.batch_delete(
session_numbers=["1001", "1002", "1003"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.batchDelete({
session_numbers: ["1001", "1002", "1003"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{
SessionNumbers: didit.Some([]string{"1001", "1002", "1003"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.SessionsBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()
.sessionNumbers(List.of("1001", "1002", "1003"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->batchDelete([
'session_numbers' => ['1001', '1002', '1003'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.batch_delete(session_numbers: ["1001", "1002", "1003"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams
{
SessionNumbers = new string[] { "1001", "1002", "1003" },
});
Console.WriteLine(JsonSerializer.Serialize(result));Comportament
Cada sessió coincident s’elimina exactament igual que amb Eliminar sessió: s’eliminen la sessió, cada intent de verificació que conté, la seva decisió i les dades extretes, els seus registres de funcionalitats i tots els seus fitxers emmagatzemats. Desapareix de tots els endpoints de lectura i les URL de fitxers multimèdia emesos anteriorment deixen de resoldre’s. Els lliuraments de webhook que encara estiguin pendents per a una sessió eliminada, i els seus reintents, es descarten; els webhooks ja lliurats no es veuen afectats. L’eliminació és permanent i irreversible. Si alguna de les sessions seleccionades forma part d’un informe regulatori finalitzat, tota la sol·licitud retorna409 i no s’elimina res. La resposta usa code: in_filed_report i indica cada informe. Elimina cada informe amb Eliminar informe i després repeteix la sol·licitud. Eliminar l’informe no elimina la sessió; la sessió es manté fins que repeteixis aquesta sol·licitud.
El nombre de sessions coincidents determina com es respon la sol·licitud, tant si les selecciones amb session_numbers com amb delete_all:
| Sessions coincidents | Resposta |
|---|---|
| Fins a 20 | 200 OK quan s’hagin eliminat, amb un resultat per cada sessió coincident a results. |
| Més de 20 | 202 Accepted amb una tasca d’eliminació. Les sessions s’eliminen en segon pla; consulta Obtenir tasca d’eliminació de sessió fins que finalitzi. |
face_retention_outcome és failed_retryable: en aquest cas, la sessió no s’ha eliminat i continua al seu lloc, així que aquest resultat s’ha de tractar com un error que cal reintentar, mai com una confirmació d’eliminació. Els números que no coincideixen amb una sessió KYC activa a la teva aplicació s’ometen i no apareixen a results.
Restringir delete_all amb filtres
Amb delete_all: true pots restringir la selecció amb els filtres de Llistar sessions, cadascun amb el prefix filter_.
Accepten els mateixos valors que els paràmetres de consulta.
Un filtre que accepta diversos valors (status, workflow_id, country, region, document_type, document_name, session_type, warning, organization_name) accepta una cadena separada per comes o un array:
{
"delete_all": true,
"filter_status": ["Declined"],
"filter_workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"filter_date_from": "2026-09-01",
"filter_date_to": "2026-09-30"
}
- Els filtres només s’apliquen juntament amb
delete_all; ambsession_numberses comproven però no canvien la selecció. - Cada altre filtre accepta un sol valor.
Un array es converteix en un únic valor separat per comes, així que diverses dates, UUID o valors de
api_serviceretornen400, i diversos textos devendor_data,searchoscreened_full_nameno es comparen com a alternatives. - Un filtre amb un valor buit s’ignora, així que no restringeix la selecció.
- Una clau
filter_*desconeguda retorna400{"filter_reviewer": "Unknown filter."}, i un valor que no es pot llegir retorna400amb la claufilter_*corresponent, com{"filter_date_from": ["Enter a valid date."]}. En tots dos casos no s’elimina res, així que un filtre mal escrit mai amplia l’eliminació a totes les sessions. - Una tasca d’eliminació aplica els mateixos filtres i, com qualsevol
delete_all, només cobreix les sessions creades abans de la sol·licitud.
Camps de conservació i d’instrucció
L’endpoint accepta els mateixos camps opcionals que l’endpoint d’una sola sessió i els aplica a cada sessió coincident:| Camp | Tipus | Descripció |
|---|---|---|
retain_face_embeddings | boolean o null | Substitueix la face_retention_policy de l’aplicació per a aquesta sol·licitud. |
face_retention_days | integer (1-3650) | Durada de conservació finita de les plantilles conservades. Obligatori quan es conserva, tret que l’aplicació 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 | privacy_erasure purga totes les plantilles conservades de l’Usuari de cada sessió abans d’eliminar la sessió, i no es pot combinar amb retain_face_embeddings: true. |
instruction_id | string (màxim 255) | La teva referència duradora per a aquesta instrucció. Es registra al registre d’auditoria i a cada plantilla conservada. |
expires_at i què fa una instrucció d’esborrat per privacitat.
Resultats per sessió
Per a fins a 20 sessions coincidents,200 OK retorna un resultat per sessió:
{
"results": [
{ "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1001, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 },
{ "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e", "session_number": 1002, "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 },
{ "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1003, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 },
{ "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1004, "face_retention_outcome": "failed_retryable", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }
]
}
biometric_template_expires_at indica quan s’elimina una plantilla conservada, i deleted_child_verifications és sempre 0 aquí, perquè aquest endpoint elimina només sessions 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é ancorada a l’Usuari; el seu id és biometric_template_uuid. |
none | La sessió no tenia cap embedding facial per eliminar o conservar. |
ineligible_no_vendor_user | S’ha sol·licitat la conservació, però la sessió no està vinculada a un Usuari, així que no hi ha res a què ancorar una plantilla. La sessió i el seu embedding s’eliminen. |
failed_retryable | El grup amb què es va eliminar aquesta sessió no s’ha pogut eliminar, perquè un servei d’emmagatzematge, un magatzem biomètric o un proveïdor de monitoratge no estava disponible. Aquesta sessió no s’elimina i continua al seu lloc. Torna a executar la sol·licitud per a aquesta sessió; els reintents convergeixen en una única plantilla. |
failed_retryable; els altres grups no es veuen afectats i continuen eliminats.
Les seleccions grans s’executen com una tasca
Quan hi ha més de 20 sessions que coincideixen, la resposta és202 Accepted amb una tasca d’eliminació en lloc de results:
{
"job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b",
"status": "PENDING",
"total": 250,
"processed": 0,
"outcomes": { "deleted": 0, "none": 0, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 },
"deleted_child_verifications": 0,
"error": null,
"created_at": "2026-10-09T10:15:00Z",
"completed_at": null
}
status sigui COMPLETED o FAILED.
- La tasca indica quantes sessions han acabat en cada resultat, però mai quines sessions ha eliminat.
- Una tasca de
delete_allelimina només les sessions creades abans de la teva sol·licitud. Les sessions iniciades mentre s’executa no s’eliminen. - Els camps de conservació i d’instruccions de la teva sol·licitud s’apliquen a totes les sessions que elimini la tasca.
- Si encara no es pot eliminar un grup, la tasca torna a intentar eliminar-lo automàticament.
- Una tasca
FAILEDn’explica el motiu aerror. Les sessions que encara no havia processat continuen al seu lloc: repeteix la sol·licitud per eliminar-les.
Exemples
- Eliminar per número
- Eliminar i conservar plantilles
- Esborrament per motius de privacitat
- Eliminar-ho tot i consultar la tasca
curl -X POST https://verification.didit.me/v3/sessions/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"session_numbers": ["1001", "1002", "1003"]}'
curl -X POST https://verification.didit.me/v3/sessions/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"session_numbers": ["1001", "1002"],
"retain_face_embeddings": true,
"face_retention_days": 365,
"instruction_id": "post-approval-cleanup-2026-08"
}'
curl -X POST https://verification.didit.me/v3/sessions/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"session_numbers": ["1001"],
"deletion_instruction": "privacy_erasure",
"instruction_id": "dsar-2026-0142"
}'
curl -X POST https://verification.didit.me/v3/sessions/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"delete_all": true}'
# More than 20 sessions matched: the response is 202 with a job_id.
curl https://verification.didit.me/v3/sessions/delete/JOB_ID/ \
-H "x-api-key: YOUR_API_KEY"
Migració de les respostes 204
Fins a aquesta versió, l’endpoint retornava204 No Content. Ara retorna 200 OK amb results[], o 202 Accepted amb una tasca d’eliminació quan hi ha més de 20 sessions que coincideixen. Actualitza els clients que comproven 204. El comportament d’eliminació per defecte no canvia: les aplicacions existents continuen utilitzant delete_with_session fins que canviïs explícitament la política.
Relacionats
- Eliminar la sessió
- Obtenir la tasca d’eliminació de sessions
- Plantilles biomètriques
- Conservació de dades
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.
Cos
Valors numèrics de session_number de les sessions de KYC que cal eliminar, com a cadenes que només contenen dígits (els números JSON també s'accepten i es converteixen). Obligatori tret que delete_all sigui true; una llista buida retorna 400. Qualsevol entrada que no sigui un dígit rebutja tota la sol·licitud amb 400 (tret que delete_all sigui true, cas en què s'omet la validació i s'ignoren les entrades). Els números que no coincideixin amb una sessió activa a la teva aplicació s'ometen silenciosament.
1^[0-9]+$["1001", "1002", "1003"]
Quan és true, s'eliminen totes les sessions de KYC restants a l'aplicació que fa la crida i s'ignora session_numbers, tret que restringeixis la selecció amb claus filter_*. Si hi ha més de 20 sessions coincidents, s'executa com una tasca d'eliminació (202) que només cobreix les sessions creades abans de la sol·licitud. Per defecte és false. Irreversible; no hi ha cap pas de confirmació.
false
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"
Restringeix un delete_all a les sessions que coincideixen amb el filtre status de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre vendor_data de List Sessions, amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre search de List Sessions, amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre workflow_id de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre date_from de Llistar sessions, amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb 400. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre date_to de Llistar sessions, amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb 400. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre country de Llistar sessions, amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre document_type de Llistar sessions, amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre document_name de Llistar sessions, amb els mateixos valors. Una cadena separada per comes o una matriu. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre region de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre didit_internal_id de Llistar sessions, amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb 400. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre session_type de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre api_service de Llistar sessions, amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb 400. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre screened_full_name de List Sessions, amb el mateix valor. Un sol valor, no una llista: un array s'uneix en un únic text separat per comes, de manera que diversos valors no es comparen com a alternatives. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre warning de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre status_initialized_as_in_review de List Sessions, amb els mateixos valors. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre is_kyc_to_be_reviewed de Llistar sessions, amb els mateixos valors. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre euuid de Llistar sessions, amb el mateix valor. Un sol valor, no una llista: una matriu s'uneix en un únic valor separat per comes, de manera que diversos valors es rebutgen amb 400. S'ignora sense delete_all. Un valor buit s'ignora i no redueix la selecció.
Restringeix un delete_all a les sessions que coincideixen amb el filtre organization_name de List Sessions, amb els mateixos valors. Una cadena separada per comes o un array. Amb una clau d'API només pot coincidir amb el nom de la teva pròpia organització, de manera que selecciona totes les teves sessions o cap. S'ignora sense delete_all. Un valor buit s'ignora i no restringeix la selecció.
Resposta
Fins a 20 sessions han coincidit i s'han processat a la sol·licitud. Un resultat per sessió coincident; els números que no han coincidit amb res (desconeguts o ja suprimits) s'ometen i no apareixen. Un resultat confirma la supressió excepte quan face_retention_outcome és failed_retryable: aquesta sessió NO s'ha suprimit i s'hauria de reintentar.
Show child attributes
Show child attributes