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

# Workflow abrufen: Get Workflow API für KYC-Flows

> Didit Workflow abrufen: vollständige Konfiguration eines KYC- oder KYB-Workflows mit Funktionen, Schwellenwerten und Dokumenten. Preis pro Aufruf.



Prompt für die Workflow-API abrufen
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Fetch the full configuration of a single Didit workflow through the Management API.

Endpoint:
GET https://verification.didit.me/v3/workflows/{settings_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Retrieve every editable field on the workflow (feature toggles, score thresholds, documents_allowed per country, KYB role config, retry policy, callback config, etc.).
\- Useful for back-office "view workflow" screens, debugging why a verification declined/routed to review, or verifying a freshly published version.

Path parameter:
\- settings_uuid — the per-version workflow UUID returned by GET /v3/workflows/ or POST /v3/workflows/. Each workflow version has its own settings_uuid; workflow_id is the stable group id shared by every version.

Example call:
curl -X GET "https://verification.didit.me/v3/workflows/{settings_uuid}/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- workflow_id — stable group id; compare across versions to walk version history.
\- features and the underlying workflow_graph — describes which checks run and in what order.
\- Threshold and action fields per feature — see /management-api/workflows/feature-configs for the full reference.

Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the workflow belongs to a different application than the API key.
\- 404 — workflow not found in this application (also returned when settings_uuid is valid in another application).

Side effects: none. This is a pure read.

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

\</pre>



      
      

Einfügen in



## OpenAPI

