メインコンテンツへスキップ
PATCH
cURL
部分的な更新にはPATCHを使用します。ワークフローの名前を変更する場合は、workflow_labelのみを送信してください。
ワークフローのチェック内容を変更するには、変更後のfeatures配列全体を送信します。これにより、以前の機能の順序と設定が置き換えられます。
v3 APIではワークフローをシンプルに保ちます。直線的なパスが1本と、最終ステータスのステップが1つだけです。分岐、アクションノード、Webhookノードはここでは受け付けられません。

機能設定リファレンス

PATCHでfeaturesを送信すると、その配列によって以前の機能の順序と設定が置き換えられます。必須の設定はすべて改めて含めてください。 configオブジェクトの正確な内容は機能によって異なります。フィールドの一覧、デフォルト値、必須の設定、値の範囲、例についてはワークフローの機能設定を参照してください。 OCRでは、config.documents_allowedを省略するか、nullまたは{}を送信すると、サポートされているすべての書類タイプが許可されます。ワークフローを特定の国や書類タイプに限定したい場合にのみ含めてください。QUESTIONNAIREではconfig.questionnaire_uuidが必須です。

ワークフロー設定の更新

機能の一覧に触れずに、セッションレベルの設定を部分的に更新できます。変更したいフィールドのみを送信してください。
一覧、作成、または取得エンドポイントから返されるワークフローのuuidを、このURLのsettings_uuidとして使用してください。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

settings_uuid
string<uuid>
必須

更新するワークフローのバージョンごとのUUIDです。

ボディ

application/json

ワークフローのメタデータを更新するか、線形の機能リスト全体を置き換えます。厳格なフィールドホワイトリストが適用され、ここに記載されていないキーは400で拒否されます。

workflow_label
string

ワークフローの表示名です(最大50文字)。

Maximum string length: 50
is_default
boolean

このワークフローを新しいセッションのデフォルトに設定します。

status
enum<string>

バージョン管理を制御します。省略すると現在のバージョンがその場で更新されます(下書きは自動的に公開されます)。公開済みのバージョンにpublishedを指定すると、新しいバージョンが作成されて返されます。draftはバージョンがまだ下書きの間のみ有効です。

利用可能なオプション:
draft,
published
features
object[]

指定した場合、機能の順序と設定の全体がこの値で置き換えられます。

Minimum array length: 1
is_white_label_enabled
boolean

このワークフローで作成されたセッションのホワイトラベルカスタマイズを有効にします。

is_desktop_allowed
boolean

デスクトップブラウザでの認証フローの実行を許可します。

max_retry_attempts
integer

認証が却下された後に許可される最大再試行回数です。0の場合、最初の却下でユーザーはブロックされます。

必須範囲: 0 <= x <= 10
retry_window_days
integer | null

再試行回数のカウントに使用する日単位のローリングウィンドウ。nullの場合は期間無制限の上限が適用されます。

必須範囲: 1 <= x <= 365
face_liveness_max_attempts
integer

セッション1件あたりのライブネス検知の最大送信回数です。機能レベルの設定で上書きされない限り、この値は生成されるライブネス検知および年齢推定のワークフローノードにもコピーされます。

必須範囲: 1 <= x <= 3
face_match_max_attempts
integer

セッション1件あたりの顔照合の最大送信回数です。機能レベルの設定で上書きされない限り、この値は生成される顔照合のワークフローノードにもコピーされます。

必須範囲: 1 <= x <= 3
session_expiration_time
integer

未完了のセッションが期限切れになるまでの秒数。最小1時間(3600)、最大4週間(2419200)。

必須範囲: 3600 <= x <= 2419200

レスポンス

ワークフローが更新されました。本文は、結果として得られたバージョンの完全な設定です(GET /v3/workflows/{settings_uuid}/と同じ生のVerificationSettings形式)。更新によって新しいバージョンが作成された場合(公開済みの行にstatus: "published"を送信した場合)、返されるuuidとversionはパッチを適用したものとは異なります。以降の呼び出しには返されたuuidを使用してください。

