Top-level schema encompassing all request and response types exchanged between the wrapper plugin and the Anyline SDK during a scanning session.
General information to be used for SDK initialization.
Anyline license key to be used for SDK initialization.
Root folder path the SDK uses when resolving asset files. Leave empty to use the default asset location.
Optional cache settings applied during initialization.
Whether offline license caching is enabled.
Response containing SDK initialization result. Must include either failInfo (if initialization failed) or succeedInfo (if successful). The 'initialized' boolean indicates the overall status.
True if SDK initialization succeeded and scanning is available, false if initialization failed.
Populated when initialized is false. Contains the error that prevented SDK initialization.
The last error received while trying to initialize the SDK.
Populated when initialized is true. Contains license details from the successful initialization.
License expiry date in ISO 8601 format (YYYY-MM-DD).
Request to start a scanning session. Requires both scanViewConfigContentString (defining what to scan) and scanResultConfig (defining how to handle results). Optional scanViewInitializationParameters for workflow correlation.
ScanViewConfig JSON string defining the scanner configuration.
Configuration for how scan results are returned and stored during the session.
Deprecated. Used only by the legacy plugin. Custom callback method names for scan result and UI element click events.
Name of the callback method to invoke when scan results are available. Method will receive a list of ExportedScanResult as parameter.
Name of the callback method to invoke when user taps a UI feedback element during scanning. Method receives a UIFeedbackElementConfig as parameter.
Specifies how scan result images are delivered — either saved to a file path or encoded as base64 strings.
Deliver images as files saved to the specified directory path.
Directory path where scan result images are saved.
The image filenames saved in the specified path.
The full frame image captured at the moment of the scan result.
The cropped cutout image corresponding to the scanned region.
The face image extracted from the scanned document, if available.
Deliver images as base64-encoded strings embedded in the result JSON.
Output format and quality settings for scan result images.
Compression quality for exported images, from 1 (lowest) to 100 (highest).
Value must be greater or equal to 1 and lesser or equal to 100
Image format used when exporting scan result images.
Controls when previously generated result files are removed from storage.
Optional initialization parameters applied when the ScanView is created.
An optional uuid (v4) to correlate scans and data points within a workflow.
Must match regular expression:[[:xdigit:]]{8}(?:-[[:xdigit:]]{4}){3}-[[:xdigit:]]{12} Data contained within the QR code that's required to unlock scanning with the Showcase Apps.
^\d{4}-\d{2}-\d{2}$ Path relative to the assets folder used to resolve ScanViewConfig JSON files when a SegmentControl references them by filename.
Platform-specific options applied when starting a scan session.
Android-specific ScanView attributes for layout and behavior customization.
Enable or disable camera permission handling from ScanView loading process.
Enable or disable usage of CameraX API instead of Camera1 API. Default is true.
Request to stop the current scanning session with optional message explaining the reason for termination.
Optional message describing the reason for stopping the scan session.
Information about the results collected during the scanning process.
The result configuration that was active when these results were produced.
Same definition as scanResultConfigAdditional metadata about the source plugin that produced these results.
The type of the source ViewPlugin that generated result(s).
List of scan results produced in this scanning event, one per detected item.
No Additional ItemsA single scan result exported from the Anyline SDK, containing the plugin-specific result data together with the associated scan images.
The plugin-specific scan result produced by the Anyline SDK.
No Additional PropertiesThe blobKey (provided optionally, depending on the Anyline license settings)
The ID of the ScanPlugin that processed the result
The rect information of the region that was processed within the image
No Additional PropertiesThe X value
The Y value
The width
The height
Provides a general confidence value between 0 and 100 if applicable. -1 if no confidence was calculated
Value must be greater or equal to -1 and lesser or equal to 100
A unique UUIDv4 generated for each scan controller process run.
representing time measurements for different parts of the process.
The total duration of the scan controller process, in milliseconds
Describes result information of scanning barcodes
No Additional PropertiesContains a list of one or more barcodes found on the processed image
No Additional ItemsDescribes barcode information
No Additional PropertiesThe value of the barcode
The barcode format
Corner points of a polygon surrounding the discovered barcode, starting from the bottom-left coordinate going counter-clockwise. The coordinates are in reference to the image of the plugin result.
No Additional ItemsContains the base64-encoded value
Holds all encoded barcode information according to the AAMVA standard
Describes result information of scanning different kinds of IDs
No Additional PropertiesYields field information of the ID
No Additional PropertiesDescribes scanned parameters of an ID field
No Additional PropertiesDescribes the text values of an ID field
No Additional PropertiesThe text parameters
No Additional PropertiesThe text value
The confidence value
Value must be greater or equal to -1 and lesser or equal to 100
The text parameters
No Additional PropertiesThe text value
The confidence value
Value must be greater or equal to -1 and lesser or equal to 100
The text parameters
No Additional PropertiesThe text value
The confidence value
Value must be greater or equal to -1 and lesser or equal to 100
Describes the date value of an ID field
No Additional PropertiesThe year
The month
Value must be greater or equal to 1 and lesser or equal to 12
The day
Value must be greater or equal to 1 and lesser or equal to 31
The text value
The formatted text value
The confidence value
Value must be greater or equal to -1 and lesser or equal to 100
Information about the visualization data of the scanned ID
No Additional PropertiesThe found contours of the fields on the ID
No Additional ItemsAn array of integer values
Must contain a minimum of 4 items
Must contain a maximum of 4 items
The found contour points of the fields on the ID
No Additional ItemsAn array of contour points
No Additional ItemsAn array of integer values
Must contain a minimum of 2 items
Must contain a maximum of 2 items
The found bounding rect of the text fields on the ID
Must contain a minimum of 4 items
Must contain a maximum of 4 items
Describes result information of scanning vehicle registration certificates
No Additional PropertiesYields field information of the vehicle registration certificate
No Additional PropertiesDescribes scanned parameters of a vehicle registration certificate field
No Additional PropertiesThe text value
The confidence value
Value must be greater or equal to -1 and lesser or equal to 100
Describes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberDescribes scanned parameters of a vehicle registration certificate field
Same definition as documentNumberInformation about the visualization data of the scanned ID
Same definition as visualizationDescribes result information of scanning MRZ
No Additional PropertiesTrue if all check digits are valid
The DateOfBirth
The DateOfBirthObject
The DateOfExpiry
The DateOfExpiryObject
The DocumentNumber
The DocumentType
The IssuingCountryCode
The NationalityCountryCode
The Sex
The PersonalNumber
The CheckDigitDateOfExpiry
The CheckDigitDocumentNumber
The CheckDigitPersonalNumber
The CheckDigitDateOfBirth
The CheckDigitFinal
The MRZString
The Surname
The GivenNames
The FirstName
The LastName
The OptionalData
The Adress of the Visual Inspection Zone
The DateOfIssue of the Visual Inspection Zone
The DateOfIssueObject of the Visual Inspection Zone
The Surname of the Visual Inspection Zone
The GivenNames of the Visual Inspection Zone
The DateOfBirth of the Visual Inspection Zone
The DateOfBirthObject of the Visual Inspection Zone
The DateOfExpiry of the Visual Inspection Zone
The DateOfExpiryObject of the Visual Inspection Zone
The confidence values of each field
No Additional PropertiesThe confidence value of the field
Value must be greater or equal to -1 and lesser or equal to 100
Describes result information of scanning license plates
No Additional PropertiesThe country information
The area information
The plate text
(Optional) If vehicleInspectionSticker config is OPTIONAL, this is true if a Visual Inspection Sticker was found, false otherwise. If the config is MANDATORY, this field is always true.
(Optional) The year depicted on the Visual Inspection Sticker.
(Optional) The month depicted on the Visual Inspection Sticker.
(Optional) This is true, if the Visual Inspection Sticker depicts a date in the future.
Describes result information of scanning japanese landing permission tickets
No Additional PropertiesYields field information of a japanese landing permission ticket
No Additional PropertiesProvides result information for japanese landing permission fields
No Additional PropertiesThe text information of the field
The confidence information of the field
Value must be greater or equal to -1 and lesser or equal to 100
Provides result information for japanese landing permission fields
Same definition as airportProvides result information for japanese landing permission fields
Same definition as airportProvides result information for japanese landing permission fields
Same definition as airportProvides result information for japanese landing permission fields
Same definition as airportDescribes result information of scanning meters
No Additional PropertiesThe meter value.
The unit value. Only applicable for multi-field meter scanning.
The position. Only applicable for OBIS meters - see https://onemeter.com/docs/device/obis/
Describes result information of scanning odometers
No Additional PropertiesThe odometer value.
Describes result information of scanning general OCR
No Additional PropertiesThe OCR text value.
Describes result information of scanning tire identification numbers (TIN)
No Additional PropertiesThe TIN text value.
The production date on the TIN reformatted to YYYY/MM.
The computed tire age in years rounded down.
The TIN text split by context with spaces as delimiter.
Describes result information of scanning tire size specifications
No Additional PropertiesThe text value of the tire size field.
The confidence value of the tire size field.
Describes result information of scanning tire makes
No Additional PropertiesThe text value of the tire make
Describes result information of scanning commercial tire IDs
No Additional PropertiesThe text value of the commercial tire ID
Describes result information of scanning shipping containers
No Additional PropertiesThe text value of the shipping container
Describes result information of scanning vehicle identification numbers (VIN)
No Additional PropertiesThe VIN text value
Specifies how and where the scan result images are delivered.
Same definition as imageContainerOutput format and quality settings applied to all images exported with this scan result.
Same definition as imageParametersResponse indicating scan session completion status. Includes exactly one info object (failInfo, abortInfo, or succeedInfo) corresponding to the status field value.
The result configuration that was active during the completed scan session.
Same definition as scanResultConfigThe final status of the scan session.
Populated when status is scanFailed. Contains the error that caused the failure.
The last error received while trying to scan.
Populated when status is scanAborted. Contains the reason for the abort.
Optional message provided when the scan session was aborted.
Populated when status is scanSucceeded. Contains an optional completion message.
Optional informational message from the completed scan session.
UI configuration options for the scan view, controlling optional controls, orientation, and overlays.
Optional button that lets users toggle between portrait and landscape orientations.
Corner of the screen where the rotate button is positioned.
Optional pixel offset from the aligned corner position.
Horizontal offset in pixels. Positive values move the element right, negative values move it left.
Vertical offset in pixels. Positive values move the element down, negative values move it up.
Deprecated. iOS only. Static text label on the scan view. Use the Simple Instruction Label UI Feedback preset instead.
The text to display.
Hex color string for the label text.
The font size of the label.
Pixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Pixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Same definition as offset.xDeprecated. iOS only. Button that dismisses the scan view. Use toolbarTitle instead.
The text displayed for the button.
A color, denoted by a hex string of the button title.
A color, denoted by a hex string used by the button title when pressed.
A color, denoted by a hex string of the button background. The default is empty (clear color).
Button title font size in points (typically 8-72).
The name of the font (note: the font must be available for the device).
The preset locations for the button along the x-axis.
The preset locations for the button along the y-axis.
The preset used for width fill.
A Float value indicating the corner rounding of the Done button.
Pixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Same definition as offset.xPixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Same definition as offset.xInitial screen orientation when the scan view is presented.
Title shown on the toolbar with a back button. Fullscreen scanning only; ignored when using a ContainerView.
Optional multi-mode segment control for switching between scanning configurations.
Array of ScanView configuration filenames located in the assets folder. Each file defines a complete scanning mode configuration.
No Additional ItemsA JSON file located in the assets folder.
Array of display names for each scanning mode shown to users in the segment control.
No Additional ItemsA user-visible string corresponding to the mode.
Zero-based index indicating which segment should be initially selected. Must be within the bounds of the titles array.
Hex color code (e.g., 'FF0000' for red) applied to the selected segment and control tinting.
Pixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Same definition as offset.xPixel offset (positive or negative) for fine-tuning a UI element's position along one axis.
Same definition as offset.xRequest to submit a User Corrected Result (UCR) for a previously scanned item.
Unique identifier for the scan event, taken from PluginResult.blobKey. Used to correlate the correction with the original scan on the server.
The corrected result value to report.
Response from UCR (User Corrected Result) reporting. Must include either failInfo (if reporting failed) or succeedInfo (if successful), corresponding to the status field.
The final status of the UCR report submission.
Populated when status is ucrReportFailed. Contains the error details.
The last error received while reporting UCR.
The error code received while connecting to server.
The error message received while connecting to server.
Populated when status is ucrReportSucceeded. Contains the server confirmation message.
The confirmation message returned from the server.
Response from cached events export operation. Includes either failInfo (if export failed) or succeedInfo (if successful), corresponding to the status field.
The final status of the export operation.
Populated when status is exportFailed. Contains the error that caused the failure.
The last error received while exporting cached events.
Populated when status is exportSucceeded. Contains the path to the exported file.
Path to the generated file containing the exported cached events.