> ## 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：KYCフローの設定を取得

> DiditのKYC・KYBワークフローの全設定を取得します。機能のオン・オフ、しきい値、受け付ける書類を確認できます。従量課金制です。



ワークフロー取得APIプロンプト
        プロンプトをクリップボードにコピー



      
      

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



      
      

貼り付け先



## OpenAPI

````yaml ja/openapi-25.json GET /v3/workflows/{settings_uuid}/
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/{settings_uuid}/:
    get:
      tags:
        - Workflows
      summary: ワークフローを取得
      description: >-
        `settings_uuid`で指定した1つのワークフローバージョンの完全な設定を取得します。機能の切り替え、しきい値、許可される書類、グラフ、再試行ポリシー、コールバック、料金が含まれます。
      operationId: get_workflow
      parameters:
        - name: settings_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            ワークフローのバージョンごとのUUIDです（一覧エンドポイントが返す`uuid`の値）。ワークフローの各バージョンには、それぞれ固有の`settings_uuid`があります。
      responses:
        '200':
          description: >-
            ワークフローの完全な設定。形式は`VerificationSettings`をそのままシリアライズしたもの（約190フィールド：すべての機能のオン/オフ、しきい値、警告アクション、許可書類の設定、`workflow_graph`、再試行ポリシー、コールバック、料金）です。以下の例は省略版です。注意点：`features`は`"
            + "`で連結された文字列（例：`"OCR +
            LIVENESS"`）であり、料金はJSONの数値で、`is_editable`は`draft`バージョンの場合にのみ`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キーがない、形式が不正、期限切れ、または別のアプリケーションにスコープされています。
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            この`settings_uuid`のワークフローが、認証されたアプリケーションに存在しません。UUIDが誤っているか、別のアプリケーションに属しています。Diditは、アプリケーションをまたいだレコードの存在が漏洩しないよう、意図的にこの2つのケースを区別していません。
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: レート制限を超過しました。指数バックオフで再試行してください。
        '500':
          description: 予期しないサーバーエラーです。安全に再試行できます。
      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: >-
        以下のフィールドには型が定義されています。このオブジェクトには、ワークフロー設定のその他すべての列（機能の切り替え、しきい値、警告アクション、許可される書類、コールバック）も追加プロパティとして含まれます。`workflow_type`に該当しないフィールドは`null`です。
      properties:
        uuid:
          type: string
          format: uuid
          description: バージョンごとの識別子（`settings_uuid`）です。ワークフローの各バージョンがそれぞれ固有の値を持ちます。
        workflow_id:
          type: string
          format: uuid
          description: ワークフローのすべてのバージョンで共有される不変の識別子。これを使って作成したセッションでは、公開済みの最新バージョンが使用されます。
        workflow_label:
          type: string
          description: ワークフローの表示名。
        workflow_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - adaptive_age_verification
            - biometric_authentication
            - address_verification
            - questionnaire_verification
            - email_verification
            - phone_verification
            - null
          description: ワークフローテンプレート。テンプレートなしで作成されたグラフワークフローでは`null`です。
        is_default:
          type: boolean
          description: アプリケーションのデフォルトのワークフローかどうか。
        is_archived:
          type: boolean
          description: アーカイブ済みのワークフローでは新しいセッションを開始できません。
        version:
          type: integer
          description: ワークフロー内のバージョン番号。
        status:
          type: string
          enum:
            - draft
            - published
          description: ドラフトバージョンは編集できます。公開済みバージョンは変更できず、新しいセッションで使用されます。
        published_at:
          type: string
          format: date-time
          nullable: true
          description: このバージョンが公開された日時。下書きの場合は`null`です。
        is_simple_workflow:
          type: boolean
          description: ワークフローにカスタムの`workflow_graph`がない場合は`true`です。
        is_editable:
          type: boolean
          description: '`draft`バージョンの場合のみ`true`です。'
        workflow_url:
          type: string
          format: uri
          description: このワークフローでセッションを開始する公開URLです。
        workflow_graph:
          type: object
          nullable: true
          additionalProperties: true
          description: ワークフローのグラフ構造(ノードとエッジ)。シンプルなワークフローでは`null`です。
        features:
          type: string
          description: '有効な機能を`" + "`で連結したものです。例: `"OCR + LIVENESS"`。'
        total_price:
          type: number
          nullable: true
          description: セッション1件あたりの料金。グラフ型ワークフローでは最も高い経路の料金です。
        min_price:
          type: number
          nullable: true
          description: ワークフロー内で最も安い経路の料金。
        max_price:
          type: number
          nullable: true
          description: ワークフロー内で最も高い経路の料金。
        special_add_on_prices:
          type: object
          nullable: true
          additionalProperties: true
          description: 組織固有のアドオン料金です。設定されていない場合は`null`です。
        max_retry_attempts:
          type: integer
          description: 認証が却下された後に許可される再試行回数。
        retry_window_days:
          type: integer
          nullable: true
          description: 再試行が許可される日数。
        session_expiration_time:
          type: integer
          description: 未完了のセッションが期限切れになるまでの秒数。
        questionnaire:
          type: object
          nullable: true
          additionalProperties: true
          description: ワークフローに紐づくアンケート、または`null`です。
        kyb_role_settings:
          type: array
          items:
            type: object
            additionalProperties: true
          description: KYBの主要人物に対する役割ごとの検証設定です。
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        signature_availability:
          type: object
          description: >-
            現在署名に使用できる電子署名のレベル。`signature_level`を設定する前に確認してください。`kyc`、`kyb`、グラフワークフローで返されます。
          properties:
            simple:
              type: boolean
              description: Simpleは常に利用できます。
            aes:
              type: boolean
              description: >-
                Advanced（AES）で現在署名できるかどうかです。`false`の間は、`signature_level:
                "aes"`の新しいステップを保存しようとすると`aes_not_available`で拒否されます。
            qes:
              type: boolean
              description: Qualified（QES）で現在署名できるかどうかです。適格プロバイダーが接続されるまでは`false`です。
        is_bank_verification_enabled:
          type: boolean
          description: >-
            シンプルなKYCまたはKYBワークフローで銀行認証を実行するかどうかです。連絡先ステップ（および位置情報認証）の後、データベース検証、AML、IP分析の前に実行されます。銀行認証はまだ一般提供されていません。有効化されていない場合、オンにしようとしても拒否されます。
        bank_verification_config:
          type: object
          additionalProperties: true
          description: >-
            シンプルなワークフローの銀行口座認証設定です。`BANK_VERIFICATION`ノードと同じキー（例:
            `bank_countries`、`bank_method_order`）を受け付けます。不明なキーは破棄されます。すべてのキーは任意で、指定しないキーはデフォルト値のままとなるため、`{}`はすべてデフォルト値であることを意味します。詳細は[銀行口座認証の設定](/ja/management-api/workflows/feature-configs#銀行口座認証)を参照してください。
          example: {}
        is_geolocation_enabled:
          type: boolean
          description: >-
            シンプルなKYCワークフローで位置情報認証を実行するかどうかです。連絡先ステップの後、銀行認証とデータベース検証の前に実行されます。企業（KYB）ワークフローでは実行できません。
        geolocation_config:
          type: object
          additionalProperties: true
          description: >-
            シンプルなワークフローの位置情報検証設定で、`GEOLOCATION`ノードと同じキー（例:
            `is_geolocation_geofencing_enabled`や`geolocation_max_attempts`）を受け付けます。不明なキーは破棄されます。すべてのキーは任意で、指定しないキーはデフォルト値のままとなるため、`{}`はすべてデフォルト値を意味します。
          example: {}
      additionalProperties: true
  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.