以下のフィールドには型が定義されています。このオブジェクトには、ワークフロー設定のその他すべての列(機能の切り替え、しきい値、警告アクション、許可される書類、コールバック)も追加プロパティとして含まれます。workflow_typeに該当しないフィールドはnullです。

uuid
string<uuid>

バージョンごとの識別子(settings_uuid)です。ワークフローの各バージョンがそれぞれ固有の値を持ちます。

workflow_id
string<uuid>

ワークフローのすべてのバージョンで共有される不変の識別子。これを使って作成したセッションでは、公開済みの最新バージョンが使用されます。

workflow_label
string

ワークフローの表示名。

workflow_type
enum<string> | null

ワークフローテンプレート。テンプレートなしで作成されたグラフワークフローではnullです。

利用可能なオプション:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

アプリケーションのデフォルトのワークフローかどうか。

is_archived
boolean

アーカイブ済みのワークフローでは新しいセッションを開始できません。

version
integer

ワークフロー内のバージョン番号。

status
enum<string>

ドラフトバージョンは編集できます。公開済みバージョンは変更できず、新しいセッションで使用されます。

利用可能なオプション:
draft,
published
published_at
string<date-time> | null

このバージョンが公開された日時。下書きの場合はnullです。

is_simple_workflow
boolean

ワークフローにカスタムのworkflow_graphがない場合はtrueです。

is_editable
boolean

draftバージョンの場合のみtrueです。

workflow_url
string<uri>

このワークフローでセッションを開始する公開URLです。

workflow_graph
object | null

ワークフローのグラフ構造(ノードとエッジ)。シンプルなワークフローではnullです。

features
string

有効な機能を" + "で連結したものです。例: "OCR + LIVENESS"。

total_price
number | null

セッション1件あたりの料金。グラフ型ワークフローでは最も高い経路の料金です。

min_price
number | null

ワークフロー内で最も安い経路の料金。

max_price
number | null

ワークフロー内で最も高い経路の料金。

special_add_on_prices
object | null

組織固有のアドオン料金です。設定されていない場合はnullです。

max_retry_attempts
integer

認証が却下された後に許可される再試行回数。

retry_window_days
integer | null

再試行が許可される日数。

session_expiration_time
integer

未完了のセッションが期限切れになるまでの秒数。

questionnaire
object | null

ワークフローに紐づくアンケート、またはnullです。

kyb_role_settings
object[]

KYBの主要人物に対する役割ごとの検証設定です。

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

現在署名に使用できる電子署名のレベル。signature_levelを設定する前に確認してください。kyc、kyb、グラフワークフローで返されます。

is_bank_verification_enabled
boolean

シンプルなKYCまたはKYBワークフローで銀行認証を実行するかどうかです。連絡先ステップ(および位置情報認証)の後、データベース検証、AML、IP分析の前に実行されます。銀行認証はまだ一般提供されていません。有効化されていない場合、オンにしようとしても拒否されます。

bank_verification_config
object

シンプルなワークフローの銀行口座認証設定です。BANK_VERIFICATIONノードと同じキー(例: bank_countries、bank_method_order)を受け付けます。不明なキーは破棄されます。すべてのキーは任意で、指定しないキーはデフォルト値のままとなるため、{}はすべてデフォルト値であることを意味します。詳細は銀行口座認証の設定を参照してください。

例:
is_geolocation_enabled
boolean

シンプルなKYCワークフローで位置情報認証を実行するかどうかです。連絡先ステップの後、銀行認証とデータベース検証の前に実行されます。企業(KYB)ワークフローでは実行できません。

geolocation_config
object

シンプルなワークフローの位置情報検証設定で、GEOLOCATIONノードと同じキー(例: is_geolocation_geofencing_enabledやgeolocation_max_attempts)を受け付けます。不明なキーは破棄されます。すべてのキーは任意で、指定しないキーはデフォルト値のままとなるため、{}はすべてデフォルト値を意味します。

例:
最終更新日 2026年11月1日