.. _reference_bioseal:

===============================================================================
Bioseal API
===============================================================================

.. toctree::
  :hidden:

  BarcodeReader<barcode_reader/barcode_reader>
  BiometricDataType<biometric_data_type/biometric_data_type>
  BiometricVerificationRule<biometric_verification_rule/biometric_verification_rule>
  BiometricVerificationRules<biometric_verification_rules/biometric_verification_rules>
  Bioseal<bioseal/bioseal>
  BiosealError<bioseal_error/bioseal_error>
  BiosealException<bioseal_exception/bioseal_exception>
  BiosealFormat<bioseal_format/bioseal_format>
  BiosealLibrary<bioseal_library/bioseal_library>
  BiosealLicense<bioseal_license/bioseal_license>
  CertificateExtension<certificate_extension/certificate_extension>
  CertificateExtensionList<certificate_extension_list/certificate_extension_list>
  CertificateInformation<certificate_information/certificate_information>
  DateTime<date_time/date_time>
  DateTimeArray<date_time_array/date_time_array>
  DecryptionArgs<decryption_args/decryption_args>
  DecryptionCallbackHandler<decryption_callback_handler/decryption_callback_handler>
  Extension<extension/extension>
  ExtensionList<extension_list/extension_list>
  Field<field/field>
  FieldExtensionType<field_extension_type/field_extension_type>
  FieldList<field_list/field_list>
  FieldType<field_type/field_type>
  LibVersion<lib_version/lib_version>
  LicenseError<license_error/license_error>
  LicenseHardwareCodeType<license_hardware_code_type/license_hardware_code_type>
  LicenseType<license_type/license_type>
  Log<log/log>
  LogItem<log_item/log_item>
  LogItemType<log_item_type/log_item_type>
  Lotl<lotl/lotl>
  Manifest<manifest/manifest>
  ResourceCallbackArgs<resource_callback_args/resource_callback_args>
  ResourceCallbackHandler<resource_callback_handler/resource_callback_handler>
  ResourceType<resource_type/resource_type>
  StringArray<string_array/string_array>
  UserAuthentication<user_authentication/user_authentication>
  UserAuthenticationMethod<user_authentication_method/user_authentication_method>
  VerificationResult<verification_result/verification_result>
  VisibilityCondition<visibility_condition/visibility_condition>


Classes
-------

.. list-table:: 
  :width: 100%
  :widths: 30 70

  * - :ref:`BarcodeReader<id3_bioseal_barcode_reader_class>`
    - 
     | Provides functionality to decode barcodes from raw image data.

  * - :ref:`BiometricVerificationRule<id3_bioseal_biometric_verification_rule_class>`
    - 
     | Represents a biometric verification rule.

  * - :ref:`BiometricVerificationRules<id3_bioseal_biometric_verification_rules_class>`
    - 
     | Represents a list of biometric verification rules.

  * - :ref:`Bioseal<id3_bioseal_bioseal_class>`
    - 
     | Represents a BioSeal code.

  * - :ref:`BiosealLibrary<id3_bioseal_bioseal_library_class>`
    - 
     | Provides essential methods for initializing the SDK and accessing version information.

  * - :ref:`BiosealLicense<id3_bioseal_bioseal_license_class>`
    - 
     | Handles the license to use this SDK.

  * - :ref:`CertificateExtension<id3_bioseal_certificate_extension_class>`
    - 
     | Information about a certificate extension.

  * - :ref:`CertificateExtensionList<id3_bioseal_certificate_extension_list_class>`
    - 
     | Represents a list of certificate extensions.

  * - :ref:`CertificateInformation<id3_bioseal_certificate_information_class>`
    - 
     | Represents the information about a certificate.

  * - :ref:`DateTime<id3_bioseal_date_time_class>`
    - 
     | Represents a date/time.

  * - :ref:`DateTimeArray<id3_bioseal_date_time_array_class>`
    - 
     | Represents an array of DateTime objects.

  * - :ref:`DecryptionArgs<id3_bioseal_decryption_args_class>`
    - 
     | Represents the arguments to the decryption callback.

  * - :ref:`Extension<id3_bioseal_extension_class>`
    - 
     | Represents an extension.

  * - :ref:`ExtensionList<id3_bioseal_extension_list_class>`
    - 
     | Represents a list of extensions.

  * - :ref:`Field<id3_bioseal_field_class>`
    - 
     | Represents a field or a dictionary of fields.

  * - :ref:`FieldList<id3_bioseal_field_list_class>`
    - 
     | Represents a list of Field objects.

  * - :ref:`Log<id3_bioseal_log_class>`
    - 
     | Represents the log.

  * - :ref:`LogItem<id3_bioseal_log_item_class>`
    - 
     | Represents a log item.

  * - :ref:`Lotl<id3_bioseal_lotl_class>`
    - 
     | Provides information about the LoTL (List of Trust List).

  * - :ref:`Manifest<id3_bioseal_manifest_class>`
    - 
     | Provides information about the manifest.

  * - :ref:`ResourceCallbackArgs<id3_bioseal_resource_callback_args_class>`
    - 
     | Contains resource callback data.

  * - :ref:`StringArray<id3_bioseal_string_array_class>`
    - 
     | Represents an array of strings.

  * - :ref:`UserAuthentication<id3_bioseal_user_authentication_class>`
    - 
     | Represents the user authentication parameters.


