Readonly BarcodeOptional acceptedFormats: BarcodeDocumentFormat[]The configuration to use for the barcode document parser.
Checks if the BarcodeDocumentParser API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly BarcodeInitialize the barcode scanner.
Optional configuration: { The configuration to use for the barcode scanner.
Optional accumulationConfiguration to accumulate barcodes across multiple frames in live mode.
new BarcodeAccumulationConfiguration({});
Optional barcodeOptions for barcode decoding.
[new BarcodeFormatCommonConfiguration({})];
Optional directIn single-shot mode, if the combined area of detected barcodes exceeds this fraction of the input image, the scanner returns the result immediately. Further scanning is skipped, even if more barcodes may be present. This can be used to accelerate scanning when barcode sizes are known in advance. To disable this behaviour, the value must be set to 1.0.
0.8;
Optional engineThe engine mode for barcode scanning.
"NEXT_GEN_LOW_POWER";
Optional extractedList of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC", "BRITISH_COLUMBIA_DRIVER_LICENSE"];
Optional onlyIf true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
false;
Optional optimizedIf true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
false;
Optional processingScanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
"AUTO";
Optional returnIf true, the barcode image will be returned in the BarcodeItem.
false;
Checks if the BarcodeScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly CheckInitialize the check scanner.
Optional configuration: { The configuration to use for the check scanner.
Optional acceptedAccepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
[];
Optional documentDocument detection to be performed in addition to scanning the machine-readable data in the check.
By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.
If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.
"DISABLED";
Optional processingScanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
"AUTO";
Checks if the CheckScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly CreditInitialize the credit card scanner.
Optional configuration: { The configuration to use for the scanner.
Optional processingScanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
"AUTO";
Optional requireWhether the cardholder name is required for a successful scan.
true;
Optional requireWhether the expiry date is required for a successful scan.
true;
Optional resultConfiguration for how to accumulate results.
new ResultAccumulationConfiguration({});
Optional returnIf true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
false;
Optional useIf true, the document detector will be used to find where the credit card is in the input image. If false, the scanner will assume that the credit card has been pre-cropped and takes the entirety of the input image.
true;
Checks if the CreditCardScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly DocumentInitialize the document classifier.
The configuration to use for the classifier.
Optional Readonly crop?: booleanIf true, image will be scanned for a valid document first.
true;
Checks if the DocumentClassifier API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly DocumentInitialize the document data extractor.
Optional configuration: { The configuration to use for the recognizer.
Optional configurations?: ({ List of configuration elements for the document data extractor.
[new DocumentDataExtractorCommonConfiguration({})];
Optional documentLevel of trust in the authenticity of the extracted document.
"TRUSTED";
Optional fieldNormalized names of the fields to exclude from the result.
[];
Optional processingScanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
"AUTO";
Optional resultConfiguration for how to accumulate results.
new ResultAccumulationConfiguration({});
Optional returnIf true, crops of the detected documents and fields will be returned in the result.
false;
Checks if the DocumentDataExtractor API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly DocumentInitialize the document enhancer.
Checks if the DocumentEnhancer API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Check if the specified straightening mode is available (i.e. required assets are present).
The straightening mode to check.
True if the straightening mode is available, false otherwise.
Readonly DocumentInitialize the document quality analyzer.
Optional configuration: { The configuration to use for the document quality analyzer.
Optional compatibilityCompatibility mode for the Document Quality Analyzer. If set, the analyzer will return results that are identical to older versions of the SDK.
null;
Optional inputIf inputScale from inputScales is smaller or equal than the threshold minProcessedFraction and maxProcessedFraction will be ignored, and the entire image will be processed.
0.25;
Optional inputRuns the Document Quality Analyzer on the listed inputScales. Only the best result will be returned. Typical range of the text height, which model can work with, is 5-40 pixels. 10 pixels height is recommended. Use this option if documents with smaller or bigger texts are expected. For example, if 80 pixels text height is expected, scale should be 1/8. Not compatible with maxImageSize. If not [1] maxImageSize should be less or equal 0.
[1.0];
Optional maxMaximum image size in pixels, if image is bigger, it will be resized. If less or equal 0 will be ignored.
2000;
Optional minIf a document's estimated number of symbols is less than this value, document quality will be reported as UNCERTAIN.
In that case, the deprecated result fields documentFound andqualityLevel will be set to false and empty, respectively.
20;
Optional minIf detectOrientation is True, minNumberOfRequiredSymbols is found, and orientationConfidence is bigger than this threshold, the processing stops. If the maxProcessedFraction part of the image is processed and orientationConfidence is lower than the threshold, the returned orientation will be 0.
0.9;
Optional processConfiguration for processing image by tiles.
new ProcessByTileConfiguration({});
Optional qualityThere are documents for which the quality analysis model is uncertain, meaning that the model is not sure if the document is acceptable or not.
E.g., the model may report a document quality to be ACCEPTABLE with 60% confidence.
Depending on the value of this threshold, the document in this case will be reported as ACCEPTABLE or UNCERTAIN.
The default value of 0.5 will typically lead to a good balance between the number of documents reported as ACCEPTABLE and UNCERTAIN.
A lower value will lead to fewer UNCERTAIN documents, but unacceptable documents will more often be reported as ACCEPTABLE (false positives).
A higher value will lead to more borderline documents being reported as UNCERTAIN, but unacceptable documents will be reported as ACCEPTABLE less often.
If 0, no documents with a predicted quality of ACCEPTABLE will be reported as UNCERTAIN, regardless of the model's confidence, unless the document has very few symbols (see minEstimatedNumberOfSymbolsForDocument).
If 1, almost all documents with a predicted quality of ACCEPTABLE will be reported as UNCERTAIN.
Must be in the range of [0, 1].
0.5;
Optional qualityDocument quality analysis model to use. If empty, the built-in model is used which provides reasonable quality estimates for a wide variety of documents. If the built-in model is not a good fit for your use case, consider creating a model based on your own documents and use case.
To create a fine-tuned quality analysis model, follow the documentation of our DoQA model configurator tool. You can find it here: https://github.com/doo/scanbot-sdk-doqa-configurator.
"";
Optional qualityDeprecated, please use qualityAnalysisModel instead.
Quality levels.
["VERY_POOR", "POOR", "REASONABLE", "GOOD", "EXCELLENT"];
Optional qualityDeprecated, please use qualityAnalysisModel instead.
Quality thresholds to separate quality levels.
[new DocumentQualityThreshold({
"symbolQuality": 0.5,
"symbolRatio": 0.5
}), new DocumentQualityThreshold({
"symbolQuality": 0.7,
"symbolRatio": 0.3
}), new DocumentQualityThreshold({
"symbolQuality": 0.85,
"symbolRatio": 0.3
}), new DocumentQualityThreshold({
"symbolQuality": 0.9,
"symbolRatio": 0.1
})];
Optional qualitySame as qualityAcceptableUncertainThreshold, but for documents that are predicted to be UNACCEPTABLE by the model.
0.5;
Optional returnIf true, will return the quality heatmap as a part of the result. In this case, the entire image will be processed and the minProcessedFraction will be ignored. Useful for debugging situations where the returned quality doesn't appear to match the perceived quality.
false;
Checks if the DocumentQualityAnalyzer API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly DocumentInitialize the document detector.
Optional configuration: { The configuration for the document detector.
Optional engineThe engine to use for document scanning.
"ML";
Optional parameters?: { acceptedAngleScore?: number; acceptedSizeScore?: number; acceptedBrightnessThreshold?: number; acceptedAspectRatioScore?: number; aspectRatios?: { readonly width?: number; readonly height?: number; }[]; ignoreOrientationMismatch?: boolean; alreadyCroppedScoreThreshold?: number; }Initial parameters for the document scanner.
new DocumentScannerParameters({});
Optional partiallyConfiguration for handling partially visible documents.
Has an effect only:
new PartiallyVisibleDocumentConfiguration({});
Optional processingIn live mode, the document scanner will return only the best document contour. In single-shot mode it will return additional document contours, suitable for use in the cropping screen.
"AUTO";
Checks if the DocumentScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly ImageInitialize the image processor.
Checks if the ImageManipulator API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly ImageInitialize the image processor.
Checks if the ImageProcessor API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly MrzInitialize the MRZ parser.
Optional configuration: { The configuration to use for the parser.
Optional incompleteDefines how to handle incomplete MRZ results (e.g. caused by failed validation).
"ACCEPT";
Checks if the MrzParser API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly MrzInitialize the MRZ scanner.
Optional configuration: { The configuration to use for the scanner.
Optional enableEnable MRZ detection. If disabled, the scanner skips the detection step and assumes that the input image is a crop of the MRZ area.
true;
Optional frameConfigure the frame accumulation process.
new AccumulatedResultsVerifierConfiguration({});
Optional incompleteDefines how to handle incomplete MRZ results (e.g. caused by failed validation).
"REJECT";
Optional processingScanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
"AUTO";
Optional returnIf true, crops of the detected MRZ and its fields will be returned in the result.
false;
Checks if the MrzScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly OcrChecks if the OcrEngine API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly TextInitialize the generic text line scanner.
Optional configuration: { The configuration to use for the generic text line scanner.
Optional maximumMaximum number of accumulated frames to inspect before actual result is returned.
3;
Optional minimumMinimum number of accumulated frames that have equal result.
2;
Optional ocrMaximum image size (height or width) for OCR process. 0 - do not rescale.
0;
Optional optimizeOptimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.
false;
Optional validator?: { Content validator.
new DefaultContentValidator({});
Checks if the TextPatternScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Readonly VinInitialize the VIN scanner.
Optional configuration: { The configuration to use for the VIN scanner.
Optional extractVINFromIf true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.
false;
Optional maximumMaximum number of accumulated frames to inspect before actual result is returned.
3;
Optional minimumMinimum number of accumulated frames that have equal result.
2;
Optional ocrMaximum image size (height or width) for OCR process. 0 - do not rescale.
0;
Optional optimizeOptimize for scanning a single line or a single word. Enable this option when scanning a single line or single word that are hard to scan reliably.
true;
Checks if the VinScanner API is available in the current WASM flavor.
If this returns false, attempting to use any other method on this API will result in an error being thrown.
In this case, adjust the enginePath parameter during initialization to point to a WASM flavor that supports this API.
For more information see Web SDK initialization section on https://docs.scanbot.io
Generated using TypeDoc
Initialize the barcode document parser.