> ## 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.
# Workflows per API auflisten: Verifizierungs-Workflows
> Alle KYC- und KYB-Workflows Ihrer Didit-Organisation per API abrufen und programmatisch verwalten. Abrechnung nach Nutzung.
Prompt für die API zum Auflisten von Workflows
Prompt in die Zwischenablage kopieren
\
\`List every Didit workflow in my application through the Management API.
Endpoint:
GET https://verification.didit.me/v3/workflows/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Retrieve every workflow (verification settings record) defined for the application bound to my API key.
\- Use the results to render a workflow picker, sync workflow ids into my config, or discover the workflow_id of a workflow created in the Console.
Behavior:
\- Results are returned newest first (ordered by -created_at).
\- The endpoint does not paginate today — every workflow record comes back in one response.
\- Each row is a single version of a workflow group. workflow_id is the stable identifier shared by every version, version is the integer version number, and status is "draft" or "published".
\- The workflow with is_default: true is used whenever a session is created without an explicit workflow_id.
\- is_editable: true means the row is a draft and can still be patched via PATCH /v3/workflows/{settings_uuid}/.
\- Filter client-side by is_archived and status if you maintain hundreds of workflows.
Example call:
curl -X GET "https://verification.didit.me/v3/workflows/" \
-H "x-api-key: YOUR_API_KEY"
What to do with the response:
\- Use settings_uuid as the path id for GET / PATCH / DELETE /v3/workflows/{settings_uuid}/.
\- Use workflow_id when creating a session via POST /v3/session/.
Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the API key cannot list workflows for this application.
\- 429 — rate limited; back off and retry using Retry-After.
Side effects: none. This is a pure read.
For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`
\
Einfügen in
## OpenAPI
````yaml de/openapi-25.json GET /v3/workflows/
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/:
get:
tags:
- Workflows
summary: Workflows auflisten
description: >-
Ihre Workflows auflisten, die neuesten zuerst, in einem
Paginierungs-Umschlag mit Limit/Offset (`{count, next, previous,
results}`, Standard-Seitengröße 50). Jede Zeile stellt eine Version dar;
`workflow_id` ist die stabile Gruppen-ID, und neue Sitzungen verwenden
die neueste `published`-Version.
operationId: list_workflows
parameters:
- name: limit
in: query
required: false
schema:
type: integer
default: 50
description: Seitengröße (Anzahl der Workflows pro Seite).
- name: offset
in: query
required: false
schema:
type: integer
default: 0
description: >-
Anzahl der vor dem ersten zurückgegebenen Workflow zu
überspringenden Zeilen.
responses:
'200':
description: >-
Eine Seite mit Workflows, absteigend nach `created_at` sortiert,
eingebettet in das Paginierungsobjekt. Jedes Element in `results`
ist ein `WorkflowListItem`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: Gesamtzahl der Workflow-Versionen für die Anwendung.
next:
type: string
format: uri
nullable: true
description: URL der nächsten Seite oder `null` auf der letzten Seite.
previous:
type: string
format: uri
nullable: true
description: URL der vorherigen Seite oder `null` auf der ersten Seite.
results:
type: array
items:
$ref: '#/components/schemas/WorkflowListItem'
examples:
Two workflows:
summary: >-
Ein Standard-KYC-Workflow und ein Entwurf für einen KYC +
AML-Workflow
value:
count: 2
next: null
previous: null
results:
- 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_white_label_enabled: false
total_price: 0.15
min_price: 0.15
max_price: 0.15
features: OCR + LIVENESS + FACE_MATCH
is_simple_workflow: true
is_editable: false
workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 2
status: published
has_draft: false
created_by:
name: Alex Mateo
email: alex@example.com
type: user
updated_at: '2026-04-12T10:30:00Z'
- uuid: b2c3d4e5-6789-01bc-defa-222222222222
workflow_id: b2c3d4e5-6789-01bc-defa-222222222222
workflow_label: Full Verification + AML
workflow_type: kyc
is_default: false
is_archived: false
is_white_label_enabled: false
total_price: 0.25
min_price: 0.25
max_price: 0.25
features: OCR + LIVENESS + FACE_MATCH + AML
is_simple_workflow: true
is_editable: true
workflow_url: https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ
max_retry_attempts: 3
retry_window_days: 7
session_expiration_time: 604800
version: 1
status: draft
has_draft: true
created_by: null
updated_at: '2026-04-15T18:05:21Z'
'403':
description: >-
Der API-Schlüssel fehlt, ist fehlerhaft formatiert, abgelaufen oder
gehört zu einer anderen Anwendung. Body: `{"detail": "You do not
have permission to perform this action."}`. Erneuern Sie das Token
über die [Auth API](/de/auth-api/get-credentials) und versuchen Sie
es erneut.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
examples:
Invalid token:
value:
detail: You do not have permission to perform this action.
'429':
description: >-
Rate-Limit überschritten. Wiederholen Sie die Anfrage mit
exponentiellem Backoff und beachten Sie etwaige
`Retry-After`-Header.
'500':
description: >-
Unerwarteter Serverfehler beim Erstellen der Liste. Die Anfrage kann
sicher wiederholt werden.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl -X GET 'https://verification.didit.me/v3/workflows/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Accept: application/json'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.workflows.list():
print(item)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.workflows.list()) {
console.log(item);
}
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Workflows.ListAutoPaging(ctx, didit.WorkflowsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
- lang: java
label: Java
source: |-
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.workflows().list()) {
System.out.println(item);
}
- lang: php
label: PHP
source: |-
workflows->list() as $item) {
print_r($item->toArray());
}
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.workflows.list.auto_paging_each do |item|
puts item.to_h
end
- lang: csharp
label: .NET
source: |-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Workflows.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}
components:
schemas:
WorkflowListItem:
type: object
description: Eine Workflow-Version in der Listenansicht.
properties:
uuid:
type: string
format: uuid
description: >-
Versionsspezifische UUID. Verwenden Sie sie als `{settings_uuid}`
zum Abrufen, Aktualisieren und Löschen und als `workflow_id` beim
Erstellen von Sitzungen.
workflow_id:
type: string
format: uuid
description: >-
Stabile Gruppen-ID, die von jeder Version desselben Workflows
geteilt wird. Entspricht `uuid` für Version 1.
workflow_label:
type: string
description: Anzeigename für den Workflow.
workflow_type:
type: string
nullable: true
description: >-
Basistyp für einfache Workflows: `kyc`, `kyb`,
`adaptive_age_verification`, `biometric_authentication` usw. `null`
für graphbasierte Workflows ohne KYB-Funktion.
is_default:
type: boolean
description: Gibt an, ob dies der Standard-Workflow für neue Sitzungen ist.
is_archived:
type: boolean
is_white_label_enabled:
type: boolean
description: >-
Gibt an, ob White-Label-Anpassungen für Sitzungen gelten, die mit
diesem Workflow erstellt wurden.
total_price:
type: number
description: >-
Festpreis pro Verifizierung in USD (JSON-Zahl, schließt Funktionen
mit variablen Preisen wie DATABASE_VALIDATION und PHONE_VERIFICATION
aus).
min_price:
type: number
description: Günstigster Festpreis über alle Workflow-Graph-Pfade hinweg in USD.
max_price:
type: number
description: Höchster Festpreis über alle Pfade des Workflow-Graphen in USD.
features:
type: string
description: >-
Aktivierte Funktionen als einzelner, mit `" + "` verbundener String,
z. B. `"OCR + LIVENESS + FACE_MATCH"`. Teilen Sie ihn anhand von `"
+ "` auf, um eine Liste zu erhalten.
is_simple_workflow:
type: boolean
description: >-
True, wenn der Workflow keinen benutzerdefinierten Workflow-Graphen
hat.
is_editable:
type: boolean
description: >-
Wahr, wenn diese Version ein `draft` ist (Entwürfe können direkt
bearbeitet werden; veröffentlichte Versionen sind in der Console
unveränderlich).
workflow_url:
type: string
format: uri
description: >-
Öffentliche teilbare Verifizierungs-URL für diesen Workflow
(`https://verify.didit.me/u/`).
max_retry_attempts:
type: integer
description: >-
Maximale Anzahl an Wiederholungsversuchen, die nach einer
abgelehnten Verifizierung zulässig sind (0-10).
retry_window_days:
type: integer
nullable: true
description: >-
Gleitendes Zeitfenster in Tagen zur Zählung der
Wiederholungsversuche (1-365). `null` = Limit für den gesamten
Zeitraum.
session_expiration_time:
type: integer
description: >-
Sekunden, bis eine nicht abgeschlossene Sitzung abläuft
(3600-2419200).
version:
type: integer
description: Versionsnummer innerhalb der `workflow_id`-Gruppe, beginnend bei 1.
status:
type: string
enum:
- draft
- published
description: >-
Versionsstatus. Neue Sitzungen verwenden die neueste
`published`-Version einer Gruppe.
has_draft:
type: boolean
description: >-
True, wenn eine beliebige Version in dieser `workflow_id`-Gruppe
derzeit ein Entwurf ist.
created_by:
type: object
nullable: true
description: >-
Wer diese Version erstellt hat: `{name, email, type}`, wobei `type`
entweder `user` (Konsolenbenutzer, `email` gesetzt) oder `api_key`
(`name` ist die Client-ID, `email` ist null) ist. `null`, wenn kein
Ersteller erfasst wurde.
properties:
name:
type: string
email:
type: string
nullable: true
type:
type: string
enum:
- user
- api_key
updated_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.