> ## 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.

# Monitoring-SDK-Token erstellen: Didit Management API

> Erstelle mit Didit ein kurzlebiges Gerätetoken für ein Subjekt, damit deine App Monitoring-Events ohne API-Schlüssel senden kann.



API-Prompt zum Erstellen eines Monitoring-SDK-Tokens
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Mint a short-lived device credential so my web or mobile app can send monitoring events for one user straight to Didit.

Endpoint:
POST https://verification.didit.me/v3/events/sdk-token/

Authentication:
Use the x-api-key header with my Didit API key. This call runs on MY BACKEND only - the API key must never ship in an app. Only the returned monitoring_token travels to the device. A scoped key needs transactions: write.

Goal:
\- Get a monitoring_token for the signed-in user. The app sends it in the X-Monitoring-Token header to the device lane (POST /v1/events/ and POST /v1/events/batch/).

Request body (application/json):
\{
"vendor_data": "user-42",                                  // required - the subject every event belongs to
"entity_type": "individual",                               // optional - company binds a company; any other value an individual (default)
"allowed_event_categories": ["auth", "session", "gameplay"], // optional - omit or [] for every category
"ttl_seconds": 900,                                        // optional - 60 to 86400, default 900
"max_uses": 1000,                                          // optional - events it may submit, default 1000, null for no cap
"bind_to_origin": "https://app.example.com"                // optional - browser Origin must match exactly
}
camelCase aliases (vendorData, entityType, allowedEventCategories, ttlSeconds, maxUses, bindToOrigin) are also accepted.

Behavior:
\- The subject is bound server-side: whatever subject the app sends is overwritten with vendor_data.
\- One use per submitted event, also inside a batch: a 500-event flush spends 500 uses, and events the device lane rejects spend uses too.
\- An event outside allowed_event_categories is rejected by the device lane with 400.
\- With bind_to_origin set, a device request with a different Origin, or none, is refused.
\- Minting does not create a user.
\- Event ingestion must be switched on for the application, otherwise this call returns 403 with code event_monitoring_disabled.

Example call:
curl -X POST "https://verification.didit.me/v3/events/sdk-token/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"vendor_data":"user-42","allowed_event_categories":["auth","session","gameplay"],"ttl_seconds":900,"max_uses":1000}'

What to read from the response:
\- monitoring_token - hand it to the app; treat it as a secret for its lifetime.
\- expires_at - mint a fresh credential per user session before it expires.
\- allowed_event_categories ([] means every category), max_uses (null means no cap), bind_to_origin.

Failure modes:
\- 400 - missing vendor_data, ttl_seconds outside 60-86400, max_uses below 1, or an unknown category.
\- 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.

Side effects: creates one credential. Nothing else changes.

