メインコンテンツへスキップ

キャプチャAPI

セッションを開始するメソッド
メソッド説明
openCameraSelfie({jsonFileName, listener})セルフィーカメラを開く
openCameraSelfie({jsonFileName, listener, prepareInfo})UnicoCheckPrepareInfo メタデータを付与してセルフィーカメラを開く
openCameraDocument({jsonFileName, documentType, listener})指定した DocumentCameraTypes でドキュメントカメラを開く
キャプチャオプション/パラメーター

UnicoCheckPrepareInfo — ユーザーセッションを識別するためのメタデータ。

フィールド必須説明
externalUserIdStringはいシステム内のユーザー識別子。送信前にSHA-256でハッシュ化される。
useCaseStringいいえ現在実行中のコンテキストまたはフローの識別子。平文で送信される。

DocumentCameraTypesEnums を参照。

結果の型とフィールド

ResultCamera — キャプチャ成功時(セルフィーまたはドキュメント)に返されるオブジェクト。

フィールド説明
base64StringBase64形式でキャプチャされた画像
encryptedStringバックエンドに送信するJWT