メインコンテンツへスキップ
POST
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

ボディ

multipart/form-data
user_image
file
必須

分析する顔写真(例: セルフィー)。被写体の顔がはっきりと写り、十分に明るい正面向きの写真を1枚送信してください。使用可能な拡張子: tiff、jpg、jpeg、png、webp(PDFは不可)。最大アップロードサイズ: 5 MB(これを超えるファイルは400で拒否されます)。画像は処理前に自動的に約0.3 MBに圧縮されるため、解像度を非常に高くしても精度は向上しません。

face_liveness_score_decline_threshold
number<float>
デフォルト:30

ライブネスのしきい値(0–100)。ライブネスのscoreがこの値以下の場合、LOW_LIVENESS_SCORE警告が追加され、却下されます。より厳格ななりすまし対策にするには値を上げてください。0–100の範囲外の値は400を返します。

必須範囲: 0 <= x <= 100
例:

30

age_estimation_decline_threshold
integer
デフォルト:18

許容される推定年齢の最小値(歳)。推定年齢がこの値を下回る場合はAGE_BELOW_MINIMUM警告が追加され、却下されます。0に設定すると年齢チェックが無効になります(その場合、呼び出しではライブネス検知と年齢推定のみが実行され、年齢に基づく判定は行われません)。

必須範囲: 0 <= x <= 100
例:

18

rotate_image
boolean
デフォルト:false

trueの場合、入力画像を90度単位(0、90、180、270)で試し、最も良好に顔を検出できる向きを使用します。EXIFの向き情報がないモバイル撮影画像に便利です。レイテンシが増加するため、画像が正立していることを保証できない場合にのみ有効にしてください。

例:

false

save_api_request
boolean
デフォルト:true

true(デフォルト)の場合、呼び出しはAPIタイプのセッションとして保存されます。このセッションはBusiness Consoleに表示され、返されたrequest_idを使ってGET /v3/session/{sessionId}/decision/で取得でき、status.updatedWebhookで通知され、検出された顔はアプリケーションの顔インデックスに追加されます。falseの場合、何も保存されず、request_idはレスポンスの照合専用の一時的なUUIDになります。

例:

true

vendor_data
string

任意の不透明な文字列(社内のユーザーID、メールアドレス、UUIDなど)です。保存されたセッションに格納され、レスポンスでそのまま返されます。API呼び出しを自社の記録と関連付けたり、後でセッションを絞り込んだりするために使用します。

例:

"user-123"

metadata
object

セッションとともに保存され(save_api_request=trueの場合)、レスポンスでそのまま返される任意のJSONオブジェクトです。マルチパートリクエストでは、JSONエンコードされた文字列フィールドとして送信してください(例: metadata={"flow":"age-gate"})。オブジェクトとして解析されます。

例:

レスポンス

年齢推定とパッシブライブネスが完了しました。age_estimation.age_estimationは、検出された最も大きい顔についてモデルが予測した年齢(年)です(顔がない場合はnull)。age_estimation.scoreはパッシブライブネスのスコア(0–100)です。statusはwarningsが空の場合にのみApprovedになります。未成年またはなりすましの撮影でも200とstatus: "Declined"が返されるため、HTTPコードだけでなくボディを確認してください。save_api_request=trueの場合、request_idは保存されたセッションIDです。

request_id
string<uuid>

save_api_request=trueの場合は保存されたセッションID(GET /v3/session/{sessionId}/decision/で使用可能)、それ以外の場合は一時的な相関UUIDです。

age_estimation
object
vendor_data
string | null

送信したvendor_dataのエコー、またはnull。

metadata
object | null

送信したmetadataオブジェクトのエコー、またはnull。

created_at
string<date-time>

レスポンスが生成された日時を示すISO 8601タイムスタンプ(UTC)。

最終更新日 2026年11月1日