メインコンテンツへスキップ
GET
cURL

承認

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です(一覧エンドポイントが返すuuidの値)。ワークフローの各バージョンには、それぞれ固有のsettings_uuidがあります。

レスポンス

ワークフローの完全な設定。形式はVerificationSettingsをそのままシリアライズしたもの(約190フィールド:すべての機能のオン/オフ、しきい値、警告アクション、許可書類の設定、workflow_graph、再試行ポリシー、コールバック、料金)です。以下の例は省略版です。注意点:featuresは" + "で連結された文字列(例:"OCR + LIVENESS")であり、料金はJSONの数値で、is_editableはdraftバージョンの場合にのみtrueになります。

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