> ## 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 获取组织下的全部 KYC 和 KYB 工作流，以编程方式管理验证流程。按量计费，无需签订合同。



列出工作流 API 提示词
        将提示词复制到剪贴板



      
      

\<pre>

\`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.`

\</pre>



      
      

粘贴到



## OpenAPI

````yaml zh/openapi-25.json GET /v3/workflows/
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/workflows/:
    get:
      tags:
        - Workflows
      summary: 列出工作流
      description: >-
        列出您的工作流，最新的排在最前，采用 limit/offset 分页封装格式（`{count, next, previous,
        results}`，默认页面大小为 50）。每一行代表一个版本；`workflow_id` 是稳定组 ID，新会话将使用最新的
        `published` 版本。
      operationId: list_workflows
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
          description: 页面大小（每页工作流数量）。
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
          description: 返回第一个工作流前跳过的行数。
      responses:
        '200':
          description: >-
            按 `created_at` 降序排列的一页工作流，封装在分页结构中。`results` 中的每一项均为
            `WorkflowListItem`。
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: 该应用的工作流版本总数。
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: 下一页的 URL，最后一页为 `null`。
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: 上一页的 URL，第一页为 `null`。
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkflowListItem'
              examples:
                Two workflows:
                  summary: 一个默认的 KYC 工作流和一个草稿状态的 KYC + AML 工作流
                  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: >-
            API 密钥缺失、格式错误、已过期或属于其他应用。响应体：`{"detail": "You do not have permission
            to perform this action."}`。请通过 [Auth
            API](/zh/auth-api/get-credentials) 刷新 token 并重试。
          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: 超出速率限制。请使用指数退避重试，并遵循任何 `Retry-After` 请求头。
        '500':
          description: 构建列表时发生意外服务器错误。该请求可以安全重试。
      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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->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: 列表视图中的一个工作流版本。
      properties:
        uuid:
          type: string
          format: uuid
          description: 每个版本对应的 UUID。在获取/更新/删除时用作 `{settings_uuid}`，创建会话时用作 `workflow_id`。
        workflow_id:
          type: string
          format: uuid
          description: 同一工作流的所有版本共享的稳定分组 ID。版本 1 时等于 `uuid`。
        workflow_label:
          type: string
          description: 工作流的显示名称。
        workflow_type:
          type: string
          nullable: true
          description: >-
            简单工作流的基础类型：`kyc`、`kyb`、`adaptive_age_verification`、`biometric_authentication`
            等。对于不含 KYB 功能的基于图谱的工作流为 `null`。
        is_default:
          type: boolean
          description: 这是否为新会话的默认工作流。
        is_archived:
          type: boolean
        is_white_label_enabled:
          type: boolean
          description: 使用此工作流创建的会话是否应用白标自定义配置。
        total_price:
          type: number
          description: >-
            每次验证的固定价格（美元，JSON 数字，不包含按可变价格计费的功能，例如 DATABASE_VALIDATION 和
            PHONE_VERIFICATION）。
        min_price:
          type: number
          description: 工作流图谱各路径中的最低固定价格，以 USD 计。
        max_price:
          type: number
          description: 工作流图谱各路径中最昂贵的固定价格，以 USD 计。
        features:
          type: string
          description: >-
            以 `" + "` 连接的单个字符串形式表示的已启用功能，例如 `"OCR + LIVENESS + FACE_MATCH"`。按 `"
            + "` 拆分即可获取列表。
        is_simple_workflow:
          type: boolean
          description: 当工作流没有自定义工作流图谱时为 true。
        is_editable:
          type: boolean
          description: 当此版本为 `draft` 时为 True（草稿可直接原地编辑；已发布版本在 Console 中不可更改）。
        workflow_url:
          type: string
          format: uri
          description: 此工作流的可共享公开验证 URL（`https://verify.didit.me/u/<token>`）。
        max_retry_attempts:
          type: integer
          description: 验证被拒绝后允许的最大重试次数（0-10）。
        retry_window_days:
          type: integer
          nullable: true
          description: 用于计算重试次数的滑动时间窗口，以天为单位（1-365）。`null` = 历史累计限制。
        session_expiration_time:
          type: integer
          description: 未完成会话过期前的秒数（3600-2419200）。
        version:
          type: integer
          description: '`workflow_id` 分组内的版本号，从 1 开始。'
        status:
          type: string
          enum:
            - draft
            - published
          description: 版本状态。新会话使用分组最新的 `published` 版本。
        has_draft:
          type: boolean
          description: 当此 `workflow_id` 分组中的任何版本当前为草稿时为 true。
        created_by:
          type: object
          nullable: true
          description: >-
            创建此版本的主体：`{name, email, type}`，其中 `type` 为 `user`（控制台用户，已设置
            `email`）或 `api_key`（`name` 为客户端 ID，`email` 为 null）。未记录创建者时为 `null`。
          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: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。

````

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