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

ドキュメントキャプチャ

本人確認書類のキャプチャ。SDK はドキュメントの位置決めを補助するフレームを表示し、位置が合ったらユーザーがボタンをクリックして写真を撮影します。

コンテンツ検証なし

SDK はキャプチャされているものに対して何らかの検証を行いません。

利用可能なドキュメントフレーム
フレーム説明
DocumentCameraTypes.CPFCPF をキャプチャ
DocumentCameraTypes.CNH開いた CNH をキャプチャ
DocumentCameraTypes.CNH_FRENTECNH の表面をキャプチャ
DocumentCameraTypes.CNH_VERSOCNH の裏面をキャプチャ
DocumentCameraTypes.RG_FRENTERG の表面をキャプチャ
DocumentCameraTypes.RG_VERSORG の裏面をキャプチャ
DocumentCameraTypes.RG_FRENTE_NOVO新 RG の表面をキャプチャ
DocumentCameraTypes.RG_VERSO_NOVO新 RG の裏面をキャプチャ
DocumentCameraTypes.OTHERS("descrição")その他のドキュメント用汎用フレーム
汎用フレーム

特定のフレームが存在しないドキュメント（例：RNE）をキャプチャする必要がある場合は、DocumentCameraTypes.OTHERS("description") を使用してください — どのキャプチャにも対応できる汎用の長方形フレームです。

サポートされているドキュメントタイプの一覧については、API リファレンス > Enum をご参照ください。

フレームサイズ

キャプチャエリアを最適化するために、アプリケーション内でフレームのサイズを設定することをお勧めします。

CSS の干渉

フレームの機能は、グリッドコンポーネント（Bootstrap、Material-UI など）を持つデザインシステムの影響を受ける場合があります。このリスクを最小限に抑えるために、フレーム（id="box-camera"）を不要な CSS ルールを継承しない場所に配置してください。

フレームをラッパー要素で囲んでサイズを制限します：

<div class="container">
  <div id="box-camera"></div>
</div>
.container {
  width: 800px;
  height: 600px;
  position: relative;
}

ユーザーの顔をフレームに収めやすくするために、適切な縦横比を維持してください。

開発者ツールでのリサイズ

ブラウザの開発者モードを通じた画面リサイズのテストは期待通りに動作しません。代わりにブラウザウィンドウを直接リサイズしてください。

ドキュメントキャプチャの開始
ステップ 1 — callback オブジェクトを実装する

Web SDK は callback オブジェクトを使用します。このオブジェクトは open() に渡され、成功イベントとエラーイベントを処理します。両方のハンドラーは必須です:

ハンドラー呼び出されるタイミング
on.success(obj)キャプチャが正常に完了した場合 — base64 と encrypted を含むオブジェクトを受け取ります
on.error(error)セッション中にエラーが発生した場合 — ErrorBio を受け取ります
const callback = {
  on: {
    success: (obj) => {
      console.log(obj.base64);
      console.log(obj.encrypted);
    },
    error: (error) => {
      console.error(error);
    }
  }
};
必須の callback

callback オブジェクトは必須です。success と error の両方のイベントをカバーする形で適切に実装されていない場合、SDK は例外を発生させます。この例外が処理されないと、ユーザーのコンソールに表示されます。

ステップ 2 — カメラをビルドしてドキュメントセッションを準備する

カメラインスタンスをビルドし、UnicoConfig と希望する DocumentCameraTypes を渡して prepareDocumentCamera を呼び出します：

const unicoCamera = unicoCameraBuilder.build();

const config = new UnicoConfig()
  .setHostname("<YOUR_HOSTNAME>")
  .setHostKey("<YOUR_HOST_KEY>");

unicoCamera.prepareDocumentCamera(
  config,
  DocumentCameraTypes.CNH
).then(cameraOpener => {
  cameraOpener.open(callback);
}).catch(error => {
  console.error(error);
});

結果の完全な処理については、結果の受け取り をご参照ください。

最終更新 に