> ## 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 उसे स्टोर करता है, समृद्ध करता है और आपके नियमों से स्कोर करता है।



मॉनिटरिंग इवेंट बनाने के लिए API प्रॉम्प्ट
        प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें



      
      

\<pre>

\`Send one non-monetary monitoring event (login, session, gameplay, bonus, affiliate, payment, dispute, security, responsible gambling or custom) from my backend to Didit.

Endpoint:
POST https://verification.didit.me/v3/events/

Authentication:
Use the x-api-key header with my Didit API key, from my backend only. A scoped key needs transactions: write.

Goal:
\- Record what happened on my platform so Didit's event rules can score it alongside my transactions, and read the verdict from the response.

Request body (application/json):
\{
"event_id": "login-2026-10-17-000001",   // required - my id, unique per application, the idempotency key (max 128)
"event_category": "auth",                // required - auth, session, gameplay, bonus, affiliate, payment, dispute, security, responsible_gambling, custom
"action_type": "login",                  // required - what happened inside the category (max 128)
"occurred_at": "2026-10-17T09:15:02.481Z", // required - at most 7 days in the past, 5 minutes in the future
"subject": { "vendor_data": "user-42", "entity_type": "individual" }, // required - entity_type individual (default) or company
"session": { "session_id": "web-session-abc", "sequence": 142 },
"device_context": { "fingerprint": "didit-fp-v2:a8c1", "network_context": { "ip_address": "203.0.113.42" } },
"transaction_context": { "amount": "1000.00", "currency": "EUR", "payment_reference_id": "dep_735" },
"payload": { "method": "password" },     // category fields, max 16 KB
"custom_values": { "vip_tier": "gold" }  // max 100 scalar keys
}

Behavior:
\- Validated, stored, IP-enriched and evaluated by the real-time event rules before the response returns. Cross-subject and long-window rules run asynchronously within minutes (correlation_pending: true).
\- Some actions require payload keys, for example gameplay.p2p_settlement (game_id, counterparty_vendor_data, stake_amount, net_result_amount, role, and one of hand_id, round_id, match_id), payment.deposit_completed (payment_reference_id, amount, currency, payment_method, status) and dispute.chargeback_opened (payment_reference_id and one of dispute_id, chargeback_id). transaction_context keys count towards these requirements.
\- Send hashes and references, never a card number, a full withdrawal address, a password hash or an MFA secret.
\- Idempotency: the same event_id with the same event_category, action_type, occurred_at, subject.vendor_data and payload returns 200 with idempotent_replay true and the stored event's result. Different values in those fields return 409; the other fields are not compared. Retry safely on timeouts.
\- The IP address used for enrichment and rules is device_context.network_context.ip_address as you send it.
\- In a sandbox application no rules run: status is ACCEPTED and rules_evaluated_count is 0.
\- The subject resolves to the user (or company) with that vendor_data; one is created when none exists.
\- Event ingestion is opt-in: until it is switched on in Transactions > Settings > Event monitoring, this call returns 403 with code event_monitoring_disabled and stores nothing.

Example call:
curl -X POST "https://verification.didit.me/v3/events/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"event_id":"login-2026-10-17-000001","event_category":"auth","action_type":"login","occurred_at":"2026-10-17T09:15:02.481Z","subject":{"vendor_data":"user-42"},"device_context":{"network_context":{"ip_address":"203.0.113.42"}},"payload":{"method":"password"}}'

What to read from the response:
\- event_uuid - Didit id of the stored event.
\- status - ACCEPTED (stored, no rule changed it), APPROVED, IN_REVIEW or DECLINED.
\- score, rules_evaluated_count, rules_matched_count, rule_matches[] (rule_id, library_key, mode, is_async).
\- correlation_pending - when true, read GET /v3/events/{event_uuid}/ later for the final status.
\- retention_class and expires_at (null for payment and dispute events).
\- idempotent_replay - true when the event was already stored.

Failure modes:
\- 400 - validation error keyed by field (missing field, occurred_at outside the window, payload over 16 KB, nested custom_values, missing required payload keys).
\- 401 - the API key has expired.
\- 403 - missing API key (a wrong, revoked or expired key gets 401), a scoped key without transactions: write, or code event_monitoring_disabled.
\- 409 - event_id reused with different content; use a new event_id.
\- 429 - more than 600 ingestion requests per minute for this API key (event and transaction ingestion share this budget, apart from the 300 of every other write); honor Retry-After.

Side effects: stores the event, may create the subject's user or company, and applies the actions of matched active rules (score, status, tags, notes, list entries, cases).

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

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

> [!NOTE]
>
> इवेंट इनजेशन ऑप्ट-इन है। इवेंट भेजने से पहले **Transactions > Settings > Event monitoring** में इसे चालू करें; तब तक यह endpoint `"code": "event_monitoring_disabled"` के साथ `403` लौटाता है।[इवेंट इनजेशन](https://docs.didit.me/hi/transaction-monitoring/events.md) में एनवेलप, दस श्रेणियाँ, आवश्यक payload कुंजियाँ और रिटेंशन क्लास शामिल हैं। [इवेंट पर नियम](https://docs.didit.me/hi/transaction-monitoring/event-rules.md) बताता है कि कौन से नियम अनुरोध के दौरान चलते हैं और कौन से असिंक्रोनस रूप से। अपने बैकएंड के बजाय ब्राउज़र या ऐप से इवेंट भेजने के लिए [SDK इवेंट सबमिशन](https://docs.didit.me/hi/transaction-monitoring/sdk-event-submission.md) का उपयोग करें।


## OpenAPI

````yaml hi/openapi-25.json POST /v3/events/
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/events/:
    post:
      tags:
        - Monitoring Events
      summary: निगरानी इवेंट बनाएं
      description: >-
        अपने बैकएंड से एक गैर-मौद्रिक इवेंट (लॉगिन, सत्र, गेमप्ले, बोनस,
        एफिलिएट, भुगतान, विवाद, सुरक्षा, ज़िम्मेदार जुआ या कस्टम) भेजें। इवेंट
        को उसके श्रेणी अनुबंध के विरुद्ध मान्य किया जाता है, संग्रहीत किया जाता
        है, प्रति अद्वितीय सार्वजनिक पते पर एक बार IP-संवर्धित किया जाता है, और
        रिस्पॉन्स लौटने से पहले आपके रीयल-टाइम इवेंट नियमों द्वारा मूल्यांकन
        किया जाता है; क्रॉस-विषय और लंबी-अवधि के नियम एसिंक्रोनस रूप से चलते हैं
        (`correlation_pending: true`), और सैंडबॉक्स एप्लिकेशन में कोई नियम नहीं
        चलते हैं। `event_id` आइडेम्पोटेंसी कुंजी है: समान `event_category`,
        `action_type`, `occurred_at`, `subject.vendor_data` और `payload` के साथ
        समान `event_id` `idempotent_replay: true` और संग्रहीत परिणाम के साथ
        `200` लौटाता है (अन्य लिफ़ाफ़ा फ़ील्ड की तुलना नहीं की जाती है), जबकि
        भिन्न मान `409` लौटाते हैं। इवेंट इनजेशन प्रति एप्लिकेशन ऑप्ट-इन है: जब
        तक इसे चालू नहीं किया जाता, यह endpoint `code:
        event_monitoring_disabled` के साथ `403` लौटाता है और कुछ भी संग्रहीत
        नहीं करता है। एक स्कोप्ड API कुंजी को `transactions: write` की आवश्यकता
        होती है। [इवेंट
        इनजेशन](https://docs.didit.me/hi/transaction-monitoring/events) और
        [इवेंट्स पर
        नियम](https://docs.didit.me/hi/transaction-monitoring/event-rules)
        देखें; ब्राउज़र या ऐप से इवेंट भेजने के लिए, [SDK इवेंट
        सबमिशन](https://docs.didit.me/hi/transaction-monitoring/sdk-event-submission)
        का उपयोग करें।
      operationId: create_monitoring_event
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringEventCreateRequest'
            examples:
              Login:
                value:
                  event_id: login-2026-10-17-000001
                  event_category: auth
                  action_type: login
                  occurred_at: '2026-10-17T09:15:02.481Z'
                  time_zone: Europe/Madrid
                  subject:
                    vendor_data: user-42
                    entity_type: individual
                  session:
                    session_id: web-session-abc
                    sequence: 142
                  device_context:
                    fingerprint: fp-a8c1
                    network_context:
                      ip_address: 203.0.113.42
                  payload:
                    method: password
                  custom_values:
                    vip_tier: gold
              Deposit completed:
                value:
                  event_id: deposit-2026-10-17-000002
                  event_category: payment
                  action_type: deposit_completed
                  occurred_at: '2026-10-17T09:16:40Z'
                  subject:
                    vendor_data: user-42
                  transaction_context:
                    amount: '100.00'
                    currency: EUR
                    direction: inbound
                    payment_reference_id: dep_736
                  payload:
                    payment_method: card
                    status: completed
              Chargeback opened:
                value:
                  event_id: chargeback-2026-10-16-000318
                  event_category: dispute
                  action_type: chargeback_opened
                  occurred_at: '2026-10-16T14:02:11Z'
                  subject:
                    vendor_data: user-42
                  payload:
                    payment_reference_id: dep_735
                    chargeback_id: cb_5521
                    amount: '250.00'
                    currency: EUR
                    reason_code: fraud
      responses:
        '200':
          description: >-
            आइडेम्पोटेंट रीप्ले: इस `event_id` और समान सामग्री वाला एक इवेंट
            पहले से संग्रहीत है। कुछ भी दोबारा संग्रहीत या मूल्यांकित नहीं किया
            गया था; बॉडी संग्रहीत इवेंट का विवरण देती है।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringEventIngestResult'
              examples:
                Replay:
                  value:
                    event_uuid: 33333333-4444-5555-6666-777777777777
                    event_id: login-2026-10-17-000001
                    status: ACCEPTED
                    score: 0
                    rules_evaluated_count: 6
                    rules_matched_count: 0
                    correlation_pending: false
                    retention_class: standard
                    expires_at: '2026-11-16T09:15:02.481000Z'
                    idempotent_replay: true
                    rule_matches: []
        '201':
          description: इवेंट को संग्रहीत और मूल्यांकित किया गया था।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringEventIngestResult'
              examples:
                Stored, no rule matched:
                  value:
                    event_uuid: 33333333-4444-5555-6666-777777777777
                    event_id: login-2026-10-17-000001
                    status: ACCEPTED
                    score: 0
                    rules_evaluated_count: 6
                    rules_matched_count: 0
                    correlation_pending: false
                    retention_class: standard
                    expires_at: '2026-11-16T09:15:02.481000Z'
                    idempotent_replay: false
                    rule_matches: []
                Rule matched, async rule pending:
                  value:
                    event_uuid: 33333333-4444-5555-6666-777777777777
                    event_id: login-2026-10-17-000001
                    status: IN_REVIEW
                    score: 40
                    rules_evaluated_count: 6
                    rules_matched_count: 1
                    correlation_pending: true
                    retention_class: risk_relevant
                    expires_at: '2027-01-15T09:15:02.481000Z'
                    idempotent_replay: false
                    rule_matches:
                      - rule_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                        library_key: null
                        mode: ACTIVE
                        is_async: false
        '400':
          description: >-
            सत्यापन विफल रहा। body को फ़ील्ड के अनुसार कुंजीबद्ध किया गया है;
            नेस्टेड फ़ील्ड नेस्टेड ऑब्जेक्ट हैं। कुछ भी संग्रहीत नहीं किया जाता
            है।
          content:
            application/json:
              examples:
                Missing fields:
                  value:
                    event_id:
                      - This field is required.
                    subject:
                      - This field is required.
                Unknown category:
                  value:
                    event_category:
                      - '"login" is not a valid choice.'
                occurred_at too old:
                  value:
                    occurred_at:
                      - >-
                        occurred_at is more than 7 days in the past. Use the
                        batch import lane for backfills.
                occurred_at in the future:
                  value:
                    occurred_at:
                      - occurred_at is more than 5 minutes in the future.
                Missing subject vendor_data:
                  value:
                    subject:
                      vendor_data:
                        - This field is required.
                Missing required payload keys:
                  value:
                    payload:
                      - >-
                        payment.deposit_completed requires: payment_method,
                        status.
                Missing one-of payload key:
                  value:
                    payload:
                      - >-
                        dispute.chargeback_opened requires one of: dispute_id,
                        chargeback_id.
                Security change without changed_field:
                  value:
                    payload:
                      - security.*_changed requires 'changed_field'.
                Payload too large:
                  value:
                    payload:
                      - >-
                        payload exceeds 16384 bytes. Summarise telemetry
                        client-side.
                Too many custom_values:
                  value:
                    custom_values:
                      - custom_values accepts at most 100 keys.
                Nested custom value:
                  value:
                    custom_values:
                      - >-
                        custom_values['limits'] must be a scalar - rule
                        conditions cannot address nested values.
        '401':
          description: >-
            स्कोप्ड API कुंजी की समय-सीमा समाप्त हो गई है। केवल समय-सीमा समाप्त
            कुंजी को `401` मिलता है; अनुपलब्ध या अमान्य कुंजी को `403` मिलता है।
          content:
            application/json:
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            अनुपस्थित `x-api-key` (गलत, निरस्त या समाप्त कुंजी को `401` मिलता
            है), बिना `transactions: write` वाली स्कोप्ड कुंजी, कुछ वर्कफ़्लो या
            स्वीकृत सत्रों तक सीमित कुंजी (ऐसी कुंजी लेन-देन निगरानी डेटा तक कभी
            नहीं पहुँचती), या कुंजी की IP अनुमति सूची के बाहर से किया गया
            अनुरोध। एप्लिकेशन के लिए इवेंट इनजेशन बंद होने पर `code:
            event_monitoring_disabled` के साथ भी लौटाया जाता है; उस स्थिति में
            कुछ भी संग्रहीत नहीं किया जाता है, और यह जाँच अनुरोध के मुख्य भाग के
            मान्य होने से पहले चलती है।
          content:
            application/json:
              examples:
                Event monitoring disabled:
                  value:
                    detail: >-
                      Event monitoring is not enabled for this application. Turn
                      on event ingestion in the transaction monitoring settings
                      before submitting events.
                    code: event_monitoring_disabled
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without access:
                  value:
                    detail: This API key has no write access to transactions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                IP not allowed:
                  value:
                    detail: This API key can't be used from this IP address.
        '409':
          description: >-
            `event_id` का उपयोग पहले से ही भिन्न सामग्री (श्रेणी, कार्रवाई
            प्रकार, `occurred_at`, विषय `vendor_data` या payload) वाले इवेंट के
            लिए किया गया था। इवेंट को नए `event_id` के तहत भेजें।
          content:
            application/json:
              examples:
                event_id reused:
                  value:
                    event_id: >-
                      event_id 'login-2026-10-17-000001' already exists with a
                      different payload.
        '429':
          description: >-
            रेट लिमिट पार हो गई: लेन-देन निर्माण और इवेंट इनजेशन (`POST
            /v3/transactions/`, `POST /v3/events/`, `POST /v3/events/batch/`)
            प्रति API कुंजी प्रति मिनट 600 अनुरोधों का बजट साझा करते हैं, जो
            अन्य सभी राइट अनुरोधों द्वारा साझा किए जाने वाले 300 से अलग है।
            `Retry-After` सेकंड प्रतीक्षा करें, फिर पुनः प्रयास करें।
          headers:
            Retry-After:
              description: >-
                पुनः प्रयास करने से पहले प्रतीक्षा करने के सेकंड, जिन्हें ऊपर की
                ओर पूर्णांकित किया गया है ताकि पुनः प्रयास अगली विंडो में हो।
              schema:
                type: integer
                minimum: 1
                example: 30
          content:
            application/json:
              examples:
                Throttled:
                  value:
                    detail: >-
                      Ingestion rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST 'https://verification.didit.me/v3/events/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "event_id": "login-2026-10-17-000001",
                "event_category": "auth",
                "action_type": "login",
                "occurred_at": "2026-10-17T09:15:02.481Z",
                "subject": {"vendor_data": "user-42", "entity_type": "individual"},
                "session": {"session_id": "web-session-abc", "sequence": 142},
                "device_context": {
                  "fingerprint": "fp-a8c1",
                  "network_context": {"ip_address": "203.0.113.42"}
                },
                "payload": {"method": "password"}
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.monitoring_events.create(
                event_id="login-2026-10-17-000001",
                event_category="auth",
                action_type="login",
                occurred_at="2026-10-17T09:15:02.481Z",
                time_zone="Europe/Madrid",
                subject={
                    "vendor_data": "user-42",
                    "entity_type": "individual",
                },
                session={
                    "session_id": "web-session-abc",
                    "sequence": 142,
                },
                device_context={
                    "fingerprint": "fp-a8c1",
                    "network_context": {
                        "ip_address": "203.0.113.42",
                    },
                },
                payload={"method": "password"},
                custom_values={"vip_tier": "gold"},
            )
            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.monitoringEvents.create({
              event_id: "login-2026-10-17-000001",
              event_category: "auth",
              action_type: "login",
              occurred_at: "2026-10-17T09:15:02.481Z",
              time_zone: "Europe/Madrid",
              subject: {
                vendor_data: "user-42",
                entity_type: "individual",
              },
              session: {
                session_id: "web-session-abc",
                sequence: 142,
              },
              device_context: {
                fingerprint: "fp-a8c1",
                network_context: {
                  ip_address: "203.0.113.42",
                },
              },
              payload: { method: "password" },
              custom_values: { vip_tier: "gold" },
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.Create(ctx, didit.MonitoringEventCreateRequest{\n\tEventID:       \"login-2026-10-17-000001\",\n\tEventCategory: \"auth\",\n\tActionType:    \"login\",\n\tOccurredAt:    time.Date(2026, 10, 17, 9, 15, 2, 0, time.UTC),\n\tTimeZone:      didit.String(\"Europe/Madrid\"),\n\tSubject: didit.MonitoringEventCreateRequestSubject{\n\t\tVendorData: \"user-42\",\n\t\tEntityType: didit.String(\"individual\"),\n\t},\n\tSession: didit.Some(didit.MonitoringEventCreateRequestSession{\n\t\tSessionID: didit.String(\"web-session-abc\"),\n\t\tSequence:  didit.Int(142),\n\t}),\n\tDeviceContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContext{\n\t\tFingerprint: didit.String(\"fp-a8c1\"),\n\t\tNetworkContext: didit.Some(didit.MonitoringEventCreateRequestDeviceContextNetworkContext{\n\t\t\tIPAddress: didit.String(\"203.0.113.42\"),\n\t\t}),\n\t}),\n\tPayload:      didit.Some(map[string]any{\"method\": \"password\"}),\n\tCustomValues: didit.Some(map[string]any{\"vip_tier\": \"gold\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.time.OffsetDateTime;

            import java.util.Map;

            import me.didit.Didit;

            import me.didit.types.MonitoringEventCreateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.monitoringEvents().create(MonitoringEventCreateRequest.builder()
                    .eventId("login-2026-10-17-000001")
                    .eventCategory(MonitoringEventCreateRequest.EventCategory.of("auth"))
                    .actionType("login")
                    .occurredAt(OffsetDateTime.parse("2026-10-17T09:15:02.481Z"))
                    .timeZone("Europe/Madrid")
                    .subject(MonitoringEventCreateRequest.Subject.builder()
                            .vendorData("user-42")
                            .entityType("individual")
                            .build())
                    .session(MonitoringEventCreateRequest.Session.builder()
                            .sessionId("web-session-abc")
                            .sequence(142L)
                            .build())
                    .deviceContext(MonitoringEventCreateRequest.DeviceContext.builder()
                            .fingerprint("fp-a8c1")
                            .networkContext(MonitoringEventCreateRequest.DeviceContext.NetworkContext.builder()
                                    .ipAddress("203.0.113.42")
                                    .build())
                            .build())
                    .payload(Map.of("method", "password"))
                    .customValues(Map.of("vip_tier", MonitoringEventCreateRequest.CustomValuesValue.ofString("gold")))
                    .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->monitoringEvents->create([
                'event_id' => 'login-2026-10-17-000001',
                'event_category' => 'auth',
                'action_type' => 'login',
                'occurred_at' => '2026-10-17T09:15:02.481Z',
                'time_zone' => 'Europe/Madrid',
                'subject' => [
                    'vendor_data' => 'user-42',
                    'entity_type' => 'individual',
                ],
                'session' => [
                    'session_id' => 'web-session-abc',
                    'sequence' => 142,
                ],
                'device_context' => [
                    'fingerprint' => 'fp-a8c1',
                    'network_context' => [
                        'ip_address' => '203.0.113.42',
                    ],
                ],
                'payload' => ['method' => 'password'],
                'custom_values' => ['vip_tier' => 'gold'],
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.monitoring_events.create(
              event_id: "login-2026-10-17-000001",
              event_category: "auth",
              action_type: "login",
              occurred_at: "2026-10-17T09:15:02.481Z",
              time_zone: "Europe/Madrid",
              subject: {
                vendor_data: "user-42",
                entity_type: "individual",
              },
              session: {
                session_id: "web-session-abc",
                sequence: 142,
              },
              device_context: {
                fingerprint: "fp-a8c1",
                network_context: {
                  ip_address: "203.0.113.42",
                },
              },
              payload: { method: "password" },
              custom_values: { vip_tier: "gold" }
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Collections.Generic;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await client.MonitoringEvents.CreateAsync(new
            MonitoringEventCreateRequest

            {
                EventId = "login-2026-10-17-000001",
                EventCategory = "auth",
                ActionType = "login",
                OccurredAt = DateTimeOffset.Parse("2026-10-17T09:15:02.481Z"),
                TimeZone = "Europe/Madrid",
                Subject = new()
                {
                    VendorData = "user-42",
                    EntityType = "individual",
                },
                Session = new MonitoringEventCreateRequestSession
                {
                    SessionId = "web-session-abc",
                    Sequence = 142,
                },
                DeviceContext = new MonitoringEventCreateRequestDeviceContext
                {
                    Fingerprint = "fp-a8c1",
                    NetworkContext = new MonitoringEventCreateRequestDeviceContextNetworkContext
                    {
                        IpAddress = "203.0.113.42",
                    },
                },
                Payload = new Dictionary<string, object> { ["method"] = "password" },
                CustomValues = new Dictionary<string, object> { ["vip_tier"] = "gold" },
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    MonitoringEventCreateRequest:
      type: object
      description: >-
        इवेंट एनवेलप, प्रत्येक श्रेणी के लिए समान। camelCase उपनाम स्वीकार किए
        जाते हैं: `eventId`, `eventCategory` (या `category`), `actionType`,
        `occurredAt`, `timeZone` (या `zoneId`), `deviceContext` (या `device`),
        `transactionContext`, `customValues` (या `props`); `subject` के अंदर:
        `vendorData`, `entityType`, `fullName`; `session` के अंदर: `sessionId`,
        `pageUrl`; `transaction_context` के अंदर: `paymentReferenceId`।
      required:
        - event_id
        - event_category
        - action_type
        - occurred_at
        - subject
      properties:
        event_id:
          type: string
          maxLength: 128
          description: >-
            इवेंट के लिए आपका पहचानकर्ता, प्रति एप्लिकेशन अद्वितीय। यह
            आइडेम्पोटेंसी कुंजी है: इसके तहत समान `event_category`,
            `action_type`, `occurred_at`, `subject.vendor_data` और `payload` को
            फिर से भेजना एक रीप्ले है, कुछ भी भिन्न होना एक विरोधाभास (conflict)
            है।
          example: login-2026-10-17-000001
        event_category:
          type: string
          enum:
            - auth
            - session
            - gameplay
            - bonus
            - affiliate
            - payment
            - dispute
            - security
            - responsible_gambling
            - custom
          description: इवेंट श्रेणी।
          example: auth
        action_type:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            श्रेणी के भीतर क्या हुआ। ओपन वोकैब्युलरी; [Event
            ingestion](https://docs.didit.me/hi/transaction-monitoring/events)
            में सूचीबद्ध प्रबंधित कार्रवाइयां (उदाहरण के लिए `login`,
            `deposit_completed`, `chargeback_opened`) टाइप्ड सत्यापन और प्रबंधित
            नियम फ़ील्ड अनलॉक करती हैं। शुरुआत और अंत के व्हाइटस्पेस को ट्रिम कर
            दिया जाता है।
          example: login
        occurred_at:
          type: string
          format: date-time
          description: >-
            जब इवेंट आपकी ओर से हुआ था, ISO 8601 (ऑफ़सेट के बिना किसी मान को UTC
            माना जाता है)। अतीत में 7 दिनों से अधिक और भविष्य में 5 मिनट से अधिक
            नहीं होना चाहिए।
          example: '2026-10-17T09:15:02.481Z'
        time_zone:
          type: string
          nullable: true
          maxLength: 64
          description: >-
            आपकी ओर से घटना का टाइम ज़ोन, उदाहरण के लिए `Europe/Madrid`। इवेंट
            के साथ संग्रहीत किया जाता है; रीड endpoint द्वारा वापस नहीं किया
            जाता।
        subject:
          type: object
          description: >-
            वह उपयोगकर्ता या कंपनी जिससे यह इवेंट संबंधित है। यह आपके एप्लिकेशन
            में इस `vendor_data` वाले उपयोगकर्ता (या कंपनी) से मेल खाता है; यदि
            कोई मौजूद नहीं है तो एक बनाया जाता है।
          required:
            - vendor_data
          properties:
            vendor_data:
              type: string
              minLength: 1
              maxLength: 255
              description: विषय के लिए आपकी id।
              example: user-42
            entity_type:
              type: string
              maxLength: 32
              default: individual
              description: >-
                `company` सब्जेक्ट को एक कंपनी के रूप में रिज़ॉल्व करता है; कोई
                अन्य मान (डिफ़ॉल्ट `individual`) इसे एक व्यक्ति के रूप में
                रिज़ॉल्व करता है। एक ही `vendor_data` दोनों में से एक-एक को
                नामित कर सकता है।
              example: individual
            full_name:
              type: string
              nullable: true
              maxLength: 512
              description: >-
                डिस्प्ले नाम, केवल तभी उपयोग किया जाता है जब यह इवेंट उपयोगकर्ता
                या कंपनी बनाता है।
            email:
              type: string
              format: email
              nullable: true
              description: ईमेल पते के रूप में सत्यापित; इवेंट पर संग्रहीत नहीं।
            phone:
              type: string
              nullable: true
              maxLength: 32
              description: सत्यापित; इवेंट पर संग्रहीत नहीं।
            country:
              type: string
              nullable: true
              maxLength: 3
              description: सत्यापित; इवेंट पर संग्रहीत नहीं।
        business:
          type: object
          description: >-
            वह व्यवसाय जिससे इवेंट संबंधित है, जब यह विषय से भिन्न होता है। केवल
            `vendor_data` पढ़ा जाता है।
          additionalProperties: true
          properties:
            vendor_data:
              type: string
              maxLength: 255
              description: >-
                व्यवसाय के लिए आपकी id। `business_vendor_data` के रूप में
                फ़िल्टर करने योग्य।
              example: merchant-7
        session:
          type: object
          description: इवेंट के लिए आपका सत्र संदर्भ।
          properties:
            session_id:
              type: string
              nullable: true
              maxLength: 255
              description: >-
                आपका सत्र पहचानकर्ता। फ़िल्टर करने योग्य और `session_id` के रूप
                में वापस किया गया।
            sequence:
              type: integer
              nullable: true
              description: >-
                सत्र के भीतर इवेंट की स्थिति। `session_sequence` के रूप में
                लौटाया गया।
            page_url:
              type: string
              nullable: true
              maxLength: 2048
              description: सत्यापित; इवेंट पर संग्रहीत नहीं।
            referrer:
              type: string
              nullable: true
              maxLength: 2048
              description: सत्यापित; इवेंट पर संग्रहीत नहीं।
        device_context:
          type: object
          additionalProperties: true
          description: >-
            डिवाइस और नेटवर्क संदर्भ, जैसा भेजा गया था वैसे ही संग्रहीत और `GET
            /v3/events/{event_uuid}/` द्वारा लौटाया गया। इस सर्वर लेन पर Didit
            अंतिम उपयोगकर्ता का कनेक्शन नहीं देखता है, इसलिए नियमों द्वारा
            संवर्धित और उपयोग किया जाने वाला IP आपके द्वारा भेजा गया
            `network_context.ip_address` है।
          properties:
            fingerprint:
              type: string
              maxLength: 255
              description: >-
                डिवाइस फ़िंगरप्रिंट। `device_fingerprint` के रूप में फ़िल्टर
                करने योग्य।
            persistent_device_id:
              type: string
              maxLength: 255
              description: आपका स्थायी डिवाइस पहचानकर्ता।
            bot_score:
              type: integer
              description: >-
                आपकी अपनी पहचान प्रणाली से प्राप्त बॉट स्कोर, एक पूर्णांक
                (integer) के रूप में।
            network_context:
              type: object
              additionalProperties: true
              properties:
                ip_address:
                  type: string
                  maxLength: 64
                  description: >-
                    अंतिम उपयोगकर्ता का IP पता। प्रत्येक विशिष्ट सार्वजनिक पते
                    को एक बार समृद्ध किया जाता है।
                  example: 203.0.113.42
        transaction_context:
          type: object
          description: >-
            धन संबंधी संदर्भ। यहाँ गैर-रिक्त मान कार्रवाई की आवश्यक payload
            कुंजियों को भी संतुष्ट करते हैं।
          properties:
            amount:
              type: string
              nullable: true
              description: >-
                दशमलव स्ट्रिंग के रूप में राशि (एक संख्या भी स्वीकार की जाती
                है)।
              example: '1000.00'
            currency:
              type: string
              nullable: true
              maxLength: 10
              description: मुद्रा कोड।
            direction:
              type: string
              nullable: true
              maxLength: 16
              description: धन के संचलन की दिशा, उदाहरण के लिए `inbound` या `outbound`।
            payment_reference_id:
              type: string
              nullable: true
              maxLength: 255
              description: >-
                आपका भुगतान संदर्भ। `payment_reference_id` के रूप में फ़िल्टर
                करने योग्य।
        payload:
          type: object
          additionalProperties: true
          description: >-
            श्रेणी के डोमेन फ़ील्ड, JSON-एन्कोड होने के बाद अधिकतम 16384 बाइट्स।
            कुछ कार्रवाइयों के लिए कुंजियों की आवश्यकता होती है (`payload` या
            `transaction_context` में): `gameplay.p2p_settlement` के लिए
            `game_id`, `counterparty_vendor_data`, `stake_amount`,
            `net_result_amount`, `role` और `hand_id`, `round_id`, `match_id` में
            से एक आवश्यक है; `gameplay.bet_placed` और `gameplay.bet_settled` के
            लिए `game_id` आवश्यक है; `payment.deposit_initiated`,
            `payment.deposit_completed`, `payment.withdrawal_requested` और
            `payment.withdrawal_completed` के लिए `payment_reference_id`,
            `amount`, `currency`, `payment_method`, `status` आवश्यक हैं;
            `payment.withdrawal_address_changed` के लिए
            `withdrawal_address_hash` आवश्यक है; `dispute.chargeback_opened`,
            `dispute.chargeback_won` और `dispute.chargeback_lost` के लिए
            `payment_reference_id` और `dispute_id`, `chargeback_id` में से एक
            आवश्यक है; `session.bot_signal_observed` के लिए
            `telemetry_schema_version` और `bot_score`, `actions_per_minute`,
            `timing_variance_ms`, `pointer_entropy`, `keystroke_entropy`,
            `reaction_time_ms_p50` में से एक आवश्यक है;
            `responsible_gambling.self_exclusion_match` के लिए
            `registry_source`, `exclusion_status`, `identity_match_ref` आवश्यक
            हैं। `_changed` पर समाप्त होने वाली प्रत्येक `security` कार्रवाई के
            लिए `changed_field`, साथ ही `previous_reference_hash` या
            `new_reference_hash` आवश्यक है जब फ़ील्ड `password`, `mfa_method`,
            `mfa`, `email`, `phone`, `withdrawal_address`, `payout_method` या
            `api_key` हो। हैश और संदर्भ भेजें, कभी भी कार्ड नंबर, पूर्ण निकासी
            पता, पासवर्ड हैश या MFA सीक्रेट न भेजें।
        custom_values:
          type: object
          description: >-
            आपकी अपनी अधिकतम 100 कुंजियाँ, जिन्हें नियमों से
            `custom_values.<key>` के रूप में संदर्भित किया जा सकता है। मान अदिश
            (string, number, boolean या null) होने चाहिए; नेस्टेड ऑब्जेक्ट और
            ऐरे अस्वीकार कर दिए जाते हैं।
          additionalProperties:
            nullable: true
            oneOf:
              - type: string
              - type: number
              - type: boolean
      example:
        event_id: login-2026-10-17-000001
        event_category: auth
        action_type: login
        occurred_at: '2026-10-17T09:15:02.481Z'
        time_zone: Europe/Madrid
        subject:
          vendor_data: user-42
          entity_type: individual
        session:
          session_id: web-session-abc
          sequence: 142
        device_context:
          fingerprint: fp-a8c1
          network_context:
            ip_address: 203.0.113.42
        payload:
          method: password
        custom_values:
          vip_tier: gold
    MonitoringEventIngestResult:
      type: object
      description: >-
        एक इवेंट को इनजेस्ट करने का परिणाम। नए इवेंट और आइडेम्पोटेंट रीप्ले
        दोनों के लिए समान संरचना लौटाई जाती है।
      required:
        - event_uuid
        - event_id
        - status
        - score
        - rules_evaluated_count
        - rules_matched_count
        - correlation_pending
        - retention_class
        - expires_at
        - idempotent_replay
        - rule_matches
      properties:
        event_uuid:
          type: string
          format: uuid
          description: संग्रहीत इवेंट का Didit पहचानकर्ता।
        event_id:
          type: string
          description: आपकी `event_id`।
        status:
          type: string
          enum:
            - ACCEPTED
            - APPROVED
            - IN_REVIEW
            - DECLINED
          description: >-
            रीयल-टाइम नियम चलने के बाद की स्थिति। `MonitoringEvent.status`
            देखें।
        score:
          type: integer
          description: रीयल-टाइम नियम चलने के बाद का स्कोर।
        rules_evaluated_count:
          type: integer
          minimum: 0
          description: >-
            अनुरोध में मूल्यांकित इवेंट नियमों की संख्या। सैंडबॉक्स एप्लिकेशन
            में 0, जहाँ कोई नियम नहीं चलता।
        rules_matched_count:
          type: integer
          minimum: 0
          description: मेल खाने वाले नियमों की संख्या, जिसमें `TEST` मोड के नियम शामिल हैं।
        correlation_pending:
          type: boolean
          description: >-
            `true` जब किसी एसिंक्रोनस नियम को अभी चलना बाकी हो। अंतिम `status`
            और `score` के लिए कुछ मिनट बाद `GET /v3/events/{event_uuid}/` पढ़ें।
        retention_class:
          type: string
          enum:
            - low_value
            - standard
            - risk_relevant
            - monetary_or_compliance
          description: रिटेंशन क्लास, मेल खाने वाले नियम द्वारा किसी भी प्रमोशन के बाद।
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            जब इवेंट अपनी प्रतिधारण श्रेणी के तहत समाप्त हो जाता है और हटा दिया
            जाता है। `monetary_or_compliance` (भुगतान और विवाद) इवेंट के लिए
            Null।
        idempotent_replay:
          type: boolean
          description: >-
            `true` जब इस `event_id` और समान सामग्री वाला कोई इवेंट पहले से
            संग्रहीत था; मान संग्रहीत इवेंट के हैं और कोई नियम दोबारा नहीं चला।
        rule_matches:
          type: array
          description: वे नियम जो इवेंट से मेल खाते हैं।
          items:
            type: object
            required:
              - rule_id
              - library_key
              - mode
              - is_async
            properties:
              rule_id:
                type: string
                format: uuid
                description: नियम का UUID।
              library_key:
                type: string
                nullable: true
                description: >-
                  जब नियम को नियम लाइब्रेरी से इंस्टॉल किया गया था, तब लाइब्रेरी
                  कुंजी, अन्यथा null।
              mode:
                type: string
                enum:
                  - ACTIVE
                  - TEST
                description: >-
                  `TEST` नियम मिलान रिकॉर्ड करते हैं लेकिन कोई कार्रवाई लागू
                  नहीं करते हैं।
              is_async:
                type: boolean
                description: '`true` जब मिलान एसिंक्रोनस पास से आया हो।'
  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.