सत्र बैच हटाएँ API: KYC क्लीनअप

curl

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

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

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

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

POST

sessions

delete

curl

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

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

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

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

व्यवहार

हर मेल खाने वाले सत्र को ठीक उसी तरह हटाया जाता है जैसे सत्र हटाएँ से हटाया जाता है: सत्र, उसके सभी सत्यापन प्रयास, उसका निर्णय और निकाला गया डेटा, उसके सुविधा रिकॉर्ड, और उसकी सभी संग्रहीत फ़ाइलें हटा दी जाती हैं। सत्र हर read endpoint से गायब हो जाता है, और पहले जारी किए गए मीडिया URL काम करना बंद कर देते हैं। हटाए गए सत्र के लिए कतार में रखी गई webhook डिलीवरी और उनके पुनः प्रयास छोड़ दिए जाते हैं; जो webhook पहले ही डिलीवर हो चुके हैं, उन पर कोई असर नहीं पड़ता। हटाना स्थायी है और इसे पलटा नहीं जा सकता। यदि चयनित सत्रों में से कोई भी अंतिम रूप दी गई नियामक रिपोर्ट का हिस्सा है, तो पूरा अनुरोध 409 लौटाता है और कुछ भी नहीं हटाया जाता। रिस्पॉन्स में code: in_filed_report होता है और हर रिपोर्ट का नाम दिया जाता है। हर रिपोर्ट को रिपोर्ट हटाएँ से हटाएँ, फिर यह अनुरोध दोबारा भेजें। रिपोर्ट हटाने से सत्र नहीं हटता; जब तक आप यह अनुरोध दोबारा नहीं भेजते, सत्र बना रहता है। session_numbers से चुने गए हों या delete_all से, मेल खाने वाले सत्रों की संख्या तय करती है कि अनुरोध का उत्तर कैसे दिया जाएगा:

मेल खाने वाले सत्र	रिस्पॉन्स
20 तक	उन्हें हटाने के बाद `200 OK`, जिसके `results` में हर मेल खाने वाले सत्र का एक परिणाम होता है।
20 से अधिक	एक हटाने वाले जॉब के साथ `202 Accepted`। सत्र पृष्ठभूमि में हटाए जाते हैं; जॉब पूरा होने तक सत्र हटाने का जॉब प्राप्त करें पर पोल करते रहें।

परिणाम तभी पुष्टि करता है कि सत्र हटा दिया गया है, जब उसका face_retention_outcome failed_retryable न हो: ऐसा सत्र नहीं हटाया गया है और अब भी अपनी जगह पर है, इसलिए ऐसे परिणाम को हटाने की पुष्टि नहीं, बल्कि पुनः प्रयास योग्य विफलता मानें। आपके एप्लिकेशन में किसी लाइव KYC सत्र से मेल न खाने वाली संख्याएँ छोड़ दी जाती हैं और results में नहीं आतीं।

`delete_all` को फ़िल्टर से सीमित करना

delete_all: true के साथ आप सत्र सूची के फ़िल्टर से चयन को सीमित कर सकते हैं। हर फ़िल्टर के आगे filter_ लगा होता है। उनके मान वही होते हैं जो क्वेरी पैरामीटर के होते हैं। जो फ़िल्टर कई मान लेते हैं (status, workflow_id, country, region, document_type, document_name, session_type, warning, organization_name) वे अल्पविराम से अलग की गई स्ट्रिंग या एरे स्वीकार करते हैं:

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

