> ## 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です。認証フローをプログラムで管理できます。従量課金制で契約は不要です。



ワークフロー一覧取得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 ja/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）で一覧表示します。各行は1つのバージョンです。`workflow_id`は安定したグループIDで、新しいセッションでは最新の`published`バージョンが使用されます。
      operationId: list_workflows
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
          description: ページサイズ（1ページあたりのワークフロー数）。
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
          description: 最初に返すワークフローの前にスキップする行数です。
      responses:
        '200':
          description: >-
            `created_at`の降順に並んだワークフローの1ページ分で、ページネーションエンベロープでラップされています。`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](/ja/auth-api/get-credentials)でトークンを更新し、再試行してください。
          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: 一覧表示におけるワークフローバージョン1件です。
      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: >-
            認証1件あたりのUSD建て固定料金（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`（Consoleユーザー、`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のDevelopers -> API
        keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

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