はじめに
連携 / SDK
ユーザー認証
法人確認
トランザクションモニタリング
変更履歴curl -X GET 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.retrieve_config()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.retrieveConfig();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.RetrieveConfig(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().retrieveConfig();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->retrieveConfig();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.retrieve_config
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.RetrieveConfigAsync();
Console.WriteLine(JsonSerializer.Serialize(result));Webhook設定取得API
Didit Management APIでアプリケーションのWebhook設定を取得します。従来のWebhook URLとシークレット、Webhookの送信先、購読可能なイベント、データ保持ポリシー、ウォレットの戻り先ホストを確認できます。
curl -X GET 'https://verification.didit.me/v3/webhook/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.retrieve_config()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.webhooks.retrieveConfig();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.RetrieveConfig(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.webhooks().retrieveConfig();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->retrieveConfig();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.webhooks.retrieve_config
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Webhooks.RetrieveConfigAsync();
Console.WriteLine(JsonSerializer.Serialize(result));secret_shared_keyで署名されます。トップレベルのwebhook_url、webhook_version、secret_shared_keyは、有効になっている送信先が1つもない場合にのみ使用され、その場合もstatus.updatedとdata.updatedに限られます。
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
レスポンス
Webhookの設定。
アプリケーションレベルのWebhook設定、保持ポリシー、Digital IDウォレットの戻り先ホスト、およびすべてのWebhookの送信先。
アプリケーションレベル（レガシー）のWebhook URL。Diditは、アプリケーションに有効な送信先が1つもない間に限りこのURLに送信し、その場合もstatus.updatedとdata.updatedのみを送信します。送信先を作成、更新、削除するたびに、この値は最も古い有効な送信先のURL、または有効な送信先がない場合はnullに設定されます。
従来のwebhook_urlのペイロードバージョン。各送信先はそれぞれ独自のwebhook_versionを持ちます。
v1, v2, v3 アプリケーションレベルの署名シークレット（43文字のURLセーフなトークン）。従来のwebhook_urlへの配信にのみ署名し、各送信先はそれぞれのsecret_shared_keyで署名します。APIキーで呼び出した場合は常に全体が返されます。read:webhooksを持たないConsoleユーザーには空文字列が返されます。
レガシーのアプリケーション設定。認証フローではこの値は読み取られません。撮影オプションはワークフローごとに設定します。
MOBILE, MOBILE_AND_DESKTOP セッションの削除時に、そのセッションの顔エンベディングをどう扱うか。delete_with_session（デフォルト）はセッションとともに削除します。retain_until_user_deletedはオプトインの生体認証テンプレートの保持です。Userに紐付いた画像を含まない生体認証テンプレートが、保持期間が終了するか、Userが削除されるか、お客様が消去するまで、セッションとは別に管理されます。
delete_with_session, retain_until_user_deleted retain_until_user_deletedにおける生体認証テンプレートの保持期間（日数）。このポリシーを設定する場合は必須です。
1 <= x <= 3650送信先がサブスクライブできるすべてのイベントタイプと、その表示ラベルです。
Show child attributes
Show child attributes
アプリケーションのすべてのWebhookの送信先を、それぞれの署名シークレットとともに古い順に示します。ここでは読み取り専用です。送信先の管理には/v3/webhook/destinations/エンドポイントを使用してください。
Show child attributes
Show child attributes
ホスト型フローとネイティブSDKが、顔の撮影前に本人へ生体認証についての明示的な同意を求める条件です。auto（デフォルト）は、トリガーに該当する場合にのみ同意を求めます。該当するのは、申告された州、本人のIP、または本人確認書類の発行元がイリノイ州、テキサス州、コロラド州のいずれかである場合、または州が不明なまま本人が米国にいると見られる場合です。alwaysは、ワークフローで顔を撮影するすべての人に同意を求めます。neverはこのステップを一切表示しないため、セルフィーの前にお客様自身で同意を取得する必要があります。変更はすべて監査ログに記録されます。詳しくは生体認証の同意を参照してください。
auto, always, never ホスト型の検証フローを埋め込むことができ、セッションのコールバックでユーザーを戻すことができるオリジンです（例：https://app.example.com。httpはlocalhostの場合のみ）。サーバー間の呼び出しには影響しません。空のリストは制限なしを意味します。Diditは各オリジンを小文字で、デフォルトポートを除いて保存します。無効なエントリはallowed_domainsで400として失敗します。
50300["https://app.example.com"]