認証共通

認証共通 #

認証結果取得API #

概要 #

認証結果を取得する

パス # 

GET /v1/auth_sessions/{liquid_auth_session_id}

パスパラメーター #

論理名 物理名 型 必須 初期値 備考
認証ID liquid_auth_session_id String 必須

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

論理名 物理名 型 備考
認証ID liquid_auth_session_id String リクエストパラメーターに設定した認証ID
認証方式 auth_method String 現状はFace_webのみ
IDタイプ id_type String 認証時に指定した値
ID identifier String 認証時に指定した値
認証ステータス completed Boolean 認証結果が確定していたらtrue
(Auth Face Web版において、URLは発行されているが認証が完了していない場合はfalse）
認証結果 result Boolean
認証日時 authenticated_at String ISO 8601フォーマット
カメラインジェクションスコア camera_injection_score Integer カメラインジェクション攻撃の疑いをスコア化した値
0: インジェクション攻撃の可能性が低い
1: カメラインジェクション攻撃の可能性あり
2: カメラインジェクション攻撃の可能性が高い
null: カメラインジェクション攻撃判定結果なし
エラー errors Array エラーコード一覧参照

サンプルレスポンス #

発行したURLで顔認証が行われていない場合

{
  "liquid_auth_session_id": "592344665f6caa1afddefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "auth_method": "Face_web",
  "completed": false,
  "result": false,
  "authenticated_at": "",
  "camera_injection_score": null,
  "errors": []
}

発行したURLで顔認証をした結果、OKとなった場合

{
  "liquid_auth_session_id": "592344665f6c483aaffasdfefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "auth_method": "Face_web",
  "completed": true,
  "result": true,
  "authenticated_at": "2022-01-01T01:00:00.000000+00:00",
  "camera_injection_score": 0,
  "errors": []
}

発行したURLで顔認証をした結果、NGとなった場合

{
  "liquid_auth_session_id": "64dbe02asdfasdw24ac988119f25a0543411",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "auth_method": "Face_web",
  "completed": true,
  "result": false,
  "authenticated_at": "2022-01-01T01:00:00.000000+00:00",
  "camera_injection_score": 0,
  "errors": []
}

メタデータ取得API #

概要 #

メタデータを取得する
指定した認証IDにおいて、認証が成功した時点から取得可能期限内に限りメタデータが取得できる

パス # 

GET /v1/auth_sessions/{liquid_auth_session_id}/metadata

パスパラメーター #

論理名 物理名 型 必須 初期値 備考
認証ID liquid_auth_session_id String 必須

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

論理名 物理名 型 備考
認証ID liquid_auth_session_id String リクエストパラメーターに設定した認証ID
メタデータ metadata Object 登録時に付与したメタデータ
エラー errors Array エラーコード一覧参照

サンプルレスポンス #

発行したセッションIDで認証が成功している場合

{
  "liquid_auth_session_id": "592344665f6caa1afddefd019197bc4",
  "metadata": {"METADATA": "METADATA"},
  "errors": []
}

発行したセッションIDで認証が成功しているが、メタデータが登録されていない場合

{
  "liquid_auth_session_id": "592344665f6c483aaffasdfefd019197bc4",
  "metadata": {},
  "errors": []
}