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

キャプチャAPI

セッションを開始するメソッド
メソッド説明
prepareSelfieCamera(_:config:)自撮りカメラを準備する
prepareSelfieCamera(_:config:prepareInfo:)PrepareInfoメタデータを使用して自撮りカメラを準備する
prepareDocumentCamera(_:config:)ドキュメントカメラを準備する
open(_:)準備済みの自撮りカメラを開く
openDocument(_:delegate:)DocumentEnumsを使用して準備済みのドキュメントカメラを開く
キャプチャオプション / パラメータ

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

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

DocumentEnumsEnumsを参照してください。

結果の型とフィールド

SelfieResult — 自撮りキャプチャ成功時に返されるオブジェクト。

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

DocumentResult — ドキュメントキャプチャ成功時に返されるオブジェクト。SelfieResultと同じフィールド。