提供開始前です。以下は提供予定の仕様であり、本番の取引の判定には使えません。実装はまだ公開していません。
細目は提供開始までに確定します。
仕様
対応する名簿
| 名簿 | 出所 | 更新の取り方 | 状態 |
|---|---|---|---|
| 資産凍結等対象者一覧 | 財務省 | 出所の掲載を定期的に取得し、差分を反映 | 提供予定 |
| その他の名簿 | ー | ー | 利用条件の確認中。確認が済むまで対応するとは申し上げません |
財務省の掲載内容には公共データ利用規約(第 1.0 版)が適用され、出典を示したうえでの商用利用が認められています。この利用条件を確認したうえで対応しています。他の名簿については、配布元と利用条件の確認が済んでいないため、現時点で対応の予定を申し上げません。
入力
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
name | 文字列 | 必須 | 照合する氏名または名称 |
type | 文字列 | 任意 | person または entity |
threshold | 数値 | 任意 | 候補として返す下限(0.0 から 1.0)。お客様の側で指定していただけます。省略した場合の既定値は提供開始までに確定します |
country | 文字列 | 任意 | 国・地域の符号(絞り込みに使用) |
出力
| 項目 | 型 | 説明 |
|---|---|---|
query | 文字列 | 送られた文字列(そのまま返します。保存はしません) |
matches | 配列 | 候補の一覧。閾値を超えたものだけ |
matches[].list | 文字列 | どの名簿の項目か |
matches[].entry_id | 文字列 | 名簿側の識別子 |
matches[].matched_name | 文字列 | 名簿に載っている表記 |
matches[].match_score | 数値 | 一致の度合い(0.0 から 1.0) |
matches[].reason | 物体 | そう判断した理由(下記) |
threshold_used | 数値 | 実際に使った閾値。お客様が指定した場合はその値、省略した場合は既定値を返します |
list_version | 文字列 | 照合に使った名簿の版(基準日) |
disclaimer | 文字列 | 提供開始前である旨と、本番の取引の判定に使えない旨 |
一致の度合いの出し方について
表記の違い・読みの近さ・語の並びといった複数の観点を合わせて、一致の度合いを 1 つの数値にします。どの観点をどう合わせたかを、応答の reason に含めて返します。
観点の内訳と合わせ方は、提供開始までに確定します。現時点で確定した値としてお示しできる段階にありません。
reason に入れるもの
| 項目 | 説明 |
|---|---|
| 観点ごとの値 | 一致の度合いを構成する各観点の値 |
| 合わせ方 | 各観点をどの比重で合わせたか |
normalized_query | 正規化した後の照会文字列 |
normalized_target | 正規化した後の名簿側の文字列 |
| 適用した規則 | どの規則で照合したか |
内訳を開示するのは、お客様の側で基準の妥当性を検証していただくためです。項目の名称と粒度は提供開始までに確定します。
更新の頻度
財務省の掲載を1 日 1 回取得し、変更があれば反映する予定です。実績はまだありません(提供開始前のため)。応答に含まれる list_version で、照合に使った名簿の基準日をいつでも確認できます。