LIQUID Shield

LIQUID Shield #

顔重複判定結果取得API #

概要 #

LIQUID Shieldにおける顔重複判定結果を取得する。

パス # 

GET /v1/shield/duplicate_face_detection/results

クエリパラメーター #

論理名 物理名 型 必須 初期値 備考
顔重複判定完了起点日 reviewed_at_since String 必須 顔重複判定が完了した日時の起点(inclusive)
ISO 8601 フォーマット: YYYY-MM-DDTHH:MM:SSZ
顔重複判定完了終点日 reviewed_at_until String 任意 顔重複判定が完了した日時の終点(exclusive)
ISO 8601 フォーマット: YYYY-MM-DDTHH:MM:SSZ
取得件数上限値 size Integer 任意 100 顔重複判定結果の取得上限値
有効範囲: 1〜1000
ページネーショントークン after String 任意 ページネーションが存在する場合に指定するトークン

レスポンスパラメーター #

論理名 物理名 型 備考
判定結果 results Array 判定結果参照
reviewed_atをキーに昇順で返却
ページネーション pagination Object ページネーション参照
エラー errors Array エラーコード一覧参照

判定結果 #

顔重複判定結果の一覧

論理名 物理名 型 備考
ID auth_id String 判定対象ユーザID
登録ID liquid_auth_session_id String 顔登録 URL取得APIにて発行された登録ID
顔登録日時 face_registered_at String ISO 8601フォーマット
顔重複判定完了日時 reviewed_at String ISO 8601フォーマット
検知結果 hits Array 検知結果参照

検知結果 #

顔重複判定にて重複が検知されたユーザの情報

論理名 物理名 型 備考
ID auth_id String 検知されたユーザのID
登録ID liquid_auth_session_id String 顔登録 URL取得APIにて発行された登録ID
顔登録日時 face_registered_at String ISO 8601フォーマット

ページネーション #

ページネーションに関する情報

論理名 物理名 型 備考
トークン next String ページネーション用のトークン
返却する判定結果が sizeに指定した件数より多い場合に含まれる

サンプルレスポンス #

ページネーションがない場合

{
  "results": [
    {
      "auth_id": "eb0f404030ff11eebe560242ac120002",
      "liquid_auth_session_id": "8dd8419d629f21d204a1bc24b0307f0f",
      "face_registered_at": "2023-08-02T12:00:00Z",
      "reviewed_at": "2023-08-02T13:00:00Z",
      "hits": [
        {
          "auth_id": "752f92a8312211eebe560242ac120002",
          "liquid_auth_session_id": "4e41f02b7bdd5c6f46f50073c917460a",
          "face_registered_at": "2023-07-30T12:00:00Z",
        },
        {
          "auth_id": "752f92a8312211eebe560242ac120003",
          "liquid_auth_session_id": "4e41f02b7bdd5c6f46f50073c917461a",
          "face_registered_at": "2023-07-31T12:00:00Z",
        }
      ]
    }
  ]
}

ページネーションがある場合

{
  "results": [
    {
      "auth_id": "eb0f404030ff11eebe560242ac120002",
      "liquid_auth_session_id": "8dd8419d629f21d204a1bc24b0307f0f",
      "face_registered_at": "2023-08-02T12:00:00Z",
      "reviewed_at": "2023-08-02T13:00:00Z",
      "hits": [
        {
          "auth_id": "752f92a8312211eebe560242ac120002",
          "liquid_auth_session_id": "4e41f02b7bdd5c6f46f50073c917460a",
          "face_registered_at": "2023-07-30T12:00:00Z",
        },
        ...
        {
          "auth_id": "752f92a8312211eebe560242ac120003",
          "liquid_auth_session_id": "4e41f02b7bdd5c6f46f50073c917461a",
          "face_registered_at": "2023-07-31T12:00:00Z",
        }
      ]
    }
  ],
  "pagination": {
    "next": "dGhpcyBpcyBkdW1teSBkYXRh"
  }
}