Quick start

What you will build

Capture both document sides, review extracted information and release the camera safely. Start with SENSE for functional OCR evaluation. GUARD and SHIELD have separate capability and qualification requirements.

1. Create your workspace

1. Create an account and save the recovery codes in a password manager.
2. Confirm your email using the link sent to your inbox while signed in to the matching account.
3. Activate the edition evaluation you need. Evaluations last 14 days and do not require payment details.

2. Configure your project

Record the edition, application hostname and deployment environment. Keep development, staging and production configurations distinct. A project labelled Production does not issue a production license.

3. Validate the hosted workflow

1. Open Test Studio and choose the edition matching your evaluation.
2. Allow camera permission and keep the complete front side inside the guide.
3. Wait for reading to finish, turn the document over and select Scan back.
4. Review the result. Use the rescan action for corrections. Stop the camera when leaving the workflow.

4. Run the downloadable example

1. Download the evaluation SDK and the browser example while signed in with an active evaluation.
2. Extract both archives into the same empty project directory. The SDK files must be inside sdk/0.2.0/.
3. Run a local HTTP server using the command below and open http://localhost:8080 in a supported browser.
4. Select Start camera. For remote devices, serve the project over HTTPS; another device cannot use your computer localhost address.

python -m http.server 8080

5. Connect your application

The skeleton below shows the reader lifecycle. The downloadable example also implements front-to-back handoff, cancellation, rescanning and background-tab cleanup. Keep identity information out of logs and analytics. Apply your application review and authorization policy separately from OCR.

const options = {
  edition: 'SENSE',
  recognizer: 'document-aware-onnx',
  recognitionPolicy: 'required-fields',
  acceptanceMode: 'development',
  assetBaseUrl: new URL('./sdk/0.2.0/', location.href).href,
  preview: document.querySelector('video'),
  manualCaptureEnabled: false,
  serverFallbackEnabled: false,
};

// Prepare runtime assets before the user chooses Start camera.
await CEBSIDReaderWeb.CEBSIDReader.preload(options);
const reader = await CEBSIDReaderWeb.CEBSIDReader.create(options);

// Call from an explicit user action. Always release the camera.
try {
  await reader.startCamera();
  const result = await reader.scanDocument();
  await presentForReview(result);
} finally {
  await reader.dispose();
}

6. Complete release review

Test every target document generation, language, device and camera. Measure warm and cold startup, reading latency and failure recovery on representative hardware. Agree commercial licensing, data handling and support before production. Unqualified originality and fraud checks must not approve registration.