Enumerations
------------

.. list-table:: 
  :width: 100%
  :widths: 30,70

  * - :ref:`BiometricDataType<id3_bioseal_biometric_data_type_enum>`
    - 
     | Enumerates the supported biometric data types.

  * - :ref:`BiosealError<id3_bioseal_bioseal_error_enum>`
    - 
     | Enumerates the error codes.

  * - :ref:`BiosealFormat<id3_bioseal_bioseal_format_enum>`
    - 
     | Enumerates the BioSeal formats.

  * - :ref:`FieldExtensionType<id3_bioseal_field_extension_type_enum>`
    - 
     | Enumerates the field extension types.

  * - :ref:`FieldType<id3_bioseal_field_type_enum>`
    - 
     | Enumerates the field types present in the payload.

  * - :ref:`LicenseError<id3_bioseal_license_error_enum>`
    - 
     | Enumerates the error codes related to license management.

  * - :ref:`LicenseHardwareCodeType<id3_bioseal_license_hardware_code_type_enum>`
    - 
     | Enumerates the types of hardware codes.

  * - :ref:`LicenseType<id3_bioseal_license_type_enum>`
    - 
     | Enumerates the license types.

  * - :ref:`LogItemType<id3_bioseal_log_item_type_enum>`
    - 
     | Enumerates the log item types.

  * - :ref:`ResourceType<id3_bioseal_resource_type_enum>`
    - 
     | Enumerates the resource type for resource callback args.

  * - :ref:`UserAuthenticationMethod<id3_bioseal_user_authentication_method_enum>`
    - 
     | Enumerates the user authentication methods.

  * - :ref:`VisibilityCondition<id3_bioseal_visibility_condition_enum>`
    - 
     | Enumerates the visibility conditions.
     | Note: The optional visibility condition extension indicates under which condition the presentation view or certain field in the presentation view should be displayed.


Structures
----------

.. list-table:: 
  :width: 100%
  :widths: 30,70

  * - :ref:`LibVersion<id3_bioseal_lib_version_struct>`
    - 
     | Contains data for LibVersion

  * - :ref:`VerificationResult<id3_bioseal_verification_result_struct>`
    - 
     | Contains data for VerificationResult


Callbacks
---------

.. list-table:: 
  :width: 100%
  :widths: 30,70

  * - :ref:`DecryptionCallbackHandler<id3_bioseal_decryption_callback_handler_callback>`
    - 
     | Represents the method that will handle a decryption callback.

  * - :ref:`ResourceCallbackHandler<id3_bioseal_resource_callback_handler_callback>`
    - 
     | Represents the method that will handle a resource callback.



Exceptions
----------

.. list-table:: 
  :width: 100%
  :widths: 30,70

  * - :ref:`BiosealException<id3_bioseal_bioseal_exception>`
    - This exception is thrown when an error occurs in the id3 Bioseal library.
