> ## 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: डिलीवरेबिलिटी और ब्रीच संकेत

> Didit के साथ बिना OTP भेजे ईमेल पते का जोखिम स्कोर पाएँ। डिलीवरेबिलिटी, डिस्पोज़ेबल डोमेन, ब्रीच और फ़्रॉड संकेत, एक सर्वर-से-सर्वर कॉल में।

यह ईमेल नहीं भेजता। यह एक API सत्र बनाता है, पते को समृद्ध करता है, आपके ईमेल-जोखिम नियम लागू करता है, और एक ही सिंक्रोनस रिस्पॉन्स में वही सामान्यीकृत ईमेल ब्लॉक लौटाता है जो ईमेल सत्यापन में उपयोग होता है।

जब अनुरोध सहेजा जाता है, तब Didit स्कोर किए गए ईमेल को **Networks** में समेकित साक्ष्य के रूप में भी उपयोग कर सकता है। नेटवर्क ग्राफ़ साझा ईमेल संकेतों पर उच्च-जोखिम ईमेल इंटेलिजेंस, उल्लंघन संदर्भ और सोशल-प्रोफ़ाइल कवरेज दिखा सकते हैं, लेकिन वे अन्य संगठनों को कच्चा ईमेल पता नहीं दिखाते।

`POST /v3/email/risk/` का उपयोग तब करें जब आपको उपयोगकर्ता से वन-टाइम कोड दर्ज करवाए बिना ईमेल इंटेलिजेंस चाहिए।

## रिस्पॉन्स की व्याख्या

* `status` इस API सत्र का अंतिम निर्णय है। यह आम तौर पर `Approved` होता है; जोखिम मूल्यांकन से `In Review` या `Declined` परिणाम भी आ सकता है।
* `email.is_breached`, `email.is_disposable` और `email.is_undeliverable` एप्लिकेशन लॉजिक के लिए उपयोग होने वाले स्थिर हाँ/नहीं संकेत हैं।
* `email.breaches` उस पते वाले सबसे हाल के ज्ञात उल्लंघनों की सूची देता है, जब कवरेज उपलब्ध हो, साथ में उल्लंघन की तिथि और उजागर हुए डेटा वर्ग।
* `email.email_intelligence.score` 0-100 जोखिम पैमाने का उपयोग करता है, जहाँ अधिक संख्या का अर्थ अधिक जोखिम है। `breach_risk_level` (`Low`, `Medium`, `High`) और `no_of_breaches` व्युत्पन्न दृश्य हैं।
* `email.email_intelligence.reason_codes` बताता है कि परिणाम में कौन से सामान्यीकृत संकेतों ने योगदान दिया। समय के साथ मान बढ़ सकते हैं, इसलिए अज्ञात कोड को अस्वीकार न करें।
* `email.email_intelligence` और `email.enrichment` संगतता उपनाम हैं, जो एक ही सामान्यीकृत ऑब्जेक्ट को दर्शाते हैं। नए इंटीग्रेशन `email.enrichment` पढ़ सकते हैं।
* `email.matches` आपके एप्लिकेशन के उन अन्य सत्रों की सूची देता है जहाँ यही पता किसी भिन्न उपयोगकर्ता ने उपयोग किया था। इसका उपयोग डुप्लिकेट खाता पहचान के लिए करें।
* `request_id` API सत्र का आईडी है। यदि आपको परिणाम को बाद के webhook या कंसोल गतिविधि से जोड़ना है, तो इसे `vendor_data` के साथ सहेजें।

> [!WARNING]
>
> `email.email_intelligence` और `email.enrichment` सर्वोत्तम-प्रयास फ़ील्ड हैं। एक पूर्ण लुकअप में भी ये दोनों छूट सकते हैं, जब उस पते, डोमेन या प्लान के लिए कोई उपयोगी इंटेलिजेंस डेटा न मिले। पहले `is_breached`, `is_disposable` और `is_undeliverable` पर नियम बनाएँ, और अनुपस्थित इंटेलिजेंस को "अज्ञात" मानें, "सुरक्षित" नहीं।

## सोशल फुटप्रिंट ऐड-ऑन

`enable_social` को `true` पर सेट करने से रिस्पॉन्स में `email` के अंतर्गत एक `email_social` ब्लॉक जुड़ जाता है: वे ऑनलाइन प्लेटफ़ॉर्म जिन पर यह ईमेल पता पंजीकृत है, श्रेणी के अनुसार समूहित, सारांश गिनतियों और हमारे डेटा पार्टनरों द्वारा लौटाए गए किसी भी प्रोफ़ाइल विवरण के साथ।

