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

# Benutzer abrufen: Get User API für Didit Vendor-Benutzer

> Ruft einen Didit-Vendor-Benutzer per vendor_data ab: Identitätsfelder, Status, KYC-Zähler, Feature-Map. Abrechnung pro Aufruf.



Prompt: Benutzer abrufen
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Goal: Fetch a single Didit User entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, full_name, date_of_birth, effective_name, portrait_image_url
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map of feature -> latest status)
\- approved_emails, approved_phones, issuing_states
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log: status changes, manual notes, system events)
\- created_at, updated_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as sessions reach terminal status.
\- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing or invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 404 — no user with that vendor_data in this application.
\- 429 — rate-limited.

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

\</pre>



      
      

Einfügen in

## ÜberblickGibt eine einzelne [User-Entität](https://docs.didit.me/de/entities/users/overview.md) zurück, die über `vendor_data` identifiziert wird. Antworten enthalten `didit_internal_id`, die stabile interne Kennung von Didit.## Wann verwenden- **Abfrage** des aktuellen Verifizierungsstatus eines Benutzers: Die `features`-Zuordnung liefert den neuesten Status jeder Funktion in einem einzigen Objekt.
- **Detailansichten** in Ihrer eigenen Benutzeroberfläche: Rufen Sie das Profil bei Bedarf ab, bevor Sie es anzeigen.
- **Risiko-Scoring**: Kombinieren Sie Sitzungszähler und `features`, um jeden Benutzer auf Ihrer Seite zu bewerten.## Hinweise- `vendor_data` in der URL unterscheidet zwischen Groß- und Kleinschreibung.
- Gibt `404` zurück, wenn in der Anwendung kein Benutzer mit diesem `vendor_data` existiert.
- Aggregierte Zähler (`session_count`, `approved_count`, `declined_count`, `in_review_count`) werden in Echtzeit aktualisiert, sobald Sitzungen abgeschlossen sind.
- Alle Felder finden Sie im [Datenmodell für Benutzer](https://docs.didit.me/de/entities/users/data-model.md).## BerechtigungenJeder aktive API-Schlüssel der Anwendung kann diesen Endpoint aufrufen. API-Schlüssel von Didit sind **anwendungsbezogen, nicht rollenbezogen**: Die [Rollen und Berechtigungen](https://docs.didit.me/de/console/roles-permissions.md) der Console (`read:users` und die übrigen) bestimmen, was eine *Person* in der Console tun darf, und werden für Datenverkehr der Management API nicht ausgewertet. Steuern Sie, wer diesen Endpoint aufrufen kann, indem Sie steuern, wer den API-Schlüssel der Anwendung lesen kann.## Verwandte Themen- [Übersicht Benutzer](https://docs.didit.me/de/entities/users/overview.md)
- [Datenmodell](https://docs.didit.me/de/entities/users/data-model.md)
- [Benutzer auflisten](https://docs.didit.me/de/management-api/users/list.md)


## OpenAPI

````yaml de/openapi-25.json GET /v3/users/{vendor_data}/
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/users/{vendor_data}/:
    get:
      tags:
        - Users
      summary: Benutzer abrufen
      description: >-
        Ruft einen [Benutzer](/entities/users) anhand von `vendor_data` (exakte
        Übereinstimmung) ab. Ergänzt die Listenansicht um `metadata`, `comments`
        und `updated_at` und wechselt bei `tags` zur detaillierten
        Tag-Link-Struktur.
      operationId: get_user
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Ihre eindeutige Kennung für den Benutzer — ein Freitext-String
            (KEINE UUID). Dies ist derselbe Wert, den Sie beim Erstellen der
            Sitzung, in der dieser Benutzer erstmals eingeführt wurde, als
            `vendor_data` übergeben haben, exakt wie übermittelt abgeglichen.
          example: user-abc-123
      responses:
        '200':
          description: >-
            Vollständige Benutzerdetails einschließlich Metadaten,
            Kommentaren/Aktivitätsprotokoll und aggregierten Sitzungsdaten.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailItem'
              examples:
                Active user:
                  value:
                    didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
                    vendor_data: user-abc-123
                    display_name: null
                    full_name: John Michael Doe
                    date_of_birth: '1990-05-15'
                    effective_name: John Michael Doe
                    status: ACTIVE
                    metadata:
                      tier: premium
                      source: website
                    portrait_image_url: https://<media-host>/...
                    session_count: 3
                    approved_count: 2
                    declined_count: 0
                    in_review_count: 1
                    issuing_states:
                      - USA
                    approved_emails:
                      - john@example.com
                    approved_phones:
                      - '+14155551234'
                    features:
                      ID_VERIFICATION: Approved
                      LIVENESS: Approved
                      FACE_MATCH: Approved
                      AML: Approved
                    features_list:
                      - feature: ID_VERIFICATION
                        status: Approved
                      - feature: LIVENESS
                        status: Approved
                      - feature: FACE_MATCH
                        status: Approved
                      - feature: AML
                        status: Approved
                    last_session_at: '2025-06-15T10:30:00Z'
                    last_activity_at: '2025-06-15T10:30:00Z'
                    first_session_at: '2025-06-01T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        tag:
                          uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b
                          name: VIP
                          color: '#2567FF'
                          description: null
                          source: custom
                          created_at: '2025-05-01T09:00:00Z'
                          updated_at: '2025-05-01T09:00:00Z'
                        added_by_email: analyst@acme.com
                        added_by_name: Jane Analyst
                        created_at: '2025-06-02T11:00:00Z'
                    comments:
                      - uuid: c1111111-2222-4333-8444-555555555555
                        comment_type: STATUS_CHANGED
                        comment: null
                        actor_email: analyst@acme.com
                        actor_name: Jane Analyst
                        previous_status: FLAGGED
                        new_status: ACTIVE
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        mentioned_emails: []
                        created_at: '2025-06-01T10:30:00Z'
                    created_at: '2025-06-01T08:00:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
        '401':
          description: >-
            Keine Anmeldedaten angegeben. Anfragen an `/v3/users/*`-Pfade ohne
            einen `x-api-key`-Header (oder `Authorization: Bearer`-Token) werden
            von der Authentifizierungs-Middleware abgelehnt, bevor sie die API
            erreichen.
          content:
            application/json:
              examples:
                Missing credentials:
                  value:
                    detail: >-
                      You must be authenticated with a valid access token to
                      access this endpoint.
        '403':
          description: >-
            Ungültiger oder widerrufener API-Schlüssel, oder der Schlüssel kann
            die Benutzer dieser Anwendung nicht lesen. Ein fehlender Schlüssel
            gibt `403` zurück; ein falscher, widerrufener oder abgelaufener
            Schlüssel gibt `401` zurück.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Für diese Anwendung existiert kein Benutzer mit den angegebenen
            `vendor_data`.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Rate-Limit überschritten; drosseln Sie die Anfragen und wiederholen
            Sie den Versuch nach dem in `Retry-After` angegebenen Intervall.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: Request was throttled. Expected available in 30 seconds.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.users.retrieve(
                "user-abc-123",
            )
            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.users.retrieve("user-abc-123");
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

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

            var result = client.users().retrieve("user-abc-123");
            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->users->retrieve('user-abc-123');
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.users.retrieve("user-abc-123")
            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.Users.RetrieveAsync("user-abc-123");
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    UserDetailItem:
      type: object
      description: >-
        Vollständige Benutzerdetails. Erweitert UserListItem um Metadaten,
        Kommentare und updated_at.
      allOf:
        - $ref: '#/components/schemas/UserListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                Benutzerdefiniertes Metadaten-JSON, das Sie diesem Benutzer
                angehängt haben. Standardmäßig `{}`.
            tags:
              type: array
              description: >-
                Tag-Zuweisungen. HINWEIS: Bei Detailantworten ist jeder Eintrag
                ein Tag-*Link*-Objekt (`{uuid, tag: {...}, added_by_email,
                added_by_name, created_at}`), anders als die flache Struktur
                `{uuid, name, color}`, die bei Listenantworten verwendet wird.
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: UUID der Tag-Zuweisung (nicht des Tags selbst).
                  tag:
                    type: object
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      name:
                        type: string
                      color:
                        type: string
                      description:
                        type: string
                        nullable: true
                      source:
                        type: string
                        enum:
                          - didit
                          - custom
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  added_by_email:
                    type: string
                    nullable: true
                  added_by_name:
                    type: string
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
            comments:
              type: array
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                  comment_type:
                    type: string
                    enum:
                      - COMMENT
                      - STATUS_CHANGED
                      - METADATA_UPDATED
                      - TAG_ADDED
                      - TAG_REMOVED
                      - PROFILE_UPDATED
                  comment:
                    type: string
                    nullable: true
                  actor_email:
                    type: string
                    nullable: true
                  actor_name:
                    type: string
                    nullable: true
                  previous_status:
                    type: string
                    nullable: true
                    enum:
                      - ACTIVE
                      - FLAGGED
                      - BLOCKED
                      - null
                  new_status:
                    type: string
                    nullable: true
                    enum:
                      - ACTIVE
                      - FLAGGED
                      - BLOCKED
                      - null
                  previous_value:
                    type: object
                    nullable: true
                    description: Vorherige Feldwerte für PROFILE_UPDATED-Einträge.
                  new_value:
                    type: object
                    nullable: true
                    description: Neue Feldwerte für PROFILE_UPDATED-Einträge.
                  changed_fields:
                    type: array
                    items:
                      type: string
                    description: >-
                      Namen der Felder, die durch einen PROFILE_UPDATED-Eintrag
                      geändert wurden.
                  metadata:
                    type: object
                    nullable: true
                  mentioned_emails:
                    type: array
                    items:
                      type: string
                  created_at:
                    type: string
                    format: date-time
              description: >-
                Aktivitätsprotokoll und Kommentare für diesen Benutzer
                (Statusänderungen, Profilbearbeitungen, manuelle Notizen).
            updated_at:
              type: string
              format: date-time
    UserListItem:
      type: object
      description: Ein verifizierter Benutzer.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: Didits stabile interne UUID für diesen Benutzer.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Ihre eindeutige Kennung für diesen Benutzer (beim Erstellen von
            Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung
            angegeben wurde.
        display_name:
          type: string
          nullable: true
          description: Von Ihnen festgelegter benutzerdefinierter Anzeigename
        full_name:
          type: string
          nullable: true
          description: Aus verifizierten Dokumenten extrahierter vollständiger Name
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: >-
            Bester verfügbarer Name: display_name, falls gesetzt, andernfalls
            full_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Lebenszyklusstatus des Benutzerdatensatzes (KEIN Sitzungsstatus).
            `ACTIVE` ist der Standard, `FLAGGED` markiert den Benutzer für
            manuelle Prüfung, `BLOCKED` verhindert neue Sitzungen für dieses
            `vendor_data`.
        portrait_image_url:
          type: string
          nullable: true
          description: >-
            Vorsignierte URL des Porträtfotos des Benutzers (läuft nach wenigen
            Stunden ab)
        session_count:
          type: integer
          description: Gesamtzahl der Verifizierungssitzungen für diesen Benutzer
        approved_count:
          type: integer
          description: Anzahl der genehmigten Sitzungen
        declined_count:
          type: integer
          description: Anzahl der abgelehnten Sitzungen
        in_review_count:
          type: integer
          description: Anzahl der Sitzungen in Prüfung
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            ISO 3166-1-Alpha-3-Codes der Ausstellungsländer, die auf den
            genehmigten Ausweisdokumenten dieses Benutzers gefunden wurden, z.
            B. `["USA", "ESP"]`. Leeres Array, wenn keine vorhanden sind.
        approved_emails:
          type: array
          items:
            type: string
          description: >-
            Verifizierte E-Mail-Adressen, die aus den genehmigten Sitzungen
            dieses Benutzers erfasst wurden, z. B. `["john@example.com"]`.
        approved_phones:
          type: array
          items:
            type: string
          description: >-
            Verifizierte Telefonnummern, die aus den genehmigten Sitzungen
            dieses Benutzers erfasst wurden, z. B. `["+14155551234"]`.
        features:
          type: object
          description: >-
            Aggregierter Status pro Funktion über alle Sitzungen dieses
            Benutzers hinweg. Mögliche Schlüssel: `ID_VERIFICATION`, `NFC`,
            `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`,
            `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`,
            `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Mögliche Werte: `Approved`,
            `Declined`, `In Review`, `Not Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Dieselben Daten wie `features`, als geordnetes Array von `{feature,
            status}`-Objekten.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Zeitstempel der letzten Sitzung
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Zeitstempel der ersten Sitzung
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Zeitstempel der letzten Aktivität bei diesem Benutzer (Sitzung,
            Transaktion, Statusänderung, Datenbearbeitung usw.).
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Diesem Benutzer zugewiesene Tags
        created_at:
          type: string
          format: date-time
  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.