SDK Capabilities and Entitlements
This page describes the relationship between currently public SDK Open capabilities and the VIP / SVIP / SVIP+ tiers. Modules without an explicit tier restriction are fully supported by default.
Authorization Model
| Item | Description |
|---|---|
| Offline SDK | Uses offline_api_key. After local machine activation, local capabilities are available. This mode is suitable for intranet, dedicated-machine, no-public-network, or fixed-machine deployments. |
| Online SDK | Uses online_api_key. The runtime interacts with authorization and quota services. This mode is suitable for online verification, online enhancement, and unified quota management. |
| VIP system | SDK capability tiers include VIP / SVIP / SVIP+. |
| CZUR-owned devices | CZUR-owned devices map to SVIP capabilities by default. |
VIP Entitlement Authorization
VIP features require commercial authorization. Before commercial authorization is granted, the related features are restricted and limited to 200 trial calls.
| Item | Contact |
|---|---|
| Business contact | sales@czur.com |
Full SDK Method Catalog
| Module | Methods | Support policy |
|---|---|---|
| system | system.ping, system.info, system.capabilities | Fully supported by default. No VIP-tier distinction. |
| auth | auth.create_session, auth.get_context, auth.refresh_session, auth.activate_offline, auth.destroy_session | Fully supported by default. No VIP-tier distinction. |
| device | device.list, device.get, device.open, device.close | Fully supported by default. No VIP-tier distinction. |
| video | video.start, video.stop, video.set_format, video.set_profile | Fully supported by default. No VIP-tier distinction. |
| capture | capture.take, capture.get, capture.session.get, capture.set_turn_detect | Fully supported by default. No VIP-tier distinction. |
| image | image.process, image.process_page, image.apply_color_mode, image.enhance_capabilities, image.enhance, image.enhance_get, image.enhance_cancel, image.enhance_workflow_list, image.enhance_workflow_get, image.enhance_workflow_save, image.enhance_workflow_delete | Some capabilities are restricted by VIP tier. |
| ocr | ocr.recognize, ocr.get, ocr.cancel, ocr.extract_text, recognition.barcode_detect | Some capabilities are restricted by VIP tier. |
| file | file.convert | Some capabilities are restricted by VIP tier. |
| sane | sane.status, sane.list, sane.watch_start, sane.watch_stop, sane.open, sane.close, sane.get_options, sane.set_options, sane.profile_list, sane.profile_save, sane.profile_apply, sane.profile_delete, sane.scan, sane.scan_get, sane.scan_cancel | Fully supported by default. No VIP-tier distinction. Linux Only. |
Tier Rules
The modules that need VIP capability distinctions are image, ocr, and file. Tiers from low to high are: Default < VIP < SVIP < SVIP+. “And above” means the specified tier and all higher tiers are supported.
Image Processing and Enhancement Module
| Capability | Default | VIP | SVIP | SVIP+ | Notes |
|---|---|---|---|---|---|
| Auto optimization | ✓ | ✓ | ✓ | ✓ | Automatically optimizes image color and quality. |
| Color enhancement | ✓ | ✓ | ✓ | ✓ | Enhances color rendering. |
| Black-and-white mode | ✓ | ✓ | ✓ | ✓ | Outputs a black-and-white result. |
| Grayscale mode | ✓ | ✓ | ✓ | ✓ | Outputs a grayscale result. |
| No optimization | ✓ | ✓ | ✓ | ✓ | Keeps the original image effect without optimization. |
| Single-image crop | ✓ | ✓ | ✓ | ✓ | Crops a single image. |
| Selected-area scan | ✓ | ✓ | ✓ | ✓ | Scans or crops by selected area. |
| Keep original image | ✓ | ✓ | ✓ | ✓ | Keeps the original image. |
| Auto rotation | ✗ | ✓ | ✓ | ✓ | Automatically detects orientation and rotates the page. |
| White-paper seal | ✗ | ✗ | ✓ | ✓ | White-paper seal mode. |
| Blank-page detection | ✗ | ✗ | ✓ | ✓ | Detects and marks blank pages. |
| Specification normalization | ✗ | ✗ | ✓ | ✓ | Normalizes pages to a specified size or specification. |
| Red/green header file | ✗ | ✗ | ✓ | ✓ | Red/green header file processing. |
| Ancient-book mode | ✗ | ✗ | ✗ | ✓ | Ancient-book image processing mode. |
| Hole filling | ✗ | ✗ | ✗ | ✓ | Detects and fills page holes. |
| Curved-book flattening | ✗ | ✗ | ✓ | ✓ | Flattens curved-book pages. |
| Document rectification | ✗ | ✗ | ✗ | ✓ | Online capability. |
| Document handwriting removal | ✗ | ✗ | ✗ | ✓ | Online capability. |
| Document image background removal | ✗ | ✗ | ✗ | ✓ | Online capability. |
| Image moire removal | ✗ | ✗ | ✗ | ✓ | Online capability. |
OCR and Recognition Module
| Capability | Default | VIP | SVIP | SVIP+ |
|---|---|---|---|---|
| Page text recognition | ✗ | ✓ | ✓ | ✓ |
| QR/barcode recognition | ✓ | ✓ | ✓ | ✓ |
File Module
| Capability | Default | VIP | SVIP | SVIP+ |
|---|---|---|---|---|
| Images to single-layer PDF | ✓ | ✓ | ✓ | ✓ |
| Images to single-layer OFD | ✓ | ✓ | ✓ | ✓ |
| Images to dual-layer PDF | ✗ | ✓ | ✓ | ✓ |
| Images to dual-layer OFD | ✗ | ✓ | ✓ | ✓ |
| Images to TXT | ✗ | ✓ | ✓ | ✓ |
| Images to JPG/PNG/BMP/TIF | ✗ | ✗ | ✓ | ✓ |