* `email.email_social.profiles_registered` और `email.email_social.profiles_checked` मुख्य संख्याएँ हैं: वे प्लेटफ़ॉर्म जहाँ ईमेल पता पंजीकृत होने की पुष्टि हुई, जाँचे गए प्लेटफ़ॉर्म की कुल संख्या में से।
* `email.email_social.registered_platforms` और `email.email_social.not_registered_platforms` हर प्लेटफ़ॉर्म को उसकी `category` और `scope` (`global`, या क्षेत्र-विशिष्ट प्लेटफ़ॉर्म के लिए `local`) के साथ सूचीबद्ध करते हैं।
* `email.email_social.categories` प्रति श्रेणी पंजीकृत गिनती और अनुपात देता है, और `email.email_social.profiles` प्रति प्लेटफ़ॉर्म प्रोफ़ाइल विवरण रखता है, जब कोई प्लेटफ़ॉर्म उन्हें उपलब्ध कराता है (नाम, फ़ोटो URL, परिचय पाठ, गोपनीयता स्थिति, व्यावसायिक-खाता फ़्लैग)।
* सारांश सूचकांक (`digital_footprint_diversity`, `digital_sophistication_index`, `engagement_depth_index`, `subscription_affordability_index`) 0-10 के समग्र स्कोर हैं। जब जाँच से किसी गिनती के लिए डेटा नहीं मिलता, तो हर गिनती `null` हो सकती है।

`profiles_registered: 0` एक वास्तविक उत्तर है, विफलता नहीं: प्लेटफ़ॉर्म जाँचे गए थे और ईमेल पता किसी पर भी नहीं मिला, जो सिंथेटिक पहचान का एक आम संकेत है। यह एंडपॉइंट अपने आप इस पर कार्रवाई नहीं करता। इसे समीक्षाधीन या अस्वीकृति निर्णय में बदलने के लिए किसी वर्कफ़्लो में `email_no_social_presence_action` का उपयोग करें।

`enable_social` सेट न होने पर यह ब्लॉक अनुपस्थित रहता है, और तब भी अनुपस्थित रहता है जब सोशल जाँच पूरी न हो सकी हो। उस स्थिति में उसका शुल्क नहीं लिया जाता।

## सैंडबॉक्स व्यवहार

सैंडबॉक्स कुंजियाँ अनुरोध को मान्य करती हैं और निर्धारित, स्वीकृत डेटा लौटाती हैं। वे ईमेल नहीं भेजतीं, क्रेडिट खर्च नहीं करतीं, सत्र नहीं बनातीं, और Networks में योगदान नहीं देतीं। `enable_social` सेट होने पर वे निर्धारित `email_social` ब्लॉक भी लौटाती हैं।

## बिलिंग

Email Risk API कॉल की सूची कीमत \$0.04 है, जो पूर्ण ईमेल सत्यापन से कम है क्योंकि कोई ईमेल नहीं भेजा जाता। लाइव अनुरोध तब बिलने योग्य होता है जब लुकअप शुरू हो जाए, भले ही कुछ सर्वोत्तम-प्रयास फ़ील्ड उपलब्ध न हों।

सोशल फुटप्रिंट ऐड-ऑन का शुल्क अलग से लिया जाता है: Email Risk API की कीमत के अलावा प्रति अनुरोध एक `email_social` यूनिट, जब भी जाँच पूरी होती है। लुकअप से पहले की क्रेडिट जाँच दोनों को कवर करती है।


## OpenAPI

