> ## 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: KYC और KYB सत्र फ़िल्टर करें

> Didit API के GET /v3/sessions/ से kind, status, workflow और vendor data द्वारा सत्यापन सत्र फ़िल्टर करें। KYC + KYB, pay-per-use मूल्य निर्धारण।



सत्र सूची प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`List Didit verification sessions for your application with filters and pagination.

Endpoint:
GET https://verification.didit.me/v3/sessions

Authentication:
Use the x-api-key header with your Didit API key. The key must hold read:sessions.

Query parameters:
\- session_kind ("user" | "business" | "all", default "user") — chooses which kind to list. "user" returns only KYC sessions (backward-compatible default). "business" returns only KYB. "all" concatenates both (KYB rows are appended; not interleaved by timestamp).
\- vendor_data (string) — exact match on your stable identifier.
\- didit_internal_id (UUID) — matches vendor_user_id.
\- status (one or more, comma-separated) — Approved, Declined, In Review, In Progress, Not Started, Expired, Abandoned, Kyc Expired, Resubmitted, Awaiting User.
\- workflow_id (one or more UUIDs, comma-separated).
\- country (one or more ISO-3 codes, comma-separated) — issuing-state for KYC, country_code for KYB.
\- region (one or more, comma-separated).
\- document_type (one or more, comma-separated).
\- date_from, date_to (ISO 8601 date) — inclusive on created_at.
\- search (string) - a complete displayed reference such as S-0001 (user) or B-0001 (business) matches only that session number and kind, ignoring leading zeros and letter case.
Other input searches the existing name, contact, document, registration-number and vendor_data fields.
\- tags (comma-separated tag ids) — sessions that carry any of them.
\- decided_from, decided_to (ISO 8601 datetimes) — sessions whose status last changed at or after / before the value.
\- limit (int, default 50), offset (int, default 0) — limit/offset pagination. Both accept values up to 1000000; larger values return 400.

Per-kind filters (silently ignored on the other kind): is_kyc_to_be_reviewed, status_initialized_as_in_review, session_type, api_service, screened_full_name, document_name, warning.

curl example:
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: <API_KEY>" \
\--data-urlencode "session_kind=all" \
\--data-urlencode "status=Approved,In Review" \
\--data-urlencode "date_from=2026-01-01" \
\--data-urlencode "limit=50"

Response envelope:
\{
"count": <int>,   // exact up to 100, capped at 100 beyond that: paginate with next
"next": "<url|null>",
"previous": "<url|null>",
"results": [ ...rows ]
}

Every row has:
\- session_id (UUID), session_kind ("user" | "business"), session_number, status, vendor_data, created_at.

KYC row extras: portrait_image, document_type, full_name, country (issuing state), phone_number, email_address, features, didit_internal_id, assignee, waiting_since, sla_due_at, top_warnings, warnings_count.

KYB row extras: workflow_type, workflow_label, company_name, registration_number, country (incorporation).

Each row is a LIGHT projection. For the full feature payload of a row, call GET /v3/session/{session_id}/decision/ — see /sessions-api/retrieve-session.

Failure modes:
\- 401 — invalid API key.
\- 403 — { "detail": "You do not have permission to perform this action." } when the key lacks read:sessions.
\- 400 — malformed UUIDs in filters are silently dropped (no error); malformed ISO dates return { "date_from": ["..."] }.

Common patterns:
\- Build a dashboard: paginate with limit + offset, sort newest-first (server orders by -session_number within each kind).
\- Find pending review queue: status=In Review.
\- Find a specific entity's sessions: vendor_data=<your-id>.
\- Refresh ongoing AML hits: filter by workflow_id of your AML workflow.

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

\</pre>



      
      

यहाँ पेस्ट करें

## सत्र प्रकार फ़िल्टर`session_kind` क्वेरी पैरामीटर का उपयोग करके चुनें कि किस प्रकार के सत्र लौटाए जाएँ:| मान | लौटाता है |
| - | - |
| `user` (डिफ़ॉल्ट) | केवल उपयोगकर्ता सत्यापन (KYC) सत्र। **बैकवर्ड-संगत व्यवहार** — यही व्यवहार पाने के लिए `session_kind` छोड़ दें। |
| `business` | केवल व्यवसाय सत्यापन (KYB) सत्र। |
| `all` | उपयोगकर्ता सत्यापन और व्यवसाय सत्यापन, दोनों प्रकार के सत्र, एक साथ जोड़कर। |रिस्पॉन्स की हर पंक्ति में `session_kind: "user" | "business"` शामिल होता है, ताकि आपका क्लाइंट हर पंक्ति की संरचना के आधार पर व्यवहार बदल सके।## सामान्य फ़िल्टरये फ़िल्टर दोनों प्रकारों पर लागू होते हैं (उपयोगकर्ता-केवल फ़िल्टर `session_kind=business` होने पर अनदेखे किए जाते हैं, और इसका उल्टा भी):| क्वेरी पैरामीटर | विवरण |
| - | - |
| `session_kind` | `user`, `business` या `all`। डिफ़ॉल्ट `user`। |
| `vendor_data` | आपके पहचानकर्ता से सटीक मिलान। |
| `status` | एक या अधिक स्थितियाँ, अल्पविराम से अलग की गई, ठीक वैसे लिखी जैसी API उन्हें लौटाती है: `Approved`, `Declined`, `In Review` आदि (देखें [सत्यापन स्थितियाँ](https://docs.didit.me/hi/integration/verification-statuses.md))। |
| `workflow_id` | उपयोग किए गए वर्कफ़्लो के आधार पर फ़िल्टर करें। |
| `country` | देश कोड फ़िल्टर (उपयोगकर्ता: `issuing_states`, व्यवसाय: `country_code`)। |
| `date_from`, `date_to` | निर्माण-तिथि की अवधि (ISO 8601)। |
| `tags` | अल्पविराम से अलग किए गए टैग आईडी। जिन सत्रों में इनमें से कोई भी टैग हो, वे लौटाए जाते हैं। |
| `decided_from`, `decided_to` | ISO 8601 डेटाटाइम। जिन सत्रों की स्थिति उस अवधि में अंतिम बार बदली गई, वे लौटाए जाते हैं (आरंभ शामिल और अंत अपवर्जित)। इसमें निर्माण के समय के बजाय अंतिम स्थिति-परिवर्तन का समय उपयोग होता है। |
| `search` | दिखाया गया पूरा संदर्भ, जैसे `S-0001` या `B-0001`, केवल उसी सत्र संख्या और प्रकार से मेल खाता है, अग्रणी शून्य और अक्षरों के केस को अनदेखा करते हुए। अन्य इनपुट मौजूदा नाम, संपर्क, दस्तावेज़, पंजीकरण-संख्या और `vendor_data` फ़ील्ड में खोजा जाता है। |## उदाहरण> [tab] उपयोगकर्ता सत्यापन (KYC) सत्र सूचीबद्ध करें (डिफ़ॉल्ट)
>
> ```bash theme={null}
> curl -G https://verification.didit.me/v3/sessions/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   --data-urlencode "vendor_data=user-42"
> ```
>
> **रिस्पॉन्स (संक्षिप्त):**
>
> ```json theme={null}
> {
>   "count": 3,
>   "next": null,
>   "previous": null,
>   "results": [
>     {
>       "session_id": "...",
>       "session_kind": "user",
>       "session_number": 1024,
>       "session_url": "...",
>       "portrait_image": "...",
>       "document_type": "Passport",
>       "full_name": "John Doe",
>       "country": "GBR",
>       "status": "Approved",
>       "vendor_data": "user-42",
>       "didit_internal_id": "...",
>       "created_at": "2026-04-10T09:00:00Z",
>       "features": "ID_VERIFICATION,LIVENESS,FACE_MATCH,AML",
>       "phone_number": "+14155550123",
>       "email_address": "jane@example.com",
>       "additional_details": null
>     }
>   ]
> }
> ```> [tab] व्यवसाय सत्यापन (KYB) सत्र सूचीबद्ध करें
>
> ```bash theme={null}
> curl -G https://verification.didit.me/v3/sessions/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   --data-urlencode "session_kind=business" \
>   --data-urlencode "status=Approved"
> ```
>
> **रिस्पॉन्स (संक्षिप्त):**
>
> ```json theme={null}
> {
>   "count": 1,
>   "next": null,
>   "previous": null,
>   "results": [
>     {
>       "session_id": "...",
>       "session_kind": "business",
>       "session_number": 89,
>       "status": "Approved",
>       "vendor_data": "biz-acme-001",
>       "created_at": "2026-04-01T09:00:00Z",
>       "workflow_id": "wf_kyb_standard",
>       "workflow_type": "business",
>       "workflow_label": "Standard KYB",
>       "company_name": "Acme Corporation Limited",
>       "registration_number": "12345678",
>       "country": "GBR"
>     }
>   ]
> }
> ```> [tab] दोनों प्रकार सूचीबद्ध करें
>
> ```bash theme={null}
> curl -G https://verification.didit.me/v3/sessions/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   --data-urlencode "session_kind=all" \
>   --data-urlencode "date_from=2026-04-01T00:00:00Z"
> ```
>
> एक ही `results` सरणी में उपयोगकर्ता सत्यापन और व्यवसाय सत्यापन की पंक्तियाँ लौटाता है। उपभोक्ताओं को हर पंक्ति के लिए `session_kind` के आधार पर व्यवहार बदलना चाहिए।
>
> > [!NOTE]
> >
> > `all` मोड में परिणाम समय-चिह्न के अनुसार मिलाए नहीं जाते, बल्कि एक के बाद एक जोड़े जाते हैं। अधिक मात्रा वाले मिश्रित ट्रैवर्सल के लिए हर प्रकार को अलग-अलग कॉल करें और क्लाइंट-साइड पर मिलाएँ।## सत्र के प्रकार के अनुसार पंक्तियों की संरचना अलग होती हैउपयोगकर्ता सत्यापन (KYC) की पंक्तियों में शामिल हैं: `portrait_image`, `document_type`, `full_name`, `country` (जारी करने वाला राज्य), `phone_number`, `email_address`, और कुछ समीक्षा फ़ील्ड: `assignee` (वह Console समीक्षक जिसके पास सत्र है, या `null`), `waiting_since` और `sla_due_at` (केवल तभी सेट होते हैं जब सत्र `In Review` हो), `top_warnings` (सबसे महत्वपूर्ण चेतावनियाँ, हर एक के साथ `risk`, `feature`, `log_type` और `short_description`) और `warnings_count`।व्यवसाय सत्यापन (KYB) की पंक्तियों में शामिल हैं: `workflow_type`, `workflow_label`, `company_name`, `registration_number`, `country` (निगमन का देश)।दोनों में ये शामिल हैं: `session_id`, `session_kind`, `session_number`, `status`, `vendor_data`, `created_at`।पूरी सुविधा मैट्रिक्स के लिए देखें [सत्र अवलोकन](https://docs.didit.me/hi/sessions-api/overview.md)।## पेजिनेशनपेजिनेशन `limit` (डिफ़ॉल्ट `50`) और `offset` (डिफ़ॉल्ट `0`) का उपयोग करता है, और रिस्पॉन्स में पूर्ण `next` और `previous` URL लौटाता है। दोनों पैरामीटर अधिकतम `1000000` तक के मान स्वीकार करते हैं; इससे बड़ा मान `400` लौटाता है।`count` `100` तक सटीक होता है और उससे आगे `100` पर ही रुक जाता है, इसलिए इसे कुल संख्या के रूप में उपयोग न करें। तब तक `next` URL माँगते रहें जब तक वह `null` न हो जाए। `session_kind=all` के साथ, `count` दोनों प्रकारों का योग होता है, जिनमें से हर एक `100` पर सीमित होता है।## संबंधित- [सत्र अवलोकन](https://docs.didit.me/hi/sessions-api/overview.md)
- [सत्र प्राप्त करें](https://docs.didit.me/hi/sessions-api/retrieve-session.md) — एक ही पंक्ति का पूरा निर्णय
- [व्यवसाय अवलोकन](https://docs.didit.me/hi/entities/businesses/overview.md) — सभी सत्रों में एकत्रित व्यवसाय इकाई
- [उपयोगकर्ता अवलोकन](https://docs.didit.me/hi/entities/users/overview.md) — सभी सत्रों में एकत्रित उपयोगकर्ता इकाई


## OpenAPI

````yaml hi/openapi-25.json GET /v3/sessions/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/sessions/:
    get:
      tags:
        - Sessions
      summary: फ़िल्टर और पेजिनेशन के साथ सत्यापन सत्रों (KYC और/या KYB) की सूची बनाएं
      description: >-
        आपकी API कुंजी द्वारा पहचानी गई एप्लिकेशन के लिए सत्यापन सत्रों की एक
        पेजिनेटेड सूची लौटाता है, सबसे नए पहले (अवरोही `session_number`)।


        **कैनोनिकल URL:** रूट `/v3/sessions/` (ट्रेलिंग स्लैश) है। बिना स्लैश के
        `/v3/sessions` पर किए गए अनुरोधों को क्वेरी स्ट्रिंग सुरक्षित रखते हुए
        स्लैश वाले URL पर `301` रीडायरेक्ट प्राप्त होता है; अधिकांश HTTP क्लाइंट
        GET पर पारदर्शी रूप से इसका पालन करते हैं।


        **इस endpoint बनाम webhooks का उपयोग कब करें।** डैशबोर्ड, बैक-ऑफ़िस खोज,
        मिलान (reconciliation) और बैच एक्सपोर्ट के लिए इस endpoint का उपयोग
        करें। अलग-अलग सत्यापनों की प्रगति को ट्रैक करने के लिए इसे पोल न करें -
        इसके बजाय [webhooks](/hi/integration/webhooks) कॉन्फ़िगर करें, जो सत्र
        के बदलते ही `status.updated` इवेंट पुश करते हैं। किसी एक सत्र के पूर्ण
        परिणाम के लिए, `GET /v3/session/{sessionId}/decision/` को कॉल करें।


        **KYC और KYB सत्र।** `session_kind` यह चुनता है कि किस प्रकार के सत्र
        सूचीबद्ध किए जाएँ:

        - `user` (डिफ़ॉल्ट) - केवल उपयोगकर्ता सत्यापन (KYC) सत्र।
        बैकवर्ड-कम्पैटिबल व्यवहार।

        - `business` - केवल व्यवसाय सत्यापन (KYB) सत्र। पंक्तियों का आकार अलग और
        छोटा होता है (रिस्पॉन्स स्कीमा देखें)।

        - `all` - एक ही रिस्पॉन्स में दोनों प्रकार: समान `limit`/`offset` के लिए
        KYC पेज और KYB पेज को `results` में संयोजित किया जाता है (पहले KYC
        पंक्तियाँ), इसलिए एक पेज में `2 x limit` पंक्तियों तक हो सकती हैं।
        `count` दोनों प्रकारों का योग है और `next`/`previous` KYC-पक्ष के
        पेजिनेशन को दर्शाते हैं। मिश्रित डेटा के सख्त पेजिनेशन के लिए, `user` और
        `business` को अलग-अलग कॉल करें।


        प्रत्येक पंक्ति में एक `session_kind` डिस्क्रिमिनेटर (`"user"` या
        `"business"`) होता है।


        **पेजिनेशन।** मानक limit/offset: `limit` (डिफ़ॉल्ट 50) और `offset`
        (डिफ़ॉल्ट 0), साथ ही `next`/`previous` तैयार पेज URL। KYC पंक्तियों के
        लिए `count` सटीक होता है। KYB पंक्तियों के लिए `count` की गणना सीमित
        स्कैन के साथ की जाती है और यह अधिकतम 100 तक सीमित होती है - जब 100 से
        अधिक मिलान होते हैं तो यह 100 पर ही रहती है, इसलिए `count` से कुल पेजों
        की गणना करने के बजाय `next` का उपयोग करके (या यह जांच कर कि क्या पूरा
        पेज वापस आया है) पुनरावृत्ति करें।


        **फ़िल्टर सिमेंटिक्स।** सभी फ़िल्टर AND के साथ संयोजित होते हैं और KYC
        पंक्तियों पर लागू होते हैं। जब `session_kind` का मान `business` या `all`
        हो, तो KYB पक्ष साझा पैरामीटर `vendor_data`, `status`, `workflow_id`,
        `country` (रजिस्ट्री-कंपनी देश कोड), `date_from`, `date_to`, `search`
        (कंपनी का नाम, पंजीकरण संख्या — बिना सेपरेटर के पंजीकरण संख्या टाइप
        करें, उदाहरण के लिए `DPC001`, न कि `DPC-001` — vendor_data, सत्र संख्या,
        या सत्र UUID), `warning`, और `organization_name` का पालन करता है; शेष
        केवल-KYC फ़िल्टर KYB पंक्तियों के लिए अनदेखे कर दिए जाते हैं। कॉमा से
        अलग किए गए पैरामीटर (`status`, `country`, `document_type`, `region`,
        `workflow_id`, `document_name`, `warning`, `organization_name`,
        `session_type`) सूचीबद्ध मानों में से किसी से भी मेल खाते हैं (पैरामीटर
        के भीतर OR)। `vendor_data` एक सटीक मिलान है - आंशिक मिलान के लिए
        `search` का उपयोग करें। सूची फ़िल्टर में अज्ञात मान केवल कोई पंक्ति नहीं
        लौटाते हैं (कोई त्रुटि नहीं); गलत प्रारूप वाले टाइप किए गए मान
        (`date_from`, `date_to`, `didit_internal_id`, `api_service`,
        `session_kind`) प्रति-फ़ील्ड त्रुटि ऑब्जेक्ट के साथ `400` लौटाते हैं।


        **खोज।** `search` इनपुट के अनुसार अनुकूलित होता है: एक पूर्ण UUID
        `session_id` खोजता है; अंक (वैकल्पिक `+ - . space` के साथ) सत्र-संख्या
        उपसर्ग, दस्तावेज़/व्यक्तिगत संख्या, फ़ोन-नंबर उपसर्ग, या `vendor_data`
        से मेल खाते हैं; `@` वाले मान ईमेल उपसर्गों से मेल खाते हैं; कोई भी अन्य
        टेक्स्ट नामों (एक्सेंट-असंवेदनशील) और `vendor_data` से मेल खाता है।


        कोई निश्चित प्रति-endpoint रेट लिमिट लागू नहीं है, लेकिन सूची की पोलिंग
        कम ही रखें और रीयल-टाइम अपडेट के लिए webhooks पर भरोसा करें।
      operationId: get_v3_sessions
      parameters:
        - name: session_kind
          in: query
          required: false
          description: >-
            किस प्रकार के सत्रों को सूचीबद्ध करना है: `user` (केवल KYC,
            डिफ़ॉल्ट), `business` (केवल KYB), या `all` (दोनों, संयोजित - मर्ज
            किए गए पेजिनेशन सिमेंटिक्स के लिए विवरण देखें)। मिलान केस-इनसेंसिटिव
            है (`BUSINESS` काम करता है); `user`/`business`/`all` के केस वेरिएंट
            के अलावा कोई भी मान `400` लौटाता है।
          schema:
            type: string
            enum:
              - user
              - business
              - all
            default: user
          example: all
        - name: limit
          in: query
          required: false
          description: >-
            प्रति पेज पंक्तियों की अधिकतम संख्या (`session_kind=all` होने पर
            प्रति प्रकार)। डिफ़ॉल्ट 50 है।
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          example: 20
        - name: offset
          in: query
          required: false
          description: >-
            पहली लौटाई गई पंक्ति से पहले छोड़ी जाने वाली पंक्तियों की संख्या।
            डिफ़ॉल्ट रूप से 0 है। रिस्पॉन्स से `next`/`previous` URL का अनुसरण
            करना बेहतर है।
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          example: 20
        - name: status
          in: query
          required: false
          description: >-
            शामिल करने के लिए सत्र स्थितियों की अल्पविराम से अलग की गई सूची,
            उदाहरण के लिए `Approved,In Review`। मान केस-संवेदनशील हैं; [सत्यापन
            स्थितियाँ](/hi/integration/verification-statuses) देखें। अज्ञात मान
            किसी से मेल नहीं खाते हैं।
          schema:
            type: string
          example: Approved,In Review
        - name: vendor_data
          in: query
          required: false
          description: >-
            सत्र निर्माण के समय आपके द्वारा भेजे गए `vendor_data` (आपका अपना
            उपयोगकर्ता/व्यवसाय पहचानकर्ता) पर सटीक-मिलान फ़िल्टर। आंशिक मिलानों
            के लिए इसके बजाय `search` का उपयोग करें।
          schema:
            type: string
          example: your-user-id-123
        - name: search
          in: query
          required: false
          description: >-
            प्रदर्शित किया गया पूरा संदर्भ जैसे `S-0001` (उपयोगकर्ता) या
            `B-0001` (व्यवसाय) केवल उसी सत्र संख्या और प्रकार से मेल खाता है;
            शुरुआती शून्य और अक्षरों का केस मिलान को प्रभावित नहीं करते हैं।
            स्मार्ट फ़्री-टेक्स्ट खोज। एक पूर्ण UUID `session_id` से मेल खाता
            है; संख्यात्मक इनपुट सत्र-संख्या उपसर्ग, दस्तावेज़/व्यक्तिगत संख्या,
            फ़ोन उपसर्ग, या `vendor_data` से मेल खाता है; `@` वाला इनपुट ईमेल
            उपसर्गों से मेल खाता है; अन्य टेक्स्ट नामों (एक्सेंट-असंवेदनशील) और
            `vendor_data` से मेल खाता है। अंकों वाला फ़्री टेक्स्ट
            दस्तावेज़/व्यक्तिगत-संख्या खोज फ़ील्ड और सत्र-संख्या उपसर्गों से भी
            मेल खाता है।
          schema:
            type: string
          example: jane doe
        - name: workflow_id
          in: query
          required: false
          description: >-
            अल्पविराम से अलग किए गए वर्कफ़्लो UUID (उन्हें Console में Workflows
            पेज पर खोजें)। सूची में अमान्य प्रारूप वाले UUID को अनदेखा कर दिया
            जाता है; यदि कोई भी मान्य नहीं है तो परिणाम रिक्त होता है।
          schema:
            type: string
          example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
        - name: date_from
          in: query
          required: false
          description: >-
            केवल इस तारीख (UTC) को या उसके बाद बनाए गए सत्र, प्रारूप
            `YYYY-MM-DD`। अमान्य तारीखें `400` लौटाती हैं।
          schema:
            type: string
            format: date
          example: '2026-06-01'
        - name: date_to
          in: query
          required: false
          description: >-
            केवल इस तारीख (UTC) तक बनाए गए सत्र, प्रारूप `YYYY-MM-DD`। KYC
            पंक्तियों के लिए पूरा दिन शामिल है; KYB पंक्तियों के लिए तुलना
            `created_at <= date_to` (आधी रात) है, इसलिए KYB सत्रों का पूरा दिन
            शामिल करने के लिए अगले दिन की तारीख का उपयोग करें।
          schema:
            type: string
            format: date
          example: '2026-06-30'
        - name: tags
          in: query
          required: false
          schema:
            type: string
          description: >-
            अल्पविराम से अलग किए गए टैग id (आपके एप्लिकेशन के `tags`)। उन सत्रों
            को लौटाता है जिनमें इनमें से कोई भी शामिल है। वे id जो मान्य UUID
            नहीं हैं, अनदेखे कर दिए जाते हैं, और जब कोई भी मान्य नहीं होता है तो
            सूची खाली होती है।
        - name: decided_from
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            ISO 8601 दिनांक-समय। उन सत्रों को लौटाता है जिनकी स्थिति पिछली बार
            इस समय पर या इसके बाद बदली थी। यह निर्माण समय पर नहीं, बल्कि अंतिम
            स्थिति परिवर्तन के समय पर फ़िल्टर करता है।
        - name: decided_to
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            ISO 8601 दिनांक-समय (datetime)। उन सत्रों को लौटाता है जिनकी स्थिति
            पिछली बार इससे पहले बदली थी। हाफ़-ओपन विंडो के लिए `decided_from` के
            साथ संयोजित करें।
        - name: country
          in: query
          required: false
          description: >-
            कॉमा से अलग किया गया देश फ़िल्टर। KYC पंक्तियों के लिए: पहचान
            दस्तावेज़ जारीकर्ता राज्य के ISO 3166-1 alpha-3 कोड (उदा.
            `ESP,USA`), जो राष्ट्रीयता से भिन्न हो सकते हैं। KYB पंक्तियों के
            लिए: रजिस्ट्री कंपनी का देश कोड।
          schema:
            type: string
          example: ESP,USA
        - name: document_type
          in: query
          required: false
          description: >-
            सत्र में सत्यापित कॉमा से अलग किए गए पहचान दस्तावेज़ प्रकार कोड
            (केवल KYC पंक्तियाँ): `P` (पासपोर्ट), `ID` (पहचान पत्र), `DL`
            (ड्राइविंग लाइसेंस), `RP` (निवास परमिट), `SSC` (सोशल सिक्योरिटी
            कार्ड), `HIC` (स्वास्थ्य बीमा कार्ड), `WP` (वर्क परमिट), `TC` (टैक्स
            कार्ड), `VISA`, `PSC` (पब्लिक सर्विस कार्ड), `BC` (जन्म प्रमाण
            पत्र), `OTHER`। ध्यान दें कि रिस्पॉन्स फ़ील्ड `document_type` में
            कोड नहीं, बल्कि प्रदर्शित नाम होता है।
          schema:
            type: string
          example: P,ID
        - name: document_name
          in: query
          required: false
          description: >-
            सटीक दस्तावेज़ नाम; कई नाम अल्पविराम से अलग करके भेजे जा सकते हैं,
            लेकिन मान को अल्पविराम पर केवल तभी विभाजित किया जाता है जब इसमें एक
            से अधिक ` - ` विभाजक हों (एम्बेडेड अल्पविराम वाले एकल नाम का मिलान
            पूरा किया जाता है)। नाम वे हैं जिन्हें दस्तावेज़ सत्यापन (आगे या
            पीछे के भाग) द्वारा पहचाना जाता है, उदाहरण के लिए `Spain - Id Card
            (2021)`। केवल KYC पंक्तियाँ।
          schema:
            type: string
          example: Spain - Id Card (2021)
        - name: region
          in: query
          required: false
          description: >-
            कॉमा से अलग किए गए दस्तावेज़ क्षेत्र/राज्य मान (प्रति क्षेत्र जारी
            किए गए दस्तावेज़ों के लिए, जैसे कि US ड्राइविंग लाइसेंस)। केवल KYC
            पंक्तियाँ।
          schema:
            type: string
          example: CA,TX
        - name: didit_internal_id
          in: query
          required: false
          description: >-
            एक सत्यापित उपयोगकर्ता के सभी सत्रों को सूचीबद्ध करने के लिए Didit
            के आंतरिक उपयोगकर्ता पहचानकर्ता (`didit_internal_id` रिस्पॉन्स
            फ़ील्ड) द्वारा फ़िल्टर करें। एक मान्य UUID होना चाहिए; विकृत मान
            `400` लौटाते हैं। केवल KYC पंक्तियाँ।
          schema:
            type: string
            format: uuid
          example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
        - name: session_type
          in: query
          required: false
          description: >-
            अल्पविराम से अलग किए गए सत्र निर्माण चैनल: `API`, `HOSTED`,
            `MIGRATED`। विशेष मान `ALL` (या पैरामीटर छोड़ना) फ़िल्टर को अक्षम कर
            देता है। केवल KYC पंक्तियाँ।
          schema:
            type: string
          example: HOSTED
        - name: api_service
          in: query
          required: false
          description: >-
            सेवा द्वारा स्टैंडअलोन API सत्रों को फ़िल्टर करें। अमान्य मान `400`
            लौटाते हैं। केवल KYC पंक्तियाँ।
          schema:
            type: string
            enum:
              - ID_VERIFICATION
              - FACE_MATCH
              - AGE_ESTIMATION
              - FACE_SEARCH
              - POA
              - AML
              - KYB_REGISTRY
              - PASSIVE_LIVENESS
              - DATABASE_VALIDATION
              - PHONE_VERIFICATION
              - EMAIL_VERIFICATION
          example: AML
        - name: screened_full_name
          in: query
          required: false
          description: >-
            AML और डेटाबेस सत्यापन से स्क्रीन किए गए डेटा के भीतर
            एक्सेंट-असंवेदनशील नाम खोज। जब `api_service=AML` या
            `api_service=DATABASE_VALIDATION` के साथ जोड़ा जाता है, तो खोज उस
            सुविधा के स्क्रीन किए गए डेटा तक ही सीमित होती है। केवल KYC
            पंक्तियाँ।
          schema:
            type: string
          example: Jane Doe
        - name: warning
          in: query
          required: false
          description: >-
            अल्पविराम से अलग किए गए चेतावनी जोखिम कोड; उन सत्रों को लौटाता है
            जिन्होंने इनमें से किसी को भी ट्रिगर किया है (उदा.
            `POSSIBLE_FRAUD`)। जोखिम कोड [चेतावनी
            दस्तावेज़ीकरण](/hi/integration/webhooks) में प्रति सुविधा सूचीबद्ध
            हैं। KYC पंक्तियों पर और व्यावसायिक चेतावनी कोड के साथ KYB पंक्तियों
            पर लागू होता है।
          schema:
            type: string
          example: POSSIBLE_FRAUD
        - name: status_initialized_as_in_review
          in: query
          required: false
          description: >-
            जब `true` होता है, तो केवल वे सत्र जिनका निर्णय शुरुआत में `In
            Review` में आया था (मैन्युअल समीक्षा की मात्रा का ऑडिट करने के लिए
            उपयोगी)। केवल KYC पंक्तियाँ।
          schema:
            type: boolean
          example: true
        - name: is_kyc_to_be_reviewed
          in: query
          required: false
          description: >-
            `true` उन सत्रों को लौटाता है जिनके दस्तावेज़ सत्यापन को मैन्युअल
            समीक्षा के लिए फ़्लैग किया गया है; `false` उन सत्रों को लौटाता है
            जिनके दस्तावेज़ सत्यापन को स्पष्ट रूप से फ़्लैग नहीं किया गया है।
            अक्षम करने के लिए छोड़ दें। केवल KYC पंक्तियाँ।
          schema:
            type: boolean
          example: true
        - name: euuid
          in: query
          required: false
          description: >-
            अंतिम उपयोगकर्ता के euuid (सत्यापित करने वाले उपयोगकर्ता को असाइन
            किया गया UUID, कंसोल डीप लिंक द्वारा उपयोग किया जाता है) द्वारा
            फ़िल्टर करें। एक मान्य UUID होना चाहिए; गलत प्रारूप वाले मान 400
            फ़ील्ड त्रुटि लौटाते हैं। केवल KYC पंक्तियाँ।
          schema:
            type: string
            format: uuid
          example: 0f8fad5b-d9cb-469f-a165-70867728950e
        - name: organization_name
          in: query
          required: false
          description: >-
            अल्पविराम से अलग किए गए संगठन के नाम। कंसोल-उन्मुख; एक API कुंजी के
            साथ (जो पहले से ही एक एप्लिकेशन तक सीमित है) यह केवल आपके अपने संगठन
            के नाम से मेल खाता है।
          schema:
            type: string
          example: Acme Inc
      responses:
        '200':
          description: >-
            पेजिनेटेड सत्र सूची। `session_kind` के आधार पर `results` आइटम KYC
            पंक्तियाँ, KYB पंक्तियाँ, या दोनों होते हैं; प्रत्येक पंक्ति के
            `session_kind` फ़ील्ड से भेद करें।
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    description: >-
                      फ़िल्टर से मेल खाने वाले सत्रों की संख्या: 100 तक सटीक और
                      उससे अधिक होने पर 100 पर सीमित, इसलिए इसे कुल संख्या के
                      रूप में उपयोग न करें। यह जानने के लिए कि क्या और पेज मौजूद
                      हैं, `next` का उपयोग करें। `session_kind=all` के लिए यह
                      दोनों प्रकारों का योग है, प्रत्येक 100 पर सीमित है।
                    example: 2
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: अगले पेज का पूर्ण URL, या अंतिम पेज पर `null`।
                    example: >-
                      https://verification.didit.me/v3/sessions/?limit=20&offset=20
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: पिछले पेज का पूर्ण URL, या पहले पेज पर `null`।
                    example: null
                  results:
                    type: array
                    description: >-
                      सत्र पंक्तियाँ, नवीनतम पहले। `session_kind=all` के साथ,
                      KYC पंक्तियाँ पहले आती हैं, फिर KYB पंक्तियाँ।
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/UserSessionListItem'
                        - $ref: '#/components/schemas/BusinessSessionListItem'
                      discriminator:
                        propertyName: session_kind
                        mapping:
                          user: '#/components/schemas/UserSessionListItem'
                          business: '#/components/schemas/BusinessSessionListItem'
              examples:
                KYC sessions (default):
                  summary: session_kind=user - एक पूरा हुआ और एक शुरू न हुआ सत्र
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - session_id: 5b3720ed-d429-42ef-b67f-37ea805f48ee
                        session_kind: user
                        session_number: 720
                        session_url: https://verify.didit.me/session/CuXoBYCYVO5Y
                        portrait_image: >-
                          https://<media-host>/portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...
                        document_type: Passport
                        full_name: Jane Marie Doe
                        country: ESP
                        status: Approved
                        vendor_data: your-user-id-123
                        didit_internal_id: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
                        created_at: '2026-06-09T12:26:54.328364Z'
                        features:
                          - feature: ID_VERIFICATION
                            status: Approved
                          - feature: LIVENESS
                            status: Approved
                          - feature: FACE_MATCH
                            status: Approved
                          - feature: AML
                            status: Approved
                          - feature: IP_ANALYSIS
                            status: Approved
                        phone_number:
                          number: '+14155552671'
                          is_verified: true
                        email_address:
                          email: jane@example.com
                          is_verified: true
                        additional_details:
                          aml:
                            total_hits: 0
                            entity_type: person
                            is_adverse_media_fetched: false
                          liveness:
                            method: PASSIVE
                            score: 0.98
                          face_match:
                            score: 0.95
                      - session_id: 038ad62f-5ebd-46c2-afe9-4b2956bf687f
                        session_kind: user
                        session_number: 719
                        session_url: https://verify.didit.me/session/7RGKiO6ioGH6
                        portrait_image: null
                        document_type: null
                        full_name: null
                        country: null
                        status: Not Started
                        vendor_data: your-user-id-124
                        didit_internal_id: eb4e679d-ca4b-461f-9685-687bac29ebdb
                        created_at: '2026-06-09T08:02:23.343053Z'
                        features:
                          - feature: ID_VERIFICATION
                            status: Not Finished
                          - feature: LIVENESS
                            status: Not Finished
                          - feature: FACE_MATCH
                            status: Not Finished
                          - feature: AML
                            status: Not Finished
                          - feature: IP_ANALYSIS
                            status: Not Finished
                        phone_number: null
                        email_address: null
                        additional_details: null
                Mixed KYC + KYB (session_kind=all):
                  summary: session_kind=all - KYC पंक्ति के बाद एक KYB पंक्ति
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - session_id: 5b3720ed-d429-42ef-b67f-37ea805f48ee
                        session_kind: user
                        session_number: 720
                        session_url: https://verify.didit.me/session/CuXoBYCYVO5Y
                        portrait_image: null
                        document_type: Identity Card
                        full_name: Jane Marie Doe
                        country: ESP
                        status: In Review
                        vendor_data: your-user-id-123
                        didit_internal_id: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
                        created_at: '2026-06-09T12:26:54.328364Z'
                        features:
                          - feature: ID_VERIFICATION
                            status: In Review
                          - feature: LIVENESS
                            status: Approved
                        phone_number: null
                        email_address: null
                        additional_details:
                          liveness:
                            method: PASSIVE
                            score: 0.98
                      - session_id: 8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52
                        session_kind: business
                        session_number: 42
                        status: Approved
                        vendor_data: your-company-id-77
                        created_at: '2026-06-08T09:14:02.118450Z'
                        workflow_id: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
                        workflow_type: kyb
                        workflow_label: Standard KYB
                        company_name: Acme Holdings S.L.
                        registration_number: B12345678
                        country: ES
        '301':
          description: >-
            कैनोनिकल ट्रेलिंग-स्लैश URL पर रीडायरेक्ट करें। तब लौटाया जाता है जब
            अनुरोध पथ `/v3/sessions` (बिना ट्रेलिंग स्लैश) होता है; `Location`
            हेडर क्वेरी स्ट्रिंग को सुरक्षित रखते हुए `/v3/sessions/` की ओर
            संकेत करता है। GET क्लाइंट आमतौर पर इसे स्वचालित रूप से फ़ॉलो करते
            हैं।
        '400':
          description: >-
            अमान्य क्वेरी पैरामीटर। body एक ऑब्जेक्ट है, जिसकी कुंजी उस पैरामीटर
            के नाम पर है जिसमें त्रुटि है।
          content:
            application/json:
              examples:
                Invalid session_kind:
                  summary: session_kind user/business/all में से एक नहीं है
                  value:
                    session_kind: Must be "user", "business", or "all".
                Invalid date:
                  summary: गलत स्वरूपित date_from/date_to
                  value:
                    date_from:
                      - Enter a valid date.
                Invalid didit_internal_id:
                  summary: didit_internal_id एक UUID नहीं है
                  value:
                    didit_internal_id:
                      - Enter a valid UUID.
                Invalid api_service:
                  summary: api_service अनुमत विकल्पों में नहीं है
                  value:
                    api_service:
                      - >-
                        Select a valid choice. FOO is not one of the available
                        choices.
        '403':
          description: >-
            अनुपलब्ध, विकृत या निरस्त API कुंजी। अनुपलब्ध कुंजी पर `403` मिलता
            है; गलत, निरस्त या समय-सीमा समाप्त कुंजी पर `401` मिलता है।


            **हटाया गया एप्लिकेशन:** किसी एप्लिकेशन को हटाए जाने के बाद कुछ
            मिनटों के लिए, उसकी किसी API कुंजी से किए गए अनुरोध का रिस्पॉन्स
            `{"detail": "This application was deleted.", "code":
            "application_deleted"}` हो सकता है। पुनः प्रयास न करें: एप्लिकेशन और
            उसकी API कुंजियाँ अब मौजूद नहीं हैं। उन कुछ मिनटों के बाद, कुंजी को
            किसी भी अन्य अमान्य कुंजी की तरह अस्वीकार कर दिया जाता है।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: You do not have permission to perform this action.
                  code:
                    type: string
                    description: >-
                      मशीन-पठनीय कारण, केवल कुछ विफलताओं पर मौजूद।
                      `application_deleted`: API कुंजी उस एप्लिकेशन की है जिसे
                      हटा दिया गया था।
                    example: application_deleted
                required:
                  - detail
              examples:
                Forbidden:
                  summary: अनुपलब्ध या अमान्य x-api-key
                  value:
                    detail: You do not have permission to perform this action.
                ApplicationDeleted:
                  summary: हटाए गए एप्लिकेशन की API कुंजी
                  value:
                    detail: This application was deleted.
                    code: application_deleted
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -s
            'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.sessions.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.sessions.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.sessions().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

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

            foreach ($didit->sessions->list() as $item) {
                print_r($item);
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.sessions.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            await foreach (var item in await client.Sessions.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    UserSessionListItem:
      title: 'KYC session row (session_kind: user)'
      type: object
      description: >-
        उपयोगकर्ता सत्यापन (KYC) सत्र के लिए सारांश पंक्ति। पहचान फ़ील्ड
        (`full_name`, `country`, `document_type`, `portrait_image`, संपर्क
        फ़ील्ड) उत्तरोत्तर पॉप्युलेट होते हैं जैसे ही उपयोगकर्ता सत्यापन चरणों
        को पूरा करता है, और प्रासंगिक चरण समाप्त होने तक `null` होते हैं।
        वर्कफ़्लो के रिस्पॉन्स-एट्रिब्यूट कॉन्फ़िगरेशन द्वारा प्रतिबंधित फ़ील्ड
        भी `null` के रूप में लौटाए जाते हैं।
      required:
        - session_id
        - session_kind
        - session_number
        - session_url
        - portrait_image
        - document_type
        - full_name
        - country
        - status
        - vendor_data
        - didit_internal_id
        - created_at
        - features
        - phone_number
        - email_address
        - additional_details
      properties:
        session_id:
          type: string
          format: uuid
          description: >-
            सत्यापन सत्र का विशिष्ट पहचानकर्ता। पूर्ण निर्णय payload प्राप्त
            करने के लिए इसे `GET /v3/session/{sessionId}/decision/` के साथ उपयोग
            करें।
          example: 5b3720ed-d429-42ef-b67f-37ea805f48ee
        session_kind:
          type: string
          enum:
            - user
          description: >-
            पंक्ति पहचानकर्ता। KYC पंक्तियों के लिए हमेशा `"user"`; व्यवसाय
            सत्यापन (KYB) पंक्तियों में `"business"` और एक भिन्न संरचना होती है।
          example: user
        session_number:
          type: integer
          description: >-
            आपके एप्लिकेशन के भीतर सत्र की मानव-पठनीय अनुक्रमिक संख्या। `search`
            पैरामीटर द्वारा भी मिलान किया जाता है।
          example: 720
        session_url:
          type: string
          nullable: true
          description: >-
            होस्टेड सत्यापन URL जिसे अंतिम उपयोगकर्ता फ़्लो पूरा करने के लिए
            खोलता है। जब सत्र में कोई होस्टेड URL नहीं होता है तो `null`।
          example: https://verify.didit.me/session/CuXoBYCYVO5Y
        portrait_image:
          type: string
          nullable: true
          description: >-
            सर्वश्रेष्ठ उपलब्ध पोर्ट्रेट का समाप्त होने वाला (प्रीसाइन किया हुआ)
            URL: उपलब्ध होने पर NFC चिप फ़ोटो, अन्यथा पहचान दस्तावेज़ पोर्ट्रेट,
            अन्यथा लाइवनेस संदर्भ छवि। जब तक इनमें से कोई मौजूद न हो, तब तक
            `null`। तुरंत डाउनलोड करें; लिंक समाप्त हो जाता है।
          example: >-
            https://<media-host>/portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=...
        document_type:
          type: string
          nullable: true
          enum:
            - Passport
            - Identity Card
            - Driver's License
            - Residence Permit
            - Health Insurance Card
            - Tax Card
          description: >-
            सत्यापित पहचान दस्तावेज़ का मानव-पठनीय प्रकार। दस्तावेज़ सत्यापन
            पूरा होने से पहले `null`, और पूरा होने के बाद भी `null` जब सत्यापित
            कोड में कोई डिस्प्ले मैपिंग न हो (`SSC`, `WP`, `VISA`, `PSC`, `BC`,
            `OTHER`)। ध्यान दें: `document_type` क्वेरी पैरामीटर छोटे कोड (`P`,
            `ID`, `DL`, `RP`, ...) द्वारा फ़िल्टर करता है, इन डिस्प्ले मानों
            द्वारा नहीं।
          example: Passport
        full_name:
          type: string
          nullable: true
          description: >-
            सत्र के लिए सर्वोत्तम उपलब्ध पूरा नाम, इस क्रम में हल किया गया:
            पहचान दस्तावेज़ OCR, AML स्क्रीनिंग किया गया डेटा, डेटाबेस सत्यापन
            किया गया डेटा, पते का प्रमाण दस्तावेज़, फिर सत्र निर्माण के समय
            प्रदान किए गए अपेक्षित विवरण। अभी तक कोई उपलब्ध न होने पर `null`।
          example: Jane Marie Doe
        country:
          type: string
          nullable: true
          description: >-
            सत्र से जुड़ा ISO 3166-1 alpha-3 देश, जिसे इस क्रम में निर्धारित
            किया जाता है: ID दस्तावेज़ जारीकर्ता राज्य, डेटाबेस-सत्यापन
            जारीकर्ता राज्य, पते का प्रमाण जारीकर्ता राज्य, अपेक्षित विवरण, फिर
            सत्यापित फ़ोन का देश। राष्ट्रीयता से भिन्न हो सकता है।
          example: ESP
        status:
          type: string
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
          description: >-
            सत्र की समग्र स्थिति। जीवनचक्र के लिए [सत्यापन
            स्थितियाँ](/hi/integration/verification-statuses) पेज देखें।
          example: Approved
        vendor_data:
          type: string
          nullable: true
          description: >-
            अंतिम उपयोगकर्ता के लिए आपका अपना पहचानकर्ता, सत्र निर्माण के समय
            ठीक उसी तरह वापस दोहराया जाता है जैसा भेजा गया था।
          example: your-user-id-123
        didit_internal_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            इस सत्र से संबद्ध सत्यापित उपयोगकर्ता प्रोफ़ाइल के लिए Didit का
            आंतरिक पहचानकर्ता। एक ही उपयोगकर्ता के कई सत्रों में स्थिर;
            `didit_internal_id` क्वेरी पैरामीटर के माध्यम से फ़िल्टर करने योग्य।
          example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
        created_at:
          type: string
          format: date-time
          description: UTC टाइमस्टैम्प जब सत्र बनाया गया था।
          example: '2026-06-09T12:26:54.328364Z'
        features:
          type: array
          description: >-
            सत्र के वर्कफ़्लो में कॉन्फ़िगर किए गए प्रत्येक सत्यापन चरण के लिए
            वर्कफ़्लो क्रम में प्रति-सुविधा स्थिति।
          items:
            type: object
            required:
              - feature
              - status
            properties:
              feature:
                type: string
                enum:
                  - ID_VERIFICATION
                  - NFC
                  - LIVENESS
                  - FACE_MATCH
                  - POA
                  - QUESTIONNAIRE
                  - EMAIL_VERIFICATION
                  - PHONE
                  - AML
                  - IP_ANALYSIS
                  - AGE_ESTIMATION
                  - DATABASE_VALIDATION
                  - GEOLOCATION
                description: सत्यापन सुविधा पहचानकर्ता।
                example: ID_VERIFICATION
              status:
                type: string
                enum:
                  - Not Finished
                  - Approved
                  - Declined
                  - In Review
                  - Resub Requested
                description: इस सुविधा का स्टेटस। चरण पूरा होने तक `Not Finished` रहता है।
                example: Approved
        phone_number:
          type: object
          nullable: true
          description: >-
            सत्र से संबद्ध फ़ोन: फ़ोन सत्यापन चलने पर सत्यापित फ़ोन, अन्यथा सत्र
            निर्माण के समय प्रदान किया गया संपर्क फ़ोन। दोनों मौजूद न होने पर
            `null`।
          required:
            - number
            - is_verified
          properties:
            number:
              type: string
              description: E.164 प्रारूप में फ़ोन नंबर।
              example: '+14155552671'
            is_verified:
              type: boolean
              description: >-
                `true` केवल तभी जब फ़ोन सत्यापन सुविधा ने इस नंबर को स्वीकृत
                किया हो।
              example: true
        email_address:
          type: object
          nullable: true
          description: >-
            सत्र से जुड़ा ईमेल: ईमेल सत्यापन चलने पर सत्यापित ईमेल, अन्यथा सत्र
            निर्माण के समय प्रदान किया गया संपर्क ईमेल। दोनों में से किसी के न
            होने पर `null`।
          required:
            - email
            - is_verified
          properties:
            email:
              type: string
              format: email
              example: jane@example.com
            is_verified:
              type: boolean
              description: >-
                `true` केवल तभी जब ईमेल सत्यापन सुविधा ने इस पते को स्वीकृत किया
                हो।
              example: true
        additional_details:
          type: object
          nullable: true
          description: >-
            संक्षिप्त प्रति-सुविधा अतिरिक्त विवरण। केवल वे सुविधाएं जिन्होंने
            डेटा उत्पन्न किया है, कुंजियों के रूप में दिखाई देती हैं; जब किसी
            सुविधा ने अतिरिक्त विवरण नहीं दिया हो तो `null`। वर्कफ़्लो के
            रिस्पॉन्स-विशेषता कॉन्फ़िगरेशन द्वारा बहिष्कृत फ़ील्ड छोड़ दिए जाते
            हैं।
          properties:
            aml:
              type: object
              description: AML स्क्रीनिंग चलने पर मौजूद होता है।
              properties:
                total_hits:
                  type: integer
                  description: AML स्क्रीनिंग हिट्स की संख्या।
                  example: 0
                entity_type:
                  type: string
                  description: स्क्रीन किए गए निकाय का प्रकार।
                  example: person
                is_adverse_media_fetched:
                  type: boolean
                  example: false
                screened_data:
                  type: object
                  description: >-
                    स्क्रीन किए गए डेटा का सबसेट। केवल गैर-रिक्त कुंजियाँ शामिल
                    हैं।
                  properties:
                    nationality:
                      type: string
                      example: ESP
                    document_number:
                      type: string
                      example: XX1234567
                    date_of_birth:
                      type: string
                      example: '1990-05-21'
            database_validation:
              type: object
              description: डेटाबेस सत्यापन चलने पर मौजूद होता है।
              properties:
                validation_type:
                  type: string
                  example: DOCUMENT_VALIDATION
                match_type:
                  type: string
                  example: FULL_MATCH
                identification_number:
                  type: string
                  description: >-
                    सत्यापित किया गया कर, व्यक्तिगत, या दस्तावेज़ नंबर (पहला
                    उपलब्ध)।
                  example: 12345678Z
            poa:
              type: object
              description: पते का प्रमाण चलने पर मौजूद होता है।
              properties:
                document_type:
                  type: string
                  example: UTILITY_BILL
                issuer:
                  type: string
                  example: Energy Co
                address:
                  type: string
                  example: Calle Mayor 1, 28013 Madrid
                name_on_document:
                  type: string
                  example: Jane Marie Doe
            liveness:
              type: object
              description: लाइवनेस जांच चलने पर मौजूद होता है।
              properties:
                method:
                  type: string
                  example: PASSIVE
                score:
                  type: number
                  description: लाइवनेस विश्वास स्कोर, 2 दशमलव स्थानों तक पूर्णांकित।
                  example: 0.98
            face_match:
              type: object
              description: चेहरा मिलान चलने पर मौजूद होता है।
              properties:
                score:
                  type: number
                  description: चेहरा-मिलान समानता स्कोर, 2 दशमलव स्थानों तक पूर्णांकित।
                  example: 0.95
                source_image:
                  type: string
                  description: >-
                    स्रोत चेहरे की छवि का समाप्त होने वाला (प्रीसाइन किया हुआ)
                    URL।
                  example: https://<media-host>/faces/source.jpg?X-Amz-Expires=3600&...
                target_image:
                  type: string
                  description: >-
                    लक्ष्य चेहरे की छवि का समाप्त होने वाला (प्रीसाइन किया हुआ)
                    URL।
                  example: https://<media-host>/faces/target.jpg?X-Amz-Expires=3600&...
            phone_verification:
              type: object
              description: फ़ोन सत्यापन चलने पर मौजूद होता है।
              properties:
                country_code:
                  type: string
                  description: फ़ोन नंबर का ISO 3166-1 alpha-2 देश।
                  example: US
                is_temporary:
                  type: boolean
                  example: false
                is_ported:
                  type: boolean
                  example: false
                is_blocked:
                  type: boolean
                  example: false
            email_verification:
              type: object
              description: ईमेल सत्यापन चलने पर मौजूद होता है।
              properties:
                is_breached:
                  type: boolean
                  example: false
                is_disposable:
                  type: boolean
                  example: false
                is_undeliverable:
                  type: boolean
                  example: false
                is_blocklisted:
                  type: boolean
                  example: false
        assignee:
          type: object
          nullable: true
          description: >-
            कंसोल समीक्षक जिसे सत्र सौंपा गया है, या `null` जब इसे कोई नहीं
            संभाल रहा हो।
          properties:
            email:
              type: string
              format: email
            assigned_at:
              type: string
              format: date-time
              nullable: true
        waiting_since:
          type: string
          format: date-time
          nullable: true
          description: >-
            सत्र समीक्षा की प्रतीक्षा कब करने लगा। `null` जब तक कि सत्र `In
            Review` में न हो।
        sla_due_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Console में आपके एप्लिकेशन के लिए निर्धारित समीक्षा समय-सीमा के
            अनुसार, समीक्षा कब नियत है। `null` जब तक कि सत्र `In Review` में न
            हो और कोई समय-सीमा निर्धारित हो।
        top_warnings:
          type: array
          description: >-
            त्वरित समीक्षा दृश्य के लिए सत्र की अधिकतम कुछ सबसे महत्वपूर्ण
            चेतावनियाँ। पूरी सूची निर्णय में है।
          items:
            type: object
            properties:
              risk:
                type: string
                description: चेतावनी कोड, उदाहरण के लिए `FACE_MATCH_LOW_SIMILARITY`।
              feature:
                type: string
                description: वह सुविधा जिसने इसे उत्पन्न किया।
              log_type:
                type: string
                nullable: true
                description: '`error` या `warning`; लीगेसी प्रविष्टि के लिए `null`।'
              short_description:
                type: string
        warnings_count:
          type: integer
          description: सत्र पर चेतावनियों की संख्या।
    BusinessSessionListItem:
      title: 'KYB session row (session_kind: business)'
      type: object
      description: >-
        व्यवसाय सत्यापन (KYB) सत्र के लिए सारांश पंक्ति। केवल तभी लौटाया जाता है
        जब `session_kind` का मान `business` या `all` हो।
      required:
        - session_id
        - session_kind
        - session_number
        - status
        - vendor_data
        - created_at
        - workflow_id
        - workflow_type
        - workflow_label
        - company_name
        - registration_number
        - country
      properties:
        session_id:
          type: string
          format: uuid
          description: व्यवसाय सत्यापन सत्र का विशिष्ट पहचानकर्ता।
          example: 8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52
        session_kind:
          type: string
          enum:
            - business
          description: पंक्ति पहचानकर्ता। KYB पंक्तियों के लिए हमेशा `"business"`।
          example: business
        session_number:
          type: integer
          description: >-
            आपके एप्लिकेशन के भीतर व्यवसाय सत्र की मानव-पठनीय अनुक्रमिक संख्या।
            KYC सत्रों से स्वतंत्र रूप से क्रमांकित।
          example: 42
        status:
          type: string
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
          description: >-
            सत्र की समग्र स्थिति। [सत्यापन
            स्थितियाँ](/hi/integration/verification-statuses) पेज देखें।
          example: Approved
        vendor_data:
          type: string
          nullable: true
          description: >-
            व्यवसाय के लिए आपका अपना पहचानकर्ता, सत्र निर्माण के समय ठीक उसी तरह
            वापस दोहराया जाता है जैसा भेजा गया था।
          example: your-company-id-77
        created_at:
          type: string
          format: date-time
          description: UTC टाइमस्टैम्प जब सत्र बनाया गया था।
          example: '2026-06-08T09:14:02.118450Z'
        workflow_id:
          type: string
          format: uuid
          nullable: true
          description: उस वर्कफ़्लो का पहचानकर्ता जिसके साथ यह सत्र बनाया गया था।
          example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
        workflow_type:
          type: string
          nullable: true
          description: वर्कफ़्लो प्रकार। व्यावसायिक वर्कफ़्लो के लिए `kyb`।
          example: kyb
        workflow_label:
          type: string
          nullable: true
          description: वर्कफ़्लो का डिस्प्ले नाम।
          example: Standard KYB
        company_name:
          type: string
          nullable: true
          description: >-
            सत्यापित की जा रही कंपनी का नाम, सत्र से जुड़ी रजिस्ट्री कंपनी से
            प्राप्त। कंपनी चुने जाने तक `null`।
          example: Acme Holdings S.L.
        registration_number:
          type: string
          nullable: true
          description: सत्र से जुड़ी रजिस्ट्री कंपनी से कंपनी पंजीकरण संख्या।
          example: B12345678
        country:
          type: string
          nullable: true
          description: सत्र से जुड़ी रजिस्ट्री कंपनी का देश कोड।
          example: ES
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की 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।

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.