ユーザーデータ #

ユーザーID発行API #

概要 #

ユーザーIDを発行する。
※ LIQUID eKYC（ホ、ヘ方式）をご利用の場合は不要です。

パス #

POST /v1/auth

リクエストパラメーター #

なし

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

論理名	物理名	型	備考
ID	auth_id	String
作成日時	created_at	String	AuthID発行時刻。ISO8601フォーマットで出力されます
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

{
  "auth_id": "2938c5228616439fa3d9c7a5596c37cf",
  "created_at": "2023-02-02T09:14:36.165046+00:00",
  "errors": []
}

ユーザー顔登録API #

概要 #

指定ユーザーIDに顔画像を登録する。
※ LIQUID eKYC（ホ、ヘ方式）をご利用の場合は不要です。

パス #

POST /v1/auth/{identifier}/faces

パスパラメーター #

論理名	物理名	型	必須	初期値	備考
ID	identifier	String	必須		ユーザーID発行APIで発行したID

リクエストボディ #

論理名	物理名	型	必須	初期値	備考
顔画像	face_image	String	必須		Base64形式にエンコードしたjpgの顔画像
上書きチェックフラグ	check_overwrite	Boolean	任意	false	true: 登録済みIDが指定された場合、エラーを返す false: 登録済みIDが指定された場合、画像は上書きされる

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

論理名	物理名	型	備考
ID	auth_id	String	リクエストパスに指定されたID
作成日時	created_at	String	顔情報登録時刻。ISO8601フォーマットで出力されます
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

{
  "auth_id": "2938c5228616439fa3d9c7a5596c37cf",
  "created_at": "2023-02-02T09:21:28.559484+00:00",
  "errors": []
}

ユーザーデータ削除API #

概要 #

ユーザーデータを削除する

パス #

DELETE /v1/{id_type}/{identifier}

パスパラメーター #

論理名	物理名	型	必須	初期値	備考
IDタイプ	id_type	String	必須
ID	identifier	String	必須

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

論理名	物理名	型	備考
処理ID	process_id	String
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

{
  "process_id": "792344a65f6caa1afddefd019197bc4",
  "errors": []
}

ユーザーデータ削除結果取得API #

概要 #

ユーザーデータ削除処理の結果を取得する

パス #

GET /v1/delete_processes/{process_id}

パスパラメーター #

論理名	物理名	型	必須	初期値	備考
処理ID	process_id	String	必須

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

論理名	物理名	型	備考
処理ID	process_id	String
IDタイプ	id_type	String	削除時に指定した値
ID	identifier	String	削除時に指定した値
ステータス	status	String	“Accepted” : 受付中 “Processing” : 処理中 “Completed” : 完了 “Failed” : 失敗
受付日時	accepted_at	String	ISO 8601フォーマット
完了日時	completed_at	String	ISO 8601フォーマット
更新日時	updated_at	String	ISO 8601フォーマット
エラー	errors	Array	エラーコード一覧参照

サンプルレスポンス #

受付直後の状態

{
  "process_id": "792344a65f6caa1afddefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "status": "Accepted",
  "accepted_at": "2022-01-01T01:00:00.000000+00:00",
  "updated_at": "2022-01-01T01:00:00.000000+00:00",
  "errors": []
}

処理中の状態

{
  "process_id": "792344a65f6caa1afddefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "status": "Processing",
  "accepted_at": "2022-01-01T01:00:00.000000+00:00",
  "updated_at": "2022-01-01T01:05:00.000000+00:00",
  "errors": []
}

完了した状態

{
  "process_id": "792344a65f6caa1afddefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "status": "Completed",
  "accepted_at": "2022-01-01T01:00:00.000000+00:00",
  "completed_at": "2022-01-01T01:10:00.000000+00:00",
  "updated_at": "2022-01-01T01:10:00.000000+00:00",
  "errors": []
}

削除処理に失敗した状態

{
  "process_id": "792344a65f6caa1afddefd019197bc4",
  "id_type": "ekyc",
  "identifier": "YOUR_APPLICANT_ID",
  "status": "Failed",
  "accepted_at": "2022-01-01T01:00:00.000000+00:00",
  "updated_at": "2022-01-01T01:10:00.000000+00:00",
  "errors": []
}