````yaml hi/openapi-25.json POST /v3/email/risk/
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/email/risk/:
    post:
      tags:
        - Standalone APIs
      summary: ईमेल पते का जोखिम स्कोर निकालें
      description: >-
        बिना OTP भेजे डिलिवरेबिलिटी, डिस्पोज़ेबल-पता, ब्रीच, क्रॉस-सत्र मिलान,
        और सामान्यीकृत जोखिम-इंटेलिजेंस संकेत लौटाएं। यह endpoint एक API सत्र
        बनाता है और इसकी id को `request_id` के रूप में लौटाता है।


        **निर्णय।** शीर्ष-स्तरीय `status`, `email.status` को दर्शाता है। यह
        सामान्यतः `Approved` होता है; जोखिम मूल्यांकन के परिणामस्वरूप `In
        Review` या `Declined` हो सकता है।


        **कम्पैटिबिलिटी एलियास।** लाइव रिस्पॉन्स सामान्यीकृत इंटेलिजेंस ऑब्जेक्ट
        को `email.email_intelligence` और `email.enrichment` दोनों के रूप में
        प्रस्तुत करते हैं। इनके मान एक समान हैं। नए इंटीग्रेशन
        `email.enrichment` को पढ़ सकते हैं। जब कोई उपयोग योग्य इंटेलिजेंस डेटा
        वापस नहीं आता है, तो दोनों कुंजियाँ अनुपस्थित होती हैं।


        **बिलिंग।** लाइव कॉल Email Risk API मूल्य निर्धारण का उपयोग करती हैं।
        लुकअप शुरू होते ही अनुरोध बिल योग्य हो जाता है, भले ही कुछ बेस्ट-एफ़र्ट
        फ़ील्ड अनुपलब्ध हों।


        **सैंडबॉक्स।** सैंडबॉक्स कुंजियाँ ईमेल भेजे बिना, क्रेडिट खर्च किए बिना,
        सत्र बनाए बिना या Networks में योगदान दिए बिना अनुरोध को मान्य करती हैं
        और डिटरमिनिस्टिक स्वीकृत डेटा लौटाती हैं।


        **प्रमाणीकरण।** अपने एप्लिकेशन की API कुंजी `x-api-key` में भेजें।
        अनुपलब्ध या अमान्य क्रेडेंशियल `403` लौटाते हैं - यह API कभी भी `401`
        नहीं लौटाती है।


        **रेट लिमिट।** POST/PATCH/DELETE endpoints पर प्रति API कुंजी प्रति मिनट
        300 अनुरोधों का साझा राइट बजट (लेन-देन निर्माण और इवेंट इनजेशन के लिए
        600 अनुरोधों का अलग बजट है)।


        **सोशल फ़ुटप्रिंट।** `email_social` ब्लॉक जोड़ने के लिए `enable_social`
        को `true` पर सेट करें: ऑनलाइन प्लेटफ़ॉर्म जिन पर यह पता पंजीकृत है,
        प्रति-श्रेणी गणना और उपलब्ध प्रोफ़ाइल विवरण के साथ।
        `profiles_registered: 0` का अर्थ है कि प्लेटफ़ॉर्म की जाँच की गई थी और
        यह पता उनमें से किसी पर भी नहीं मिला - एक मान्य, बिल योग्य उत्तर। जब
        ऐड-ऑन का अनुरोध नहीं किया गया था या जाँच पूरी नहीं हो सकी, तो यह ब्लॉक
        अनुपस्थित होता है, और उस स्थिति में इसका बिल नहीं लिया जाता है। बिलिंग
        इस endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक `email_social` इकाई
        जोड़ती है।
      operationId: post_v3email_risk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailRiskRequest'
            examples:
              Minimal:
                summary: डिफ़ॉल्ट मानों के साथ किसी पते का स्कोर निकालें
                value:
                  email: alice@example.com
              Full context:
                summary: सिग्नलों, देश संकेत और सहसंबंध ID के साथ स्कोरिंग करें
                value:
                  email: alice@example.com
                  country_code: US
                  signals:
                    ip: 192.0.2.1
                    device_id: 8F0B8FDD-C2CB-4387-B20A-56E9B2E5A0D2
                    device_platform: web
                    os_version: '14.4'
                    app_version: 1.2.34
                    user_agent: >-
                      Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
                      AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4
                      Safari/605.1.15
                  vendor_data: lead-123
                  metadata:
                    source: signup_prescreen
      responses:
        '200':
          description: >-
            जोखिम मूल्यांकन पूरा हो गया। निर्णय के लिए `status` का निरीक्षण
            करें; पूर्ण लुकअप के लिए HTTP हमेशा `200` होता है।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailRiskResponse'
              examples:
                Clean address:
                  summary: डेटा उल्लंघन के जोखिम से मुक्त डिलीवरी योग्य पता
                  value:
                    request_id: 82397be9-5921-4970-a979-2d5b43e08b33
                    status: Approved
                    email:
                      status: Approved
                      email: alice@example.com
                      is_breached: false
                      breaches: []
                      is_disposable: false
                      is_undeliverable: false
                      verification_attempts: 0
                      verified_at: null
                      warnings: []
                      lifecycle: []
                      matches: []
                      email_intelligence:
                        score: 4
                        deliverable: high
                        breach_risk_level: Low
                        breach_risk_index: 4
                        is_recent_breach: false
                        is_frequent_breached: false
                        is_disposable: false
                        is_free_domain: false
                        is_breached: false
                        no_of_breaches: 0
                        reason_codes: []
                      enrichment:
                        score: 4
                        deliverable: high
                        breach_risk_level: Low
                        breach_risk_index: 4
                        is_recent_breach: false
                        is_frequent_breached: false
                        is_disposable: false
                        is_free_domain: false
                        is_breached: false
                        no_of_breaches: 0
                        reason_codes: []
                    vendor_data: lead-123
                    metadata:
                      source: signup_prescreen
                    created_at: '2026-09-01T10:30:00.123456+00:00'
                Breached address:
                  summary: पता ज्ञात उल्लंघनों में पाया गया
                  value:
                    request_id: d1e5c2a8-6f30-4c1a-8b2d-3e4f5a6b7c8d
                    status: In Review
                    email:
                      status: In Review
                      email: bob@example.org
                      is_breached: true
                      breaches:
                        - name: ExampleBreach2023
                          domain: example.org
                          breach_date: '2023-06-01'
                          breach_emails_count: 1200000
                          description: A data breach affecting example.org accounts.
                          logo_path: https://logos.example.org/example.png
                          data_classes:
                            - email_addresses
                            - passwords
                          is_verified: true
                      is_disposable: false
                      is_undeliverable: false
                      verification_attempts: 0
                      verified_at: null
                      warnings: []
                      lifecycle: []
                      matches: []
                      email_intelligence:
                        score: 58
                        deliverable: high
                        breach_risk_level: High
                        breach_risk_index: 72
                        is_recent_breach: true
                        is_frequent_breached: true
                        is_disposable: false
                        is_free_domain: true
                        is_breached: true
                        no_of_breaches: 4
                        reason_codes:
                          - code: IR-F784B630
                            direction: risk
                            message: Email's digital footprint diversity is Very Low
                            impact_level: low
                      enrichment:
                        score: 58
                        deliverable: high
                        breach_risk_level: High
                        breach_risk_index: 72
                        is_recent_breach: true
                        is_frequent_breached: true
                        is_disposable: false
                        is_free_domain: true
                        is_breached: true
                        no_of_breaches: 4
                        reason_codes:
                          - code: IR-F784B630
                            direction: risk
                            message: Email's digital footprint diversity is Very Low
                            impact_level: low
                    vendor_data: lead-125
                    metadata: null
                    created_at: '2026-09-01T10:30:00.123456+00:00'
        '400':
          $ref: '#/components/responses/EmailRiskValidationError'
        '403':
          $ref: '#/components/responses/RiskPermissionDenied'
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST https://verification.didit.me/v3/email/risk/ \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "email": "alice@example.com",
                "country_code": "US",
                "vendor_data": "lead-123",
                "metadata": {"source": "signup_prescreen"}
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.email.assess_risk(
                email="alice@example.com",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

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

            const result = await didit.email.assessRisk({
              email: "alice@example.com",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Email.AssessRisk(ctx, didit.EmailRiskRequest{\n\tEmail: \"alice@example.com\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;
            import me.didit.types.EmailRiskRequest;

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

            var result = client.email().assessRisk(EmailRiskRequest.builder()
                    .email("alice@example.com")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

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

            $result = $didit->email->assessRisk([
                'email' => 'alice@example.com',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.email.assess_risk(email: "alice@example.com")
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

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

            var result = await client.Email.AssessRiskAsync(new EmailRiskRequest
            {
                Email = "alice@example.com",
            });
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EmailRiskRequest:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          format: email
          description: स्कोर करने के लिए ईमेल पता।
          example: alice@example.com
        country_code:
          type: string
          maxLength: 3
          description: >-
            इंटेलिजेंस कवरेज के लिए वैकल्पिक ISO 3166-1 alpha-2 या alpha-3 देश
            संकेत।
          example: US
        signals:
          $ref: '#/components/schemas/RiskSignals'
        vendor_data:
          type: string
          description: >-
            इस अनुरोध के लिए आपका स्थिर संदर्भ। API सत्र पर संग्रहीत और
            रिस्पॉन्स में लौटाया गया।
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            आपका गैर-संवेदनशील JSON मेटाडेटा। API सत्र पर संग्रहीत और रिस्पॉन्स
            में दोहराया गया।
        enable_social:
          type: boolean
          default: false
          description: >-
            true होने पर, पते के सोशल फ़ुटप्रिंट की भी खोज करें - ईमेल, सोशल,
            व्यावसायिक, ई-कॉमर्स और मनोरंजन प्लेटफ़ॉर्म जिन पर यह पंजीकृत है। इस
            endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक `email_social`
            इकाई के रूप में बिल किया जाता है।
          example: true
    EmailRiskResponse:
      type: object
      required:
        - request_id
        - status
        - created_at
      properties:
        request_id:
          type: string
          format: uuid
          description: >-
            इस अनुरोध के लिए बनाए गए API सत्र की Id। यदि आपको बाद के webhook
            इवेंट या कंसोल गतिविधि के साथ परिणाम को सहसंबंधित करने की आवश्यकता
            है, तो इसे `vendor_data` के साथ संग्रहीत करें।
        status:
          type: string
          enum:
            - Approved
            - In Review
            - Declined
          description: >-
            इस API सत्र के लिए अंतिम निर्णय। आमतौर पर `Approved`; जोखिम
            मूल्यांकन `In Review` या `Declined` उत्पन्न कर सकता है।
        vendor_data:
          type: string
          nullable: true
          description: >-
            आपके द्वारा भेजे गए `vendor_data` का इको, जब आपने इसे नहीं भेजा हो
            तो `null`।
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            आपके द्वारा भेजे गए `metadata` का इको, जब आपने इसे नहीं भेजा हो तो
            `null`।
        created_at:
          type: string
          format: date-time
          description: इस रिस्पॉन्स का टाइमस्टैम्प।
        email:
          type: object
          description: >-
            सामान्यीकृत ईमेल रिपोर्ट, वही ब्लॉक जो ईमेल सत्यापन रिस्पॉन्स द्वारा
            उपयोग किया जाता है।
          required:
            - status
            - email
            - is_breached
            - breaches
            - is_disposable
            - is_undeliverable
          properties:
            status:
              type: string
              enum:
                - Approved
                - In Review
                - Declined
              description: इस ईमेल पते के लिए निर्णय। शीर्ष-स्तरीय `status` को दर्शाता है।
            email:
              type: string
              description: स्कोर किया गया पता।
              example: alice@example.com
            is_breached:
              type: boolean
              description: क्या पता किसी ज्ञात क्रेडेंशियल उल्लंघन में दिखाई देता है।
            breaches:
              type: array
              description: >-
                इस पते वाले अधिकतम 5 सबसे हालिया ज्ञात डेटा उल्लंघन। जब
                `is_breached` मान `false` हो तो खाली ऐरे।
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: उल्लंघन पहचानकर्ता।
                  domain:
                    type: string
                    description: उल्लंघन से प्रभावित सेवा का डोमेन।
                  breach_date:
                    type: string
                    format: date
                    description: उल्लंघन होने की तारीख।
                  breach_emails_count:
                    type: integer
                    description: उल्लंघन में उजागर हुए खातों की कुल संख्या।
                  description:
                    type: string
                    description: उल्लंघन का मानव-पठनीय विवरण (HTML मार्कअप हो सकता है)।
                  logo_path:
                    type: string
                    description: उल्लंघित सेवा के लोगो का URL।
                  data_classes:
                    type: array
                    items:
                      type: string
                    description: >-
                      उजागर किए गए डेटा की श्रेणियां, snake_case में (उदा.,
                      `email_addresses`, `passwords`)।
                  is_verified:
                    type: boolean
                    description: क्या उल्लंघन को वैध के रूप में सत्यापित किया गया है।
            is_disposable:
              type: boolean
              description: क्या डोमेन किसी थ्रोअवे प्रदाता से संबंधित है।
            is_undeliverable:
              type: boolean
              description: क्या पता डिलीवर न किया जा सकने वाला पाया गया।
            verification_attempts:
              type: integer
              description: इस पते के लिए भेजे गए OTP। जोखिम लुकअप के लिए `0`।
            verified_at:
              type: string
              format: date-time
              nullable: true
              description: >-
                जब पते को अंतिम बार OTP द्वारा सत्यापित किया गया था। जोखिम लुकअप
                के लिए `null`।
            warnings:
              type: array
              description: >-
                इस अनुरोध के लिए रिकॉर्ड की गई जोखिम चेतावनियां। कोई न होने पर
                खाली ऐरे।
              items:
                $ref: '#/components/schemas/RiskWarning'
            lifecycle:
              type: array
              description: >-
                अनुरोध का कालानुक्रमिक ऑडिट ट्रेल। उन जोखिम लुकअप के लिए खाली
                ऐरे जिनमें सेंड नहीं हैं।
              items:
                $ref: '#/components/schemas/RiskLifecycleEvent'
            matches:
              type: array
              description: >-
                आपके एप्लिकेशन के अन्य सत्र जहाँ एक अलग उपयोगकर्ता (अलग
                `vendor_data`) द्वारा समान ईमेल पते का उपयोग किया गया था। अधिकतम
                5 प्रविष्टियाँ। कोई मिलान न होने पर खाली ऐरे।
              items:
                $ref: '#/components/schemas/EmailMatchItem'
            email_intelligence:
              $ref: '#/components/schemas/EmailIntelligence'
            enrichment:
              $ref: '#/components/schemas/EmailIntelligence'
            email_social:
              $ref: '#/components/schemas/EmailSocialFootprint'
    RiskSignals:
      type: object
      description: >-
        आपके एप्लिकेशन द्वारा देखा गया वैकल्पिक डिवाइस और नेटवर्क संदर्भ। सभी
        फ़ील्ड वैकल्पिक हैं। इन्हें पास करने से Networks में क्रॉस-सत्र मिलान
        डिटेक्शन को सहायता मिलती है।
      properties:
        ip:
          type: string
          format: ip
          description: अंतिम उपयोगकर्ता के लिए देखा गया IPv4 या IPv6 पता।
          example: 192.0.2.1
        device_id:
          type: string
          maxLength: 255
          description: >-
            आपके एप्लिकेशन द्वारा एकत्र किया गया स्थिर डिवाइस पहचानकर्ता
            (Android `ANDROID_ID`, iOS `identifierForVendor`)।
        device_platform:
          type: string
          enum:
            - android
            - ios
            - ipados
            - tvos
            - web
          description: अंतिम उपयोगकर्ता के डिवाइस का प्लेटफ़ॉर्म।
        device_model:
          type: string
          maxLength: 255
          description: आपके एप्लिकेशन द्वारा रिपोर्ट किया गया डिवाइस मॉडल।
        os_version:
          type: string
          maxLength: 64
          description: ऑपरेटिंग-सिस्टम संस्करण।
        app_version:
          type: string
          maxLength: 64
          description: आपके एप्लिकेशन का संस्करण।
        user_agent:
          type: string
          maxLength: 512
          description: ब्राउज़र या ऐप का user agent।
    RiskWarning:
      type: object
      required:
        - feature
        - risk
        - log_type
        - short_description
        - long_description
      properties:
        feature:
          type: string
          description: सुविधा जिसने चेतावनी उत्पन्न की।
        risk:
          type: string
          description: मशीन-पठनीय जोखिम कोड। समय के साथ नए मान जोड़े जा सकते हैं।
        additional_data:
          type: object
          nullable: true
          additionalProperties: true
          description: जोखिम-विशिष्ट संदर्भ, या `null`।
        log_type:
          type: string
          enum:
            - error
            - warning
            - information
          description: निर्णय नियमों द्वारा उपयोग की जाने वाली गंभीरता।
        short_description:
          type: string
          description: मानव-पठनीय एक पंक्ति का सारांश।
        long_description:
          type: string
          description: मानव-पठनीय स्पष्टीकरण।
    RiskLifecycleEvent:
      type: object
      required:
        - type
        - timestamp
        - details
        - fee
      properties:
        type:
          type: string
          description: मशीन-पठनीय इवेंट प्रकार। समय के साथ नए मान जोड़े जा सकते हैं।
        timestamp:
          type: string
          format: date-time
          description: जब इवेंट हुआ था।
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: इवेंट-विशिष्ट payload, या `null`।
        fee:
          type: number
          description: इस इवेंट के लिए बिल की गई USD राशि।
    EmailMatchItem:
      type: object
      description: >-
        आपके एप्लिकेशन का एक अन्य सत्र जिसने भिन्न `vendor_data` के साथ समान
        ईमेल पते का उपयोग किया।
      properties:
        session_id:
          type: string
          format: uuid
          description: उस अन्य सत्यापन का सत्र id जिसने इस ईमेल पते का उपयोग किया था।
        session_number:
          type: integer
          description: उस सत्र की मानव-पठनीय अनुक्रमिक संख्या।
        vendor_data:
          type: string
          nullable: true
          description: उस सत्र का `vendor_data`।
        verification_date:
          type: string
          description: जब वह सत्र बनाया गया था (`YYYY-MM-DDTHH:MM:SSZ`)।
        email:
          type: string
          description: मिलान किया गया ईमेल पता।
        status:
          type: string
          description: उस सत्र की स्थिति (उदा., `Approved`, `Declined`, `In Progress`)।
        is_blocklisted:
          type: boolean
          description: क्या ईमेल पता आपके एप्लिकेशन की ब्लॉकलिस्ट में है।
        api_service:
          type: string
          nullable: true
          description: >-
            API-प्रकार के सत्रों के लिए, इसे बनाने वाला स्टैंडअलोन API; नियमित
            सत्यापन सत्रों के लिए `null`।
        source:
          type: string
          description: >-
            मिलान कहाँ पाया गया था। आमतौर पर `session`; किसी संगठन सूची
            प्रविष्टि के माध्यम से ब्लॉकलिस्ट हिट `list_entry` का उपयोग करता है।
    EmailIntelligence:
      type: object
      description: >-
        सामान्यीकृत ईमेल-इंटेलिजेंस ब्लॉक। केवल तभी मौजूद होता है जब इस ईमेल के
        लिए इंटेलिजेंस ऐड-ऑन चला हो; मौजूद होने पर इसे समान मानों के साथ
        `enrichment` उपनाम के रूप में भी दिखाया जाता है।
      properties:
        score:
          type: number
          nullable: true
          description: सामान्यीकृत 0-100 जोखिम स्कोर। उच्च मान अधिक जोखिम भरा होता है।
        deliverable:
          type: string
          nullable: true
          description: डिलीवरी क्षमता बैंड (उदा., `high`)।
        breach_risk_level:
          type: string
          nullable: true
          description: '`Low`, `Medium` या `High`।'
        breach_risk_index:
          type: number
          nullable: true
          description: संख्यात्मक उल्लंघन-जोखिम सूचकांक।
        is_recent_breach:
          type: boolean
          nullable: true
          description: '`true` जब पता किसी हालिया ब्रीच में दिखाई देता है।'
        is_frequent_breached:
          type: boolean
          nullable: true
          description: '`true` जब पता कई ब्रीच में दिखाई देता है।'
        is_disposable:
          type: boolean
          nullable: true
          description: '`true` जब डोमेन एक थ्रोअवे प्रदाता हो।'
        is_free_domain:
          type: boolean
          nullable: true
          description: '`true` जब डोमेन एक मुफ़्त मेल प्रदाता हो।'
        is_breached:
          type: boolean
          nullable: true
          description: '`true` जब पता ज्ञात ब्रीच में दिखाई देता है।'
        no_of_breaches:
          type: number
          nullable: true
          description: इस पते को शामिल करने वाले ज्ञात डेटा उल्लंघनों की संख्या।
        reason_codes:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: >-
                  सिग्नल का स्थिर Didit पहचानकर्ता, उदाहरण के लिए `IR-5AC67A32`।
                  अपारदर्शी: इसके आधार पर समूह बनाएँ और फ़िल्टर करें, इसे पार्स
                  न करें।
              value:
                nullable: true
                description: >-
                  जोखिम फ़्लैग के लिए (उदाहरण के लिए `voip`, `leaked`,
                  `disposable`, `spam_trap`), इसका मान: एक बूलियन, एक स्तर या एक
                  तिथि। स्कोर्ड कारण कोड के लिए नल।
              direction:
                type: string
                enum:
                  - risk
                  - trust
                description: क्या सिग्नल ने जोखिम बढ़ाया या विश्वास जोड़ा।
              message:
                type: string
                description: सिग्नल का मानव-पठनीय स्पष्टीकरण, अंग्रेज़ी में।
              impact_level:
                type: string
                nullable: true
                description: >-
                  सिग्नल ने स्कोर को कितनी दृढ़ता से प्रभावित किया, उदाहरण के
                  लिए `low`, `medium` या `high`।
          description: >-
            स्कोर की व्याख्या करने वाले सिग्नल, प्रत्येक एक स्थिर Didit कोड, एक
            दिशा, एक संदेश और एक प्रभाव स्तर के साथ। समय के साथ नए कोड दिखाई दे
            सकते हैं, इसलिए अज्ञात कोड को अस्वीकार न करें।
    EmailSocialFootprint:
      type: object
      nullable: true
      description: >-
        ईमेल पते का सोशल फ़ुटप्रिंट: वे ऑनलाइन प्लेटफ़ॉर्म जिन पर यह पंजीकृत है।
        केवल तभी मौजूद होता है जब `enable_social` सेट किया गया था और जांच पूरी
        हो गई थी। प्रत्येक संख्या शून्य हो सकती है यदि इसके लिए कोई डेटा वापस
        नहीं आया। `profiles_registered: 0` का अर्थ है कि प्लेटफ़ॉर्म की जांच की
        गई थी और उनमें से किसी पर भी ईमेल पता नहीं मिला - एक मान्य, बिल योग्य
        उत्तर और एक सामान्य सिंथेटिक-पहचान संकेत।
      properties:
        profiles_registered:
          type: integer
          nullable: true
          description: वे प्लेटफ़ॉर्म जहाँ ईमेल पते के पंजीकृत होने की पुष्टि हुई है।
          example: 5
        profiles_checked:
          type: integer
          nullable: true
          description: पंजीकरण के लिए मूल्यांकन किए गए प्लेटफ़ॉर्म।
          example: 14
        names_found:
          type: integer
          nullable: true
          description: वे प्लेटफ़ॉर्म जिन्होंने संबद्ध नाम लौटाया।
          example: 0
        photos_found:
          type: integer
          nullable: true
          description: वे प्लेटफ़ॉर्म जिन्होंने प्रोफ़ाइल फ़ोटो लौटाई।
          example: 0
        communication_breadth:
          type: integer
          nullable: true
          description: संचार प्लेटफ़ॉर्म जिनमें उपस्थिति का पता चला है।
          example: 2
        digital_footprint_diversity:
          type: integer
          nullable: true
          description: संसूचित उपस्थिति वाली विशिष्ट प्लेटफ़ॉर्म श्रेणियां।
          example: 5
        digital_sophistication_index:
          type: integer
          nullable: true
          description: कंपोजिट डिजिटल-परिपक्वता संकेतक, 0-10।
          example: 5
        engagement_depth_index:
          type: integer
          nullable: true
          description: प्रोफ़ाइल-समृद्धि संकेतक, 0-10।
          example: 3
        subscription_affordability_index:
          type: integer
          nullable: true
          description: निःशुल्क बनाम सशुल्क प्लेटफ़ॉर्म मिक्स, 0-10।
          example: 2
        free_platforms:
          type: integer
          nullable: true
          description: निःशुल्क प्लेटफ़ॉर्म पर पंजीकरण।
          example: 4
        full_paid_platforms:
          type: integer
          nullable: true
          description: पूरी तरह से भुगतान वाले प्लेटफ़ॉर्म पर पंजीकरण।
          example: 0
        partial_paid_platforms:
          type: integer
          nullable: true
          description: फ़्रीमियम प्लेटफ़ॉर्म पर पंजीकरण।
          example: 1
        whatsapp_profile_completeness:
          type: string
          nullable: true
          enum:
            - Basic
            - Partial
            - Complete
            - Not Present
            - null
          description: WhatsApp प्रोफ़ाइल की पूर्णता। केवल फ़ोन; ईमेल के लिए null।
          example: Partial
        registered_platforms:
          type: array
          description: वे प्लेटफ़ॉर्म जहाँ पंजीकरण की पुष्टि हुई है।
          items:
            $ref: '#/components/schemas/SocialFootprintPlatform'
        not_registered_platforms:
          type: array
          description: नकारात्मक परिणाम के साथ जाँचे गए प्लेटफ़ॉर्म।
          items:
            $ref: '#/components/schemas/SocialFootprintPlatform'
        categories:
          type: object
          description: प्रति प्लेटफ़ॉर्म श्रेणी पंजीकृत संख्या और अनुपात।
          additionalProperties:
            $ref: '#/components/schemas/SocialFootprintCategorySummary'
        profiles:
          type: object
          description: >-
            प्रति-प्लेटफ़ॉर्म प्रोफ़ाइल विवरण, प्लेटफ़ॉर्म द्वारा की-बद्ध, जब
            प्लेटफ़ॉर्म उन्हें प्रदर्शित करता है।
          additionalProperties:
            $ref: '#/components/schemas/SocialFootprintProfile'
    SocialFootprintPlatform:
      type: object
      properties:
        platform:
          type: string
          description: प्लेटफ़ॉर्म पहचानकर्ता।
          example: whatsapp
        category:
          type: string
          description: >-
            प्लेटफ़ॉर्म श्रेणी, उदाहरण के लिए MESSAGING, SOCIAL_MEDIA,
            ECOMMERCE, PROFESSIONAL, EMAIL_PROVIDER।
          example: MESSAGING
        scope:
          type: string
          enum:
            - global
            - local
          description: >-
            विश्वव्यापी प्लेटफ़ॉर्म के लिए `global`, क्षेत्र-विशिष्ट प्लेटफ़ॉर्म
            के लिए `local`।
          example: global
    SocialFootprintCategorySummary:
      type: object
      properties:
        registered:
          type: integer
          nullable: true
          description: इस श्रेणी के वे प्लेटफ़ॉर्म जहाँ पंजीकरण की पुष्टि हो गई है।
          example: 2
        ratio:
          type: number
          format: float
          nullable: true
          description: श्रेणी के जाँचे गए प्लेटफ़ॉर्म का पंजीकरण सहित हिस्सा, 0.0-1.0।
          example: 0.6667
    SocialFootprintProfile:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: प्रोफ़ाइल का नाम, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
        photo:
          type: string
          nullable: true
          description: प्रोफ़ाइल फ़ोटो URL, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
        about:
          type: string
          nullable: true
          description: >-
            प्रोफ़ाइल का अबाउट/बायो टेक्स्ट, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता
            है।
        privacy_status:
          type: string
          nullable: true
          enum:
            - PUBLIC
            - PRIVATE
            - null
          description: प्रोफ़ाइल दृश्यता, जब प्लेटफ़ॉर्म इसे प्रदर्शित करता है।
        business_account:
          type: boolean
          nullable: true
          description: >-
            क्या प्रोफ़ाइल एक व्यावसायिक खाता है, जब प्लेटफ़ॉर्म इसे प्रदर्शित
            करता है।
  responses:
    EmailRiskValidationError:
      description: अनुरोध सत्यापन विफल रहा।
      content:
        application/json:
          examples:
            Missing email:
              summary: ईमेल मौजूद नहीं है
              value:
                email:
                  - This field is required.
            Invalid email:
              summary: अमान्य ईमेल
              value:
                email:
                  - Enter a valid email address.
            Invalid country hint:
              summary: अमान्य देश संकेत
              value:
                country_code:
                  - Ensure this field has no more than 3 characters.
    RiskPermissionDenied:
      description: >-
        API कुंजी अनुपलब्ध या अमान्य है, या संगठन लाइव लुकअप को कवर नहीं कर सकता
        है। यह API कभी भी `401` नहीं लौटाता है।
      content:
        application/json:
          examples:
            Missing or invalid API key:
              summary: कोई `x-api-key` हेडर नहीं, या कुंजी अमान्य या निरस्त है
              value:
                detail: You do not have permission to perform this action.
            Not enough credits:
              summary: संगठन का बैलेंस लुकअप की कीमत को कवर नहीं कर सकता
              value:
                error: You don't have enough credits to perform this request.
    RateLimitedWrite:
      description: >-
        प्रति API कुंजी प्रति मिनट 300 अनुरोधों की साझा लिखने की सीमा पार हो गई।
        पुनः प्रयास करने से पहले `Retry-After` का पालन करें।
      content:
        application/json:
          schema:
            type: object
            required:
              - detail
            properties:
              detail:
                type: string
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
  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.