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

ヘッダー

Idempotency-Key
string

最大255文字の任意の再試行安全キーです。同じキーを同じリクエストボディで再利用すると、2回目のスクリーニングを実行・請求することなく元のレスポンスが返されます。異なるボディでキーを再利用すると409が返されます。

Maximum string length: 255

ボディ

application/json
full_name
string
必須

スクリーニング対象の人物または企業の正式名称。最低2文字で、これはスクリーニングプロバイダー自体の下限です。これより短い名前または空の名前の場合、スクリーニングが実行される前にこのフィールドで400が返されるため、課金は発生しません。

Minimum string length: 2
例:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
デフォルト:person

スクリーニング対象のエンティティの種類。デフォルトはpersonです。

利用可能なオプション:
person,
company
date_of_birth
string<date>

生年月日(個人)または設立日(企業)、YYYY-MM-DD形式。生年月日の重みにより照合精度が向上します。

例:

"1972-02-29"

nationality
string

ISO 3166-1 alpha-2の国コード(例: ES)。無効なコードは400を返します。国の重み付けにより一致精度が向上します。

例:

"ES"

document_number
string

本人確認書類の番号。重み付けはされず、決定的なキーとして機能します: 完全一致の場合はヒットのmatch_scoreが100に上書きされ、明確な不一致の場合はスコアが減点されます。スクリーニングプロバイダーに検索フィルターとして送信されるのは、2〜50文字の場合のみです。この範囲外の値も受け付けられて保存され、スクリーニングも実行されて料金が請求されますが、書類番号による絞り込みは行われません。

aml_score_approve_threshold
number
デフォルト:80

これ以下であれば結果がApprovedになるリスクスコアのしきい値です。aml_score_review_threshold以下である必要があります(そうでない場合は400)。

必須範囲: 0 <= x <= 100
aml_score_review_threshold
number
デフォルト:100

これを超えると結果がDeclinedになるリスクスコアのしきい値です。2つのしきい値の間のスコアはIn Reviewになります。

必須範囲: 0 <= x <= 100
aml_name_weight
integer
デフォルト:60

ヒットごとの一致スコアにおける氏名類似度の重み。3つの重みの合計はちょうど100である必要があります(そうでない場合は400)。

必須範囲: 0 <= x <= 100
aml_dob_weight
integer
デフォルト:25

ヒットごとの一致スコアにおける生年月日の重み。

必須範囲: 0 <= x <= 100
aml_country_weight
integer
デフォルト:15

ヒットごとの一致スコアにおける国/国籍の重み。

必須範囲: 0 <= x <= 100
aml_match_score_threshold
integer
デフォルト:93

ヒットごとのカットオフ値。match_scoreがこの値未満のヒットはFalse Positive(リスク評価から除外)となり、この値以上のヒットはUnreviewedの一致候補となります。

必須範囲: 0 <= x <= 100
include_adverse_media
boolean
デフォルト:false

ネガティブな報道についてニュースメディアも検索します。結果の収集中に最大約30秒のレイテンシーが加わるため、60秒以上のクライアントタイムアウトを使用してください。

include_ongoing_monitoring
boolean
デフォルト:false

このプロファイルの再スクリーニングを継続し、変更をWebhookで通知します。save_api_request=trueが必要です(指定しない場合は400)。

save_api_request
boolean
デフォルト:true

スクリーニングをセッションとして保存します(コンソールでの表示、判定エンドポイント、Webhook、ヒットのレビュー)。ステートレスなチェックにするにはfalseに設定します。

vendor_data
string

スクリーニング対象ユーザーに対するお客様側の識別子です。そのまま返され、セッションとともに保存されます。

metadata
object | null

リクエストとともに保存され、そのまま返される自由形式のJSON。

sandbox_scenario
string

サンドボックス専用のシナリオスラッグ。APIキーがサンドボックスモードのアプリケーションに属する場合にのみ受け付けられ、本番アプリケーションでは拒否されます。単体のスクリーニングには準備対象のセッションがないため、スラッグはスクリーニングリクエスト自体に指定します。decline_aml_hitは本番と同じ形式のヒットを1件返してスクリーニングをDeclinedとして確定し、review_aml_possible_matchはIn Reviewとして確定します。AMLの結果を準備しないシナリオでは、スクリーニングはクリーンのままです。シナリオカタログはGET /v1/sandbox/scenarios/またはサンドボックスとテストデータを参照してください。

例:

"decline_aml_hit"

レスポンス

スクリーニングが完了しました。aml.statusは設定したしきい値を反映します。内部の掲載下限以上のヒットはすべてaml.hitsに一覧表示され、本人同一性のmatch_score、エンティティのrisk_score、および一致内容を説明するscore_breakdownが含まれます。

request_id
string<uuid>

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

aml
object
vendor_data
string | null

送信したvendor_dataをそのまま返します。

metadata
object | null

送信したmetadataのエコー。

created_at
string<date-time>
最終更新日 2026年11月1日