Auth Face web版 #

Auth Face URL取得API #

概要 #

Auth Face web版のURLを取得する

パス #

POST /v1/auth_face/sessions

リクエストボディ #

論理名	物理名	型	必須	初期値	備考
IDタイプ	id_type	String	必須		ekyc もしくは auth
ID	identifier	String	必須		id_type=ekycなら、LIQUID eKYC連携IDを設定 id_type=authなら、LIQUID Auth IDを設定
認証有効期限	expires	Integer	任意	30	発行するURLの有効期限（秒）有効範囲: 0〜31536000 (１年に相当)
認証リトライ回数	retry_limit	Integer	任意	3	認証に失敗した場合のリトライ許容回数（回）有効範囲: 0〜100
認証タイムアウト	session_timeout	Integer	任意	60	URLを開いてから認証を行うまでの制限時間（秒）（リトライする場合も制限時間はリセットされない）有効範囲: 0〜3600(１時間に相当)
顔検出タイムアウト	detection_timeout	Integer	任意	30	顔が検出できない場合に撮影を中止するまでの時間（秒）有効範囲: 0〜3600(1時間に相当)
自動リダイレクト処理待機時間	auto_redirect_waiting_time	Integer	任意	1	認証完了後から自動リダイレクト処理を行うまでの待機時間（秒）有効範囲: 0〜10
リダイレクトURI	redirect_uri	String	必須		認証後のリダイレクト先URI
URLアクセス制御フラグ	one_time_access	Boolean	任意	false	true: URLへのアクセスを1度のみ許可 false: アクセス回数によるURLへのアクセス制限を設けない
IPアドレス制限フラグ	first_access_ip_restriction	Boolean	任意	true	true: 2回目以降のURLへのアクセスは1回目と同じIPアドレスのみ許可 false: IPアドレスによるURLへのアクセス制限を設けない
自動リダイレクトフラグ	auto_redirect	Boolean	任意	true	true: 認証後のリダイレクト先へ自動で遷移 false: 認証後のリダイレクト先へユーザによるボタン押下で遷移
チュートリアル表示フラグ	tutorial	Boolean	任意	true	true: チュートリアル表示後に認証開始 false: チュートリアルを表示をせずに認証開始

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

論理名	物理名	型	備考
認証URL	url	String
認証ID	liquid_auth_session_id	String
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

{
  "url": "https://authface.liquid-auth.com?s=d26845679a95e480795b0392d98e3c88a&t=21FHogeXXadkgpySGC_Vn3ZLMnryQusmlhe8ejWbDFuw",
  "liquid_auth_session_id": "d2684239a95asdf0795b0392d98e3c88a",
  "errors": []
}

パラメーターの値が不正だった場合

{
  "errors": [
    {
      "code": "ELAC0000005",
      "desc": "expires must be greater equal than 0",
      "value": "expires"
    },
    {
      "code": "ELAC0000005",
      "desc": "session_timeout must be greater equal than 0",
      "value": "session_timeout"
    }
  ]
}

顔登録 URL取得API #

概要 #

顔登録のURLを取得する

パス #

POST /v1/auth_face/register_sessions

リクエストボディ #

論理名	物理名	型	必須	初期値	備考
IDタイプ	id_type	String	必須		auth
ID	identifier	String	必須		LIQUID Auth IDを設定
登録有効期限	expires	Integer	任意	30	発行するURLの有効期限（秒）有効範囲: 0〜31536000 (１年に相当)
登録タイムアウト	session_timeout	Integer	任意	60	URLを開いてから登録を行うまでの制限時間（秒）（リトライする場合も制限時間はリセットされない）有効範囲: 0〜3600(１時間に相当)
自動リダイレクト処理待機時間	auto_redirect_waiting_time	Integer	任意	1	登録完了後から自動リダイレクト処理を行うまでの待機時間（秒）有効範囲: 0〜10
リダイレクトURI	redirect_uri	String	必須		認証後のリダイレクト先URI
URLアクセス制御フラグ	one_time_access	Boolean	任意	false	true: URLへのアクセスを1度のみ許可 false: アクセス回数によるURLへのアクセス制限を設けない
IPアドレス制限フラグ	first_access_ip_restriction	Boolean	任意	true	true: 2回目以降のURLへのアクセスは1回目と同じIPアドレスのみ許可 false: IPアドレスによるURLへのアクセス制限を設けない
上書きチェックフラグ	check_overwrite	Boolean	任意	false	true: 登録済みIDが指定された場合、エラーを返す false: 登録済みIDが指定された場合、画像は上書きされる
自動リダイレクトフラグ	auto_redirect	Boolean	任意	true	true: 登録後のリダイレクト先へ自動で遷移 false: 登録後のリダイレクト先へユーザによるボタン押下で遷移
チュートリアル表示フラグ	tutorial	Boolean	任意	true	true: チュートリアル表示後に登録開始 false: チュートリアルを表示をせずに登録開始
メタデータ	metadata	Object	任意	`{}`	登録する顔情報に付与するメタデータ(UTF-8にて最大300KBまで) 顔認証結果が認証成功の場合に、メタデータ取得APIのレスポンスパラメータとして返却される顔登録情報を上書きする場合はメタデータも上書きされる

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

論理名	物理名	型	備考
登録URL	url	String
登録ID	liquid_auth_session_id	String
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

{
  "url": "https://authface.liquid-auth.com?s=d26845679a95e480795b0392d98e3c88a&t=21FHogeXXadkgpySGC_Vn3ZLMnryQusmlhe8ejWbDFuw&p=register",
  "liquid_auth_session_id": "d2684239a95asdf0795b0392d98e3c88a",
  "errors": []
}

パラメーターの値が不正だった場合

{
  "errors": [
    {
      "code": "ELAC0000005",
      "desc": "expires must be greater equal than 0",
      "value": "expires"
    },
    {
      "code": "ELAC0000005",
      "desc": "session_timeout must be greater equal than 0",
      "value": "session_timeout"
    }
  ]
}

顔登録結果取得API #

概要 #

顔登録結果を取得する

パス #

GET /v1/auth_face/register_sessions/{liquid_auth_session_id}

パスパラメーター #

論理名	物理名	型	必須	初期値	備考
登録ID	liquid_auth_session_id	String	必須

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

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

サンプルレスポンス #

発行したURLで顔登録が行われていない場合

{
  "liquid_auth_session_id": "592344665f6caa1afddefd019197bc4",
  "id_type": "auth",
  "identifier": "YOUR_AUTH_ID",
  "completed": false,
  "result": false,
  "registered_at": "",
  "camera_injection_score": null,
  "errors": []
}

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

{
  "liquid_register_session_id": "592344665f6c483aaffasdfefd019197bc4",
  "id_type": "auth",
  "identifier": "YOUR_AUTH_ID",
  "completed": true,
  "result": true,
  "registered_at": "2023-01-01T01:00:00.000000+00:00",
  "camera_injection_score": 0,
  "errors": []
}

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

{
  "liquid_register_session_id": "64dbe02asdfasdw24ac988119f25a0543411",
  "id_type": "auth",
  "identifier": "YOUR_AUTH_ID",
  "completed": true,
  "result": false,
  "registered_at": "2023-01-01T01:00:00.000000+00:00",
  "camera_injection_score": 0,
  "errors": []
}