````yaml de/openapi-25.json GET /v3/workflows/{settings_uuid}/
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/workflows/{settings_uuid}/:
    get:
      tags:
        - Workflows
      summary: Workflow abrufen
      description: >-
        Ruft die vollständige Konfiguration für eine Workflow-Version anhand der
        `settings_uuid` ab: Funktions-Toggles, Schwellenwerte, zulässige
        Dokumente, Graph, Richtlinie für Wiederholungsversuche, Callbacks und
        Preise.
      operationId: get_workflow
      parameters:
        - name: settings_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Versionsspezifische UUID des Workflows (der vom Listen-Endpoint
            zurückgegebene `uuid`-Wert). Jede Version eines Workflows hat ihre
            eigene `settings_uuid`.
      responses:
        '200':
          description: >-
            Vollständige Workflow-Konfiguration. Die Struktur entspricht der
            rohen `VerificationSettings`-Serialisierung (~190 Felder: jeder
            Feature-Toggle, Schwellenwert, jede Warnungsaktion, Konfiguration
            zulässiger Dokumente, der `workflow_graph`, Wiederholungsrichtlinie,
            Callbacks und Preise). Das nachfolgende Beispiel ist gekürzt.
            Hinweise: `features` ist ein mit `" + "` verbundener String (z. B.
            `"OCR + LIVENESS"`), Preise sind JSON-Zahlen und `is_editable` ist
            nur für `draft`-Versionen `true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDetail'
              examples:
                KYC workflow with face match (abbreviated):
                  value:
                    uuid: a1b2c3d4-5678-90ab-cdef-111111111111
                    workflow_id: a1b2c3d4-5678-90ab-cdef-111111111111
                    workflow_label: Standard KYC
                    workflow_type: kyc
                    is_default: true
                    is_archived: false
                    is_liveness_enabled: true
                    face_liveness_method: passive
                    face_liveness_score_decline_threshold: 50
                    face_liveness_score_review_threshold: 70
                    is_face_match_enabled: true
                    face_match_score_decline_threshold: 40
                    face_match_score_review_threshold: 60
                    is_aml_enabled: false
                    is_phone_verification_enabled: false
                    is_email_verification_enabled: false
                    is_database_validation_enabled: false
                    is_ip_analysis_enabled: false
                    is_nfc_enabled: false
                    duplicated_user_action: no_action
                    documents_allowed:
                      ESP:
                        P:
                          sides: 1
                          enabled: 1
                          subtypes:
                            - EPASSPORT
                            - PASSPORT_GENERIC
                          preferred_characters: latin
                          expiration_check_mode: strict
                    max_retry_attempts: 3
                    retry_window_days: 7
                    session_expiration_time: 604800
                    version: 2
                    status: published
                    published_at: '2026-04-12T10:30:00Z'
                    is_simple_workflow: false
                    is_editable: false
                    workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
                    total_price: 0.15
                    min_price: 0.15
                    max_price: 0.15
                    features: OCR + LIVENESS + FACE_MATCH
                    created_at: '2025-01-15T10:30:00Z'
                    updated_at: '2026-04-12T10:30:00Z'
        '403':
          description: >-
            API-Schlüssel fehlt, ist fehlerhaft, abgelaufen oder für eine andere
            Anwendung gültig.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Für die authentifizierte Anwendung existiert kein Workflow mit
            dieser `settings_uuid`. Entweder ist die UUID falsch oder sie gehört
            zu einer anderen Anwendung – Didit unterscheidet die beiden Fälle
            bewusst nicht, um Rückschlüsse auf anwendungsübergreifende
            Datensätze zu vermeiden.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Rate-Limit überschritten. Wiederholen Sie die Anfrage mit
            exponentiellem Backoff.
        '500':
          description: Unerwarteter Serverfehler. Kann sicher wiederholt werden.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/workflows/a1b2c3d4-5678-90ab-cdef-111111111111/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.workflows.retrieve(
                "11111111-2222-3333-4444-555555555555",
            )
            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.workflows.retrieve("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Workflows.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\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.workflows().retrieve("11111111-2222-3333-4444-555555555555");

            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->workflows->retrieve('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.workflows.retrieve("11111111-2222-3333-4444-555555555555")

            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.Workflows.RetrieveAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    WorkflowDetail:
      type: object
      description: >-
        Die folgenden Felder sind typisiert; das Objekt enthält außerdem jede
        andere Spalte der Workflow-Konfiguration (Funktionsschalter,
        Schwellenwerte, Warnungsaktionen, zulässige Dokumente, Callbacks) als
        zusätzliche Eigenschaften. Felder, die für den `workflow_type` nicht
        gelten, sind `null`.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Versionsspezifische Kennung (`settings_uuid`). Jede Version eines
            Workflows hat ihre eigene.
        workflow_id:
          type: string
          format: uuid
          description: >-
            Stabiler Identifikator, der von jeder Version des Workflows geteilt
            wird. Damit erstellte Sitzungen verwenden die neueste
            veröffentlichte Version.
        workflow_label:
          type: string
          description: Anzeigename des Workflows.
        workflow_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - adaptive_age_verification
            - biometric_authentication
            - address_verification
            - questionnaire_verification
            - email_verification
            - phone_verification
            - null
          description: >-
            Workflow-Vorlage. `null` für Graph-Workflows, die ohne Vorlage
            erstellt wurden.
        is_default:
          type: boolean
          description: Gibt an, ob dies der Standard-Workflow der Anwendung ist.
        is_archived:
          type: boolean
          description: Archivierte Workflows können keine neuen Sitzungen starten.
        version:
          type: integer
          description: Versionsnummer innerhalb des Workflows.
        status:
          type: string
          enum:
            - draft
            - published
          description: >-
            Entwurfsversionen können bearbeitet werden; veröffentlichte
            Versionen sind unveränderlich und werden für neue Sitzungen
            verwendet.
        published_at:
          type: string
          format: date-time
          nullable: true
          description: Wann diese Version veröffentlicht wurde. `null` für Entwürfe.
        is_simple_workflow:
          type: boolean
          description: >-
            `true`, wenn der Workflow keinen benutzerdefinierten
            `workflow_graph` hat.
        is_editable:
          type: boolean
          description: '`true` nur für `draft`-Versionen.'
        workflow_url:
          type: string
          format: uri
          description: Öffentliche URL, die eine Sitzung mit diesem Workflow startet.
        workflow_graph:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Graphstruktur des Workflows (Knoten und Kanten). `null` für einfache
            Workflows.
        features:
          type: string
          description: >-
            Aktivierte Funktionen, verbunden mit `" + "`, zum Beispiel `"OCR +
            LIVENESS"`.
        total_price:
          type: number
          nullable: true
          description: Preis pro Sitzung; bei Graph-Workflows der teuerste Pfad.
        min_price:
          type: number
          nullable: true
          description: Preis des günstigsten Pfads durch den Workflow.
        max_price:
          type: number
          nullable: true
          description: Preis des teuersten Pfads durch den Workflow.
        special_add_on_prices:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Organisationsspezifische Zusatzpreise oder `null`, wenn keine
            festgelegt sind.
        max_retry_attempts:
          type: integer
          description: >-
            Zulässige Wiederholungsversuche nach einer abgelehnten
            Verifizierung.
        retry_window_days:
          type: integer
          nullable: true
          description: Tage, während derer Wiederholungsversuche zulässig sind.
        session_expiration_time:
          type: integer
          description: Sekunden, bis eine nicht abgeschlossene Sitzung abläuft.
        questionnaire:
          type: object
          nullable: true
          additionalProperties: true
          description: Der an den Workflow angehängte Fragebogen oder `null`.
        kyb_role_settings:
          type: array
          items:
            type: object
            additionalProperties: true
          description: Verifizierungseinstellungen pro Rolle für KYB-Schlüsselpersonen.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        signature_availability:
          type: object
          description: >-
            Welche E-Signatur-Stufen derzeit signieren können. Prüfen Sie dies,
            bevor Sie `signature_level` festlegen. Wird bei `kyc`-, `kyb`- und
            Graph-Workflows zurückgegeben.
          properties:
            simple:
              type: boolean
              description: Simple ist immer verfügbar.
            aes:
              type: boolean
              description: >-
                Gibt an, ob Advanced (AES) jetzt signieren kann. Solange dies
                `false` ist, wird das Speichern eines neuen Schritts mit
                `signature_level: "aes"` mit `aes_not_available` abgelehnt.
            qes:
              type: boolean
              description: >-
                Gibt an, ob Qualifiziert (QES) jetzt signieren kann. Es ist
                `false`, bis ein qualifizierter Anbieter angebunden ist.
        is_bank_verification_enabled:
          type: boolean
          description: >-
            Gibt an, ob ein einfacher KYC- oder KYB-Workflow die
            Bankverifizierung ausführt. Sie läuft nach den Kontaktschritten (und
            der Standortverifizierung) sowie vor der Datenbankvalidierung, AML
            und IP-Analyse. Die Bankverifizierung ist noch nicht allgemein
            verfügbar: Ihre Aktivierung wird überall abgelehnt, wo sie nicht
            freigeschaltet ist.
        bank_verification_config:
          type: object
          additionalProperties: true
          description: >-
            Bankverifizierungseinstellungen eines einfachen Workflows mit
            denselben Schlüsseln, die ein `BANK_VERIFICATION`-Knoten akzeptiert
            (z. B. `bank_countries` und `bank_method_order`). Unbekannte
            Schlüssel werden verworfen. Jeder Schlüssel ist optional, und ein
            fehlender Schlüssel behält seinen Standardwert bei, sodass `{}` für
            alle Standardwerte steht. Siehe
            [Bankverifizierungseinstellungen](/de/management-api/workflows/feature-configs#bank-verifizierung).
          example: {}
        is_geolocation_enabled:
          type: boolean
          description: >-
            Gibt an, ob ein einfacher KYC-Workflow die Standortverifizierung
            ausführt. Sie läuft nach den Kontaktschritten sowie vor der
            Bankverifizierung und Datenbankvalidierung. Unternehmens-Workflows
            (KYB) können sie nicht ausführen.
        geolocation_config:
          type: object
          additionalProperties: true
          description: >-
            Standortverifizierungs-Einstellungen eines einfachen Workflows mit
            denselben Schlüsseln, die ein `GEOLOCATION`-Knoten akzeptiert (zum
            Beispiel `is_geolocation_geofencing_enabled` und
            `geolocation_max_attempts`). Unbekannte Schlüssel werden verworfen.
            Jeder Schlüssel ist optional und ein fehlender Schlüssel behält
            seinen Standardwert, sodass `{}` alle Standardwerte bedeutet.
          example: {}
      additionalProperties: true
  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.