For the full client-side submission guide, see /transaction-monitoring/sdk-event-submission.`

\</pre>



      
      

Einfügen in

Das Token wird vom Gerätepfad verwendet, der in [SDK-Ereignisübermittlung](https://docs.didit.me/de/transaction-monitoring/sdk-event-submission.md) beschrieben ist. Dort finden Sie außerdem, welche Anforderungen der Server bei jeder Geräteanfrage durchsetzt und welche Ereignisse bei Rückstau sicher verworfen werden können.


## OpenAPI

````yaml de/openapi-25.json POST /v3/events/sdk-token/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/events/sdk-token/:
    post:
      tags:
        - Monitoring Events
      summary: Monitoring-SDK-Token erstellen
      description: >-
        Erstellen Sie ein kurzlebiges, an ein bestimmtes Subjekt gebundenes
        Geräte-Credential, damit Ihre Web- oder mobile App die Ereignisse dieses
        Benutzers ohne API-Schlüssel direkt an Didit senden kann. Die App sendet
        das zurückgegebene `monitoring_token` im Header `X-Monitoring-Token` an
        die Geräte-Lane (`POST /v1/events/` und `POST /v1/events/batch/`), wo
        das Subjekt stets mit diesem `vendor_data` überschrieben wird,
        Ereignisse außerhalb von `allowed_event_categories` abgelehnt werden,
        jedes übermittelte Ereignis eine Nutzung verbraucht und eine Anfrage
        verweigert wird, deren `Origin` nicht mit `bind_to_origin`
        übereinstimmt. Rufen Sie diesen Endpoint ausschließlich über Ihr Backend
        auf; das Erstellen erzeugt lediglich das Credential und sonst nichts (es
        wird kein Benutzer angelegt). Die Ereigniserfassung muss für die
        Anwendung aktiviert sein, andernfalls gibt dieser Endpoint `403` mit
        `code: event_monitoring_disabled` zurück, anstatt ein Credential zu
        erstellen, das niemals Schreibvorgänge ausführen könnte. Ein
        API-Schlüssel mit Gültigkeitsbereich benötigt `transactions: write`.
        Siehe
        [SDK-Ereignisübermittlung](https://docs.didit.me/de/transaction-monitoring/sdk-event-submission).
      operationId: create_monitoring_event_sdk_token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                camelCase-Aliase werden akzeptiert: `vendorData`, `entityType`,
                `allowedEventCategories`, `ttlSeconds`, `maxUses`,
                `bindToOrigin`.
              required:
                - vendor_data
              properties:
                vendor_data:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    Ihre ID für das Subjekt, zu dem jedes mit diesem
                    Berechtigungsnachweis übermittelte Ereignis gehört.
                entity_type:
                  type: string
                  maxLength: 32
                  default: individual
                  description: >-
                    `company` bindet ein Unternehmenssubjekt; jeder andere Wert
                    (Standard `individual`) bindet eine Einzelperson.
                allowed_event_categories:
                  type: array
                  items:
                    type: string
                    enum:
                      - auth
                      - session
                      - gameplay
                      - bonus
                      - affiliate
                      - payment
                      - dispute
                      - security
                      - responsible_gambling
                      - custom
                  description: >-
                    Kategorien, die der Berechtigungsnachweis übermitteln darf.
                    Weglassen oder `[]` senden, um jede Kategorie zuzulassen.
                ttl_seconds:
                  type: integer
                  minimum: 60
                  maximum: 86400
                  default: 900
                  description: Gültigkeitsdauer der Anmeldedaten in Sekunden.
                max_uses:
                  type: integer
                  minimum: 1
                  nullable: true
                  default: 1000
                  description: >-
                    Anzahl der Ereignisse, die die Anmeldedaten übermitteln
                    dürfen (ein Batch verbraucht eine Nutzung pro Ereignis).
                    Senden Sie `null` für keine Obergrenze innerhalb der
                    Gültigkeitsdauer.
                bind_to_origin:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: >-
                    Wenn festgelegt, muss der Browser-`Origin`-Header jeder
                    Geräteanfrage genau diesem Wert entsprechen; eine Anfrage
                    ohne `Origin` wird abgewiesen.
            example:
              vendor_data: user-42
              allowed_event_categories:
                - auth
                - session
                - gameplay
              ttl_seconds: 900
              max_uses: 1000
              bind_to_origin: https://app.example.com
      responses:
        '201':
          description: >-
            Der Berechtigungsnachweis wurde ausgestellt. Übergeben Sie
            `monitoring_token` an die App und behandeln Sie ihn bis `expires_at`
            als Geheimnis.
          content:
            application/json:
              schema:
                type: object
                required:
                  - monitoring_token
                  - expires_at
                  - allowed_event_categories
                  - max_uses
                  - bind_to_origin
                properties:
                  monitoring_token:
                    type: string
                    description: >-
                      Das Geräte-Credential (ein 43 Zeichen langes, URL-sicheres
                      Token). Senden Sie es im `X-Monitoring-Token`-Header.
                  expires_at:
                    type: string
                    format: date-time
                    description: Wann die Zugangsdaten nicht mehr akzeptiert werden.
                  allowed_event_categories:
                    type: array
                    items:
                      type: string
                      enum:
                        - auth
                        - session
                        - gameplay
                        - bonus
                        - affiliate
                        - payment
                        - dispute
                        - security
                        - responsible_gambling
                        - custom
                    description: >-
                      Kategorien, die der Berechtigungsnachweis übermitteln
                      darf; `[]` bedeutet jede Kategorie.
                  max_uses:
                    type: integer
                    nullable: true
                    description: >-
                      Ereignisbudget der Anmeldedaten; null bedeutet keine
                      Begrenzung.
                  bind_to_origin:
                    type: string
                    nullable: true
                    description: Origin, an den das Credential gebunden ist, oder null.
              example:
                monitoring_token: q7ZtR2xKp9VbN4mWc8LdH1sYfJ3gT6uEaQ0oPiXzBkC
                expires_at: '2026-10-17T09:30:02.481000Z'
                allowed_event_categories:
                  - auth
                  - session
                  - gameplay
                max_uses: 1000
                bind_to_origin: https://app.example.com
        '400':
          description: >-
            Validierung fehlgeschlagen: fehlende `vendor_data`, `ttl_seconds`
            außerhalb von 60 bis 86400, `max_uses` unter 1 oder eine unbekannte
            Kategorie (gekennzeichnet durch ihre Position im Array).
          content:
            application/json:
              examples:
                Missing vendor_data:
                  value:
                    vendor_data:
                      - This field is required.
                ttl_seconds too short:
                  value:
                    ttl_seconds:
                      - Ensure this value is greater than or equal to 60.
                Unknown category:
                  value:
                    allowed_event_categories:
                      '1':
                        - '"login" is not a valid choice.'
        '401':
          description: >-
            Der API-Schlüssel mit eingeschränktem Geltungsbereich ist
            abgelaufen. Nur ein abgelaufener Schlüssel erhält `401`; ein
            fehlender oder ungültiger Schlüssel erhält `403`.
          content:
            application/json:
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Ein fehlender `x-api-key` (ein falscher, widerrufener oder
            abgelaufener Schlüssel erhält `401`), ein berechtigungsbeschränkter
            Schlüssel ohne `transactions: write`, ein auf bestimmte Workflows
            oder genehmigte Sitzungen beschränkter Schlüssel (ein solcher
            Schlüssel erreicht Transaktionsüberwachungsdaten nie) oder eine
            Anfrage von außerhalb der IP-Allowlist des Schlüssels. Wird auch mit
            `code: event_monitoring_disabled` zurückgegeben, solange die
            Ereigniserfassung für die Anwendung deaktiviert ist; in diesem Fall
            wird nichts gespeichert, und die Prüfung erfolgt vor der Validierung
            des Bodys.
          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.
        '429':
          description: >-
            Rate-Limit überschritten: Schreibanfragen (`POST`, `PATCH`,
            `DELETE`) teilen sich ein Kontingent von 300 Anfragen pro Minute pro
            API-Schlüssel. Warten Sie `Retry-After` Sekunden und versuchen Sie
            es dann erneut.
          headers:
            Retry-After:
              description: >-
                Sekunden, die vor einem Wiederholungsversuch gewartet werden
                müssen.
              schema:
                type: integer
                minimum: 1
                example: 30
          content:
            application/json:
              examples:
                Throttled:
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST 'https://verification.didit.me/v3/events/sdk-token/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "vendor_data": "user-42",
                "allowed_event_categories": ["auth", "session", "gameplay"],
                "ttl_seconds": 900,
                "max_uses": 1000,
                "bind_to_origin": "https://app.example.com"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.monitoring_events.create_sdk_token(
                vendor_data="user-42",
                allowed_event_categories=["auth", "session", "gameplay"],
                ttl_seconds=900,
                max_uses=1000,
                bind_to_origin="https://app.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.monitoringEvents.createSdkToken({
              vendor_data: "user-42",
              allowed_event_categories: ["auth", "session", "gameplay"],
              ttl_seconds: 900,
              max_uses: 1000,
              bind_to_origin: "https://app.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.MonitoringEvents.CreateSDKToken(ctx, didit.MonitoringEventsCreateSDKTokenParams{\n\tVendorData:             \"user-42\",\n\tAllowedEventCategories: didit.Some([]didit.MonitoringEventsCreateSDKTokenParamsAllowedEventCategories{\"auth\", \"session\", \"gameplay\"}),\n\tTTLSeconds:             didit.Int(900),\n\tMaxUses:                didit.Int(1000),\n\tBindToOrigin:           didit.String(\"https://app.example.com\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.MonitoringEventsCreateSdkTokenParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.monitoringEvents().createSdkToken(MonitoringEventsCreateSdkTokenParams.builder()
                    .vendorData("user-42")
                    .allowedEventCategories(List.of(MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("auth"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("session"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("gameplay")))
                    .ttlSeconds(900L)
                    .maxUses(1000L)
                    .bindToOrigin("https://app.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->monitoringEvents->createSdkToken([
                'vendor_data' => 'user-42',
                'allowed_event_categories' => ['auth', 'session', 'gameplay'],
                'ttl_seconds' => 900,
                'max_uses' => 1000,
                'bind_to_origin' => 'https://app.example.com',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.monitoring_events.create_sdk_token(
              vendor_data: "user-42",
              allowed_event_categories: ["auth", "session", "gameplay"],
              ttl_seconds: 900,
              max_uses: 1000,
              bind_to_origin: "https://app.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.MonitoringEvents.CreateSdkTokenAsync(new
            MonitoringEventsCreateSdkTokenParams

            {
                VendorData = "user-42",
                AllowedEventCategories = new MonitoringEventsCreateSdkTokenParamsAllowedEventCategories[] { "auth", "session", "gameplay" },
                TtlSeconds = 900,
                MaxUses = 1000,
                BindToOrigin = "https://app.example.com",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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