फ़िल्टर केवल delete_all के साथ लागू होते हैं; session_numbers के साथ उनकी जाँच होती है, पर चयन नहीं बदलता।
बाकी हर फ़िल्टर एक ही मान लेता है। एरे को अल्पविराम से अलग किए गए एक मान में जोड़ दिया जाता है, इसलिए कई तारीखें, UUID या api_service मान दिए जाने पर 400 लौटता है, और कई vendor_data, search या screened_full_name टेक्स्ट को वैकल्पिक मिलानों के रूप में नहीं देखा जाता।
खाली मान वाला फ़िल्टर अनदेखा किया जाता है, इसलिए वह चयन को सीमित नहीं करता।
कोई अज्ञात filter_* कुंजी 400 {"filter_reviewer": "Unknown filter."} लौटाती है, और जो मान पढ़ा नहीं जा सकता, उसके लिए उस filter_* कुंजी के साथ 400 मिलता है, जैसे {"filter_date_from": ["Enter a valid date."]}। दोनों स्थितियों में कुछ नहीं हटाया जाता, इसलिए गलत टाइप किया गया फ़िल्टर हटाने के दायरे को कभी हर सत्र तक नहीं बढ़ाता।
हटाने वाला जॉब वही फ़िल्टर लागू करता है, और हर delete_all की तरह वह केवल अनुरोध से पहले बनाए गए सत्रों पर लागू होता है।

प्रतिधारण और निर्देश फ़ील्ड

यह endpoint उन्हीं वैकल्पिक फ़ील्ड्स को स्वीकार करता है जो एकल-सत्र endpoint स्वीकार करता है, और उन्हें हर मेल खाने वाले सत्र पर लागू करता है:

फ़ील्ड	प्रकार	विवरण
`retain_face_embeddings`	boolean या null	इस अनुरोध के लिए एप्लिकेशन की `face_retention_policy` को बदलें।
`face_retention_days`	integer (1-3650)	बनाए रखे गए टेम्पलेट के लिए सीमित अवधि। प्रतिधारण के समय आवश्यक, जब तक एप्लिकेशन `face_retention_days` सेट न करे।
`face_retention_deadline`	datetime (ISO 8601)	वैकल्पिक कठोर समाप्ति, जो भविष्य में होनी चाहिए।
`deletion_instruction`	`operational_session_delete` (डिफ़ॉल्ट) या `privacy_erasure`	`privacy_erasure` हर सत्र के लिए सत्र हटाने से पहले उसके उपयोगकर्ता के हर बनाए रखे गए टेम्पलेट को मिटा देता है, और इसे `retain_face_embeddings: true` के साथ नहीं जोड़ा जा सकता।
`instruction_id`	string (अधिकतम 255)	इस निर्देश के लिए आपका स्थायी संदर्भ। इसे ऑडिट ट्रेल और हर बनाए रखे गए टेम्पलेट पर दर्ज किया जाता है।

बनाए रखे गए टेम्पलेट में क्या है और क्या नहीं, expires_at कैसे गणना होता है, और प्राइवेसी-इरेज़र निर्देश क्या करता है, यह जानने के लिए सत्र हटाएँ देखें।

हर सत्र का परिणाम

20 तक मेल खाने वाले सत्रों के लिए 200 OK हर सत्र का एक परिणाम लौटाता है:

{
  "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 वह समय है जब बनाए रखा गया टेम्पलेट हटाया जाएगा, और deleted_child_verifications यहाँ हमेशा 0 रहता है, क्योंकि यह endpoint केवल KYC सत्र हटाता है।

`face_retention_outcome`	अर्थ
`deleted`	सत्र और उसका फ़ेस एम्बेडिंग हटा दिए गए हैं। डिफ़ॉल्ट व्यवहार।
`retained_with_user`	सत्र हटा दिया गया है। एक इमेज-रहित बायोमेट्रिक टेम्पलेट उपयोगकर्ता से जुड़ा रहता है; उसका ID `biometric_template_uuid` है।
`none`	सत्र में हटाने या बनाए रखने के लिए कोई फ़ेस एम्बेडिंग नहीं था।
`ineligible_no_vendor_user`	प्रतिधारण माँगा गया था, पर सत्र किसी उपयोगकर्ता से जुड़ा नहीं है, इसलिए कोई टेम्पलेट नहीं जोड़ा जा सकता। सत्र और उसका एम्बेडिंग हटा दिए गए हैं।
`failed_retryable`	जिस समूह के साथ यह सत्र हटाया जाना था, वह हटाया नहीं जा सका, क्योंकि कोई स्टोरेज सेवा, बायोमेट्रिक स्टोर या मॉनिटरिंग प्रदाता उपलब्ध नहीं था। यह सत्र नहीं हटाया गया है और अब भी अपनी जगह पर है। इसके लिए अनुरोध दोबारा चलाएँ; पुनः प्रयास एक ही टेम्पलेट तक पहुँचते हैं।

सत्र समूहों में हटाए जाते हैं। जब कोई समूह नहीं हटाया जा सकता, तो उसके हर सत्र को failed_retryable के रूप में रिपोर्ट किया जाता है; दूसरे समूह प्रभावित नहीं होते और हटे रहते हैं।

बड़े चयन एक जॉब के रूप में चलते हैं

जब 20 से अधिक सत्र मेल खाते हैं, तो रिस्पॉन्स results के बजाय हटाने वाले जॉब के साथ 202 Accepted होता है:

{
  "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 के COMPLETED या FAILED होने तक हर कुछ सेकंड में सत्र हटाने का जॉब प्राप्त करें को बार-बार जाँचें।

जॉब यह बताता है कि प्रत्येक परिणाम में कितने सत्र आए, यह नहीं बताता कि उसने किन सत्रों को हटाया।
delete_all जॉब केवल आपके अनुरोध से पहले बनाए गए सत्र हटाता है। उसके चलते समय शुरू हुए सत्र नहीं हटाए जाते।
आपके अनुरोध के प्रतिधारण और निर्देश फ़ील्ड उन सभी सत्रों पर लागू होते हैं जिन्हें जॉब हटाता है।
यदि कोई समूह अभी नहीं हटाया जा सकता, तो जॉब उसके लिए स्वयं पुनः प्रयास करता है।
FAILED जॉब अपना कारण error में बताता है। जिन सत्रों तक वह नहीं पहुँच पाया, वे अब भी मौजूद हैं: उन्हें हटाने के लिए अनुरोध दोहराएँ।

उदाहरण

संख्या के अनुसार हटाएँ
हटाएँ और टेम्पलेट रखें
गोपनीयता के लिए मिटाना
सभी हटाएँ और जॉब की जाँच करें

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"

204 रिस्पॉन्स से माइग्रेशन

इस रिलीज़ से पहले यह endpoint 204 No Content लौटाता था। अब यह results[] के साथ 200 OK, या 20 से अधिक मेल खाने वाले सत्रों के लिए हटाने वाले जॉब के साथ 202 Accepted लौटाता है। जो क्लाइंट 204 की जाँच करते हैं, उन्हें अपडेट करें। डिफ़ॉल्ट हटाने का व्यवहार नहीं बदला है: मौजूदा एप्लिकेशन तब तक delete_with_session पर रहते हैं जब तक आप नीति को स्पष्ट रूप से नहीं बदलते।

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json

session_numbers

string[]

हटाए जाने वाले KYC सत्रों के संख्यात्मक session_number मान, केवल-अंक स्ट्रिंग के रूप में (JSON नंबर भी स्वीकार किए जाते हैं और ज़बरन बदले जाते हैं)। आवश्यक है जब तक कि delete_all true न हो; एक खाली सूची 400 लौटाती है। कोई भी गैर-अंक प्रविष्टि पूरे अनुरोध को 400 के साथ अस्वीकार कर देती है (जब तक कि delete_all true न हो, जिस स्थिति में सत्यापन छोड़ दिया जाता है और प्रविष्टियों को अनदेखा कर दिया जाता है)। वे नंबर जो आपके एप्लिकेशन में किसी लाइव सत्र से मेल नहीं खाते हैं, उन्हें चुपचाप छोड़ दिया जाता है।

Minimum array length: 1

Pattern: ^[0-9]+$

उदाहरण:

["1001", "1002", "1003"]

delete_all

boolean

डिफ़ॉल्ट:false

जब true होता है, तो कॉलिंग एप्लिकेशन में प्रत्येक शेष KYC सत्र हटा दिया जाता है और session_numbers को अनदेखा कर दिया जाता है, जब तक कि आप filter_* कुंजियों के साथ चयन को सीमित न करें। 20 से अधिक मेल खाने वाले सत्र एक विलोपन जॉब (202) के रूप में चलते हैं जो केवल अनुरोध से पहले बनाए गए सत्रों को कवर करता है। डिफ़ॉल्ट रूप से false होता है। अपरिवर्तनीय; कोई पुष्टि चरण नहीं है।

उदाहरण:

false

retain_face_embeddings

boolean | null

इस विलोपन के लिए एप्लिकेशन की face_retention_policy को ओवरराइड करें। true सत्र हटाए जाने के बाद सत्र के उपयोगकर्ता से जुड़े एक छवि-मुक्त चेहरे के बायोमेट्रिक टेम्पलेट को रखता है; false सत्र के साथ फ़ेस एम्बेडिंग को हटा देता है; एप्लिकेशन नीति का पालन करने के लिए छोड़ दें या null रखें। KYB सत्रों के लिए और बिना फ़ेस एम्बेडिंग वाले सत्रों के लिए अनदेखा किया जाता है।

उदाहरण:

true

face_retention_days

integer

किसी बनाए रखे गए टेम्पलेट के लिए सीमित प्रतिधारण अवधि, दिनों में। जब कोई टेम्पलेट बनाए रखा जाता है तो यह आवश्यक होता है, जब तक कि एप्लिकेशन पहले से ही face_retention_days सेट न कर दे। टेम्पलेट की expires_at इस अवधि, एप्लिकेशन की सामान्य डेटा प्रतिधारण विंडो और face_retention_deadline में से जो सबसे पहले हो, वह होती है।

आवश्यक सीमा: 1 <= x <= 3650

उदाहरण:

365

face_retention_deadline

string<date-time>

प्रतिधारित टेम्पलेट के लिए वैकल्पिक हार्ड समाप्ति। भविष्य की होनी चाहिए।

उदाहरण:

"2027-08-28T00:00:00Z"

deletion_instruction

enum<string>

डिफ़ॉल्ट:operational_session_delete

आपके द्वारा दिए जा रहे निर्देश का वर्ग। operational_session_delete सत्र को हटा देता है और केवल तभी टेम्पलेट को बनाए रखता है जब नीति या retain_face_embeddings ऐसा कहे। privacy_erasure सत्र को हटाने से पहले सत्र के उपयोगकर्ता से जुड़े प्रत्येक बनाए रखे गए बायोमेट्रिक टेम्पलेट को मिटा देता है, इसे एप्लिकेशन नीति द्वारा ओवरराइड नहीं किया जा सकता है, और इसे retain_face_embeddings: true (400) के साथ जोड़ा नहीं जा सकता है।

उपलब्ध विकल्प:

operational_session_delete,

privacy_erasure

उदाहरण:

"operational_session_delete"

instruction_id

string

इस विलोपन निर्देश के लिए आपका स्थायी संदर्भ (उदाहरण के लिए एक इरेज़र-टिकट id)। ऑडिट ट्रेल पर और किसी भी बनाए रखे गए टेम्पलेट पर रिकॉर्ड किया जाता है। छोड़ दिए जाने पर Didit द्वारा जनरेट किया जाता है।

Maximum string length: 255

उदाहरण:

"dsar-2026-0142"

filter_status

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के status फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_vendor_data

string

delete_all को उन सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के vendor_data फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को एक अल्पविराम से अलग किए गए टेक्स्ट में जोड़ दिया जाता है, इसलिए कई मान विकल्पों के रूप में मेल नहीं खाते हैं। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_search

string

delete_all को उन सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के search फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को एक अल्पविराम से अलग किए गए टेक्स्ट में जोड़ दिया जाता है, इसलिए कई मान विकल्पों के रूप में मेल नहीं खाते हैं। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_workflow_id

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के workflow_id फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_date_from

string<date>

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के date_from फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को अल्पविराम से अलग किए गए एक मान में जोड़ा जाता है, इसलिए कई मानों को 400 के साथ अस्वीकार कर दिया जाता है। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_date_to

string<date>

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के date_to फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को अल्पविराम से अलग किए गए एक मान में जोड़ा जाता है, इसलिए कई मानों को 400 के साथ अस्वीकार कर दिया जाता है। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_country

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के country फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_document_type

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के document_type फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_document_name

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के document_name फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_region

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के region फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_didit_internal_id

string<uuid>

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के didit_internal_id फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को अल्पविराम से अलग किए गए एक मान में जोड़ा जाता है, इसलिए कई मानों को 400 के साथ अस्वीकार कर दिया जाता है। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_session_type

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के session_type फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_api_service

string

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के api_service फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को अल्पविराम से अलग किए गए एक मान में जोड़ा जाता है, इसलिए कई मानों को 400 के साथ अस्वीकार कर दिया जाता है। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_screened_full_name

string

delete_all को उन सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के screened_full_name फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को एक अल्पविराम से अलग किए गए टेक्स्ट में जोड़ दिया जाता है, इसलिए कई मान विकल्पों के रूप में मेल नहीं खाते हैं। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_warning

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के warning फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_status_initialized_as_in_review

boolean

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के status_initialized_as_in_review फ़िल्टर से मेल खाते हैं। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

filter_is_kyc_to_be_reviewed

boolean

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के is_kyc_to_be_reviewed फ़िल्टर से मेल खाते हैं। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_euuid

string<uuid>

delete_all को उन्हीं सत्रों तक सीमित करता है जो समान मान के साथ List Sessions के euuid फ़िल्टर से मेल खाते हैं। एक मान, कोई सूची नहीं: एक ऐरे को अल्पविराम से अलग किए गए एक मान में जोड़ा जाता है, इसलिए कई मानों को 400 के साथ अस्वीकार कर दिया जाता है। delete_all के बिना अनदेखा किया जाता है। खाली मान को अनदेखा किया जाता है और यह चयन को सीमित नहीं करता है।

filter_organization_name

delete_all को उन सत्रों तक सीमित करता है जो समान मानों के साथ List Sessions के organization_name फ़िल्टर से मेल खाते हैं। अल्पविराम से अलग की गई स्ट्रिंग या एक ऐरे। API कुंजी के साथ यह केवल आपके अपने संगठन के नाम से मेल खा सकता है, इसलिए यह आपके सभी सत्रों का चयन करता है या किसी का भी नहीं। delete_all के बिना अनदेखा किया जाता है। रिक्त मान को अनदेखा कर दिया जाता है और यह चयन को सीमित नहीं करता है।

प्रतिक्रिया

अनुरोध में अधिकतम 20 सत्र मेल खाए और प्रोसेस किए गए। प्रति मेल खाने वाले सत्र के लिए एक परिणाम; जो संख्याएँ किसी से मेल नहीं खाती हैं (अज्ञात या पहले ही हटाई जा चुकी हैं) उन्हें छोड़ दिया जाता है और वे दिखाई नहीं देती हैं। परिणाम हटाए जाने की पुष्टि करता है, सिवाय इसके कि जब face_retention_outcome failed_retryable हो: वह सत्र हटाया नहीं गया था और उसका पुनः प्रयास किया जाना चाहिए।

results

object[]

Show child attributes

अंतिम संशोधन 7 नवंबर 2026

​व्यवहार

​delete_all को फ़िल्टर से सीमित करना

​प्रतिधारण और निर्देश फ़ील्ड

​हर सत्र का परिणाम

​बड़े चयन एक जॉब के रूप में चलते हैं

​उदाहरण

​204 रिस्पॉन्स से माइग्रेशन

​संबंधित

प्राधिकरण

बॉडी

प्रतिक्रिया

व्यवहार

`delete_all` को फ़िल्टर से सीमित करना

प्रतिधारण और निर्देश फ़ील्ड

हर सत्र का परिणाम

बड़े चयन एक जॉब के रूप में चलते हैं

उदाहरण

204 रिस्पॉन्स से माइग्रेशन

संबंधित