Browser SDK API reference
Lifecycle methods verified against the current 0.2.0 development SDK.
Create and prepare
| Method | Contract |
|---|---|
| CEBSIDReader.preload(options) | Prepare a reusable runtime without requesting camera access. Returns a promise. |
| CEBSIDReader.create(options) | Create a reader or take ownership of its prepared runtime. Returns a promise. |
| CEBSIDReader.releasePreload(options) | Release unused prepared resources matching this configuration. |
| reader.initialize() | Initialize feature checks, worker and runtime assets; normally handled by camera startup. |
Capture lifecycle
| Method | Usage |
|---|---|
| startCamera(video) | Request camera access and start preview. Defaults to the configured preview element. |
| scanDocument() | Wait for the two-sided workflow and return its result. Handle rejection and cancellation. |
| setCapturePaused(boolean) | Pause sampling during a user-controlled front-to-back handoff. |
| getCapturedImage(side) | Return the captured image for front or back, or null. Keep it private. |
| rescanCurrentSide() | Restart the active side. For correcting a completed result, dispose and create a fresh reader. |
| stopCamera() | Stop the current camera stream. |
| dispose() | Stop capture and release the worker and reader resources. |
Integration options
| Option | Guidance |
|---|---|
| edition | SENSE, GUARD or SHIELD. Availability and entitlements are edition specific. |
| assetBaseUrl | Same-origin versioned SDK asset directory. |
| preview | Video element with autoplay, muted and playsinline attributes. |
| recognizer | document-aware-onnx for the current document-aware evaluation workflow. |
| recognitionPolicy | required-fields for SENSE; strict for advanced edition workflows. |
| acceptanceMode | development for evaluation. Changing this value does not qualify a model. |
| preloadRecognition | Prepare OCR while the user positions the document. |
| onEvent | Receive diagnostic and workflow metadata. |
| onFrontResult | Receive provisional extraction results privately. |
| serverFallbackEnabled | Leave false unless a separate approved fallback policy is integrated. |
Camera controls
getCameraControls reports supported controls. setTorch requests a supported torch setting; it cannot create hardware support. setImageMirrored changes image orientation for recognition and must not be used as a cosmetic substitute for the correct capture orientation. Test any orientation control with the actual device and both sides of the document.
Advanced assessment
Guided presentation capture, evidence aggregation and fraud assessment depend on edition entitlements, qualified models and an approved evidence-trust architecture. The basic browser example does not grant these capabilities. Use the current SDK contracts supplied for the approved integration and preserve unavailable or inconclusive outcomes when evidence is missing.