キャプチャAPI
セッションを開始するメソッド
| メソッド | 説明 |
|---|---|
openCameraSelfie({listener}) | セルフィーカメラを開く |
openCameraSelfie({listener, prepareInfo}) | UnicoCheckPrepareInfo メタデータを付与してセルフィーカメラを開く |
openCameraDocument({documentType, listener}) | 指定した DocumentCameraTypes でドキュメントカメラを開く |
キャプチャオプション/パラメーター
UnicoCheckPrepareInfo — ユーザーセッションを識別するためのメタデータ。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
externalUserId | String | はい | システム内のユーザー識別子。送信前にSHA-256でハッシュ化される。 |
useCase | String | いいえ | 現在実行中のコンテキストまたはフローの識別子。平文で送信される。 |
DocumentCameraTypes — Enums を参照。
結果の型とフィールド
ResultCamera — キャプチャ成功時(セルフィーまたはドキュメント)に返されるオブジェクト。
| フィールド | 型 | 説明 |
|---|---|---|
base64 | String | Base64形式でキャプチャされた画像 |
encrypted | String | バックエンドに送信するJWT |