送る例と返る例

送る例

POST /v1/screen
Content-Type: application/json

{
  "name": "（照合したい氏名または名称）",
  "type": "person",
  "threshold": （0.0 から 1.0 の数値。省略できます）
}

返る例

{
  "query": "（送られた文字列をそのまま返します）",
  "threshold_used": （実際に使った閾値）,
  "list_version": "（照合に使った名簿の基準日）",
  "matches": [
    {
      "list": "（どの名簿か）",
      "entry_id": "（名簿側の識別子）",
      "matched_name": "（名簿に載っている表記）",
      "match_score": （0.0 から 1.0 の数値）,
      "reason": {
        "components": { "（観点の名称）": （その観点の値） },
        "weights":    { "（観点の名称）": （合わせるときの比重） },
        "normalized_query": "（正規化した後の照会文字列）",
        "normalized_target": "（正規化した後の名簿側の表記）",
        "rule": "（適用した規則の識別子）"
      }
    }
  ],
  "disclaimer": "提供開始前の仕様例です。本番の取引の判定には使用できません。"
}

この例の読み方

上の例は仕様の形を示すための作り物です。実在する名簿の項目を写したものではなく、実際に測った値でもありません。

項目の名称・観点の内訳・比重の置き方は、提供開始までに確定します。現時点で確定した値としてお示しできる段階にありません。

確定しているのは何を返すかです。一致の度合い（match_score）、そう判断した理由（reason）、実際に使った閾値（threshold_used）、照合に使った名簿の版（list_version）を返します。お客様の側で検知の基準の妥当性を検証していただくためです。