.. index:: 
  !Bioseal Class

.. _id3_bioseal_bioseal_class:

===============================================================================
Bioseal Class
===============================================================================

Namespace: :ref:`id3.Bioseal<reference_bioseal>`

.. toctree::
  :hidden:

  auxData<aux_data>
  biometricVerificationRules<biometric_verification_rules>
  buildHtmlView<build_html_view>
  buildVdsAsJson<build_vds_as_json>
  buildVdsAsXml<build_vds_as_xml>
  certificateAuthorityReference<certificate_authority_reference>
  certificateIdentifier<certificate_identifier>
  certificateInformation<certificate_information>
  clear<clear>
  clearDownloadCache<clear_download_cache>
  computeSha256<compute_sha256>
  containsAuxData<contains_aux_data>
  containsBiometrics<contains_biometrics>
  containsExtensions<contains_extensions>
  containsFaceTemplates<contains_face_templates>
  containsFingerTemplates<contains_finger_templates>
  containsImages<contains_images>
  containsPortraits<contains_portraits>
  data<data>
  decryptionCallback<decryption_callback>
  documentIssuingCountry<document_issuing_country>
  documentIssuingDate<document_issuing_date>
  documentScope<document_scope>
  documentType<document_type>
  expirationDate<expiration_date>
  extendedFormat<extended_format>
  externalResourceCallback<external_resource_callback>
  findBiometrics<find_biometrics>
  findFieldsByExtension<find_fields_by_extension>
  findFieldsByExtensionName<find_fields_by_extension_name>
  format<format>
  getDocumentDescription<get_document_description>
  getDocumentName<get_document_name>
  hasPrefix<has_prefix>
  headerVersion<header_version>
  htmlView<html_view>
  issuingAgencyCode<issuing_agency_code>
  log<log>
  lotlUrl<lotl_url>
  manifest<manifest>
  manifestId<manifest_id>
  manifestUrl<manifest_url>
  payload<payload>
  prefix<prefix>
  setTimeZoneOffset<set_time_zone_offset>
  signatureDate<signature_date>
  supportedLanguages<supported_languages>
  tslUrl<tsl_url>
  userAuthentication<user_authentication>
  verificationResult<verification_result>
  verifiesCrlUpdates<verifies_crl_updates>
  verifiesGovernance<verifies_governance>
  verifiesSignature<verifies_signature>
  verifyFromBuffer<verify_from_buffer>
  verifyFromString<verify_from_string>


Definition
----------
.. line-block::
    Represents a BioSeal code.


Properties
----------

.. list-table:: 
  :width: 100%
  :widths: 30 5 65
  :header-rows: 1

  * - Name
    - Type
    - Description
  * - :ref:`auxData<id3_bioseal_bioseal_aux_data_class_member>`
    - :ref:`Field<id3_bioseal_field_class>`
    - The auxiliary data containing additional information specific to the BioSeal.
  * - :ref:`biometricVerificationRules<id3_bioseal_bioseal_biometric_verification_rules_class_member>`
    - :ref:`BiometricVerificationRules<id3_bioseal_biometric_verification_rules_class>`
    - The list of biometric verification rules.
  * - :ref:`certificateAuthorityReference<id3_bioseal_bioseal_certificate_authority_reference_class_member>`
    - string
    - The issuing reference of the certificate authority.
  * - :ref:`certificateIdentifier<id3_bioseal_bioseal_certificate_identifier_class_member>`
    - string
    - The identifier of the certificate.
  * - :ref:`certificateInformation<id3_bioseal_bioseal_certificate_information_class_member>`
    - :ref:`CertificateInformation<id3_bioseal_certificate_information_class>`
    - The detailed certificate information.
  * - :ref:`containsAuxData<id3_bioseal_bioseal_contains_aux_data_class_member>`
    - bool
    - Indicates whether the BioSeal contains auxiliary data.
  * - :ref:`containsBiometrics<id3_bioseal_bioseal_contains_biometrics_class_member>`
    - bool
    - Indicates whether the BioSeal contains biometric data.
  * - :ref:`containsExtensions<id3_bioseal_bioseal_contains_extensions_class_member>`
    - bool
    - Indicates whether the BioSeal contains extensions.
  * - :ref:`containsFaceTemplates<id3_bioseal_bioseal_contains_face_templates_class_member>`
    - bool
    - Indicates whether the BioSeal contains face templates.
  * - :ref:`containsFingerTemplates<id3_bioseal_bioseal_contains_finger_templates_class_member>`
    - bool
    - Indicates whether the BioSeal contains finger templates.
  * - :ref:`containsImages<id3_bioseal_bioseal_contains_images_class_member>`
    - bool
    - Indicates whether the BioSeal contains images.
  * - :ref:`containsPortraits<id3_bioseal_bioseal_contains_portraits_class_member>`
    - bool
    - Indicates whether the BioSeal contains portraits.
  * - :ref:`data<id3_bioseal_bioseal_data_class_member>`
    - byte[]
    - The data of the VDS as a binary array.
  * - :ref:`decryptionCallback<id3_bioseal_bioseal_decryption_callback_class_member>`
    - :ref:`DecryptionCallbackHandler<id3_bioseal_decryption_callback_handler_callback>`
    - The callback used to decrypt a field.
  * - :ref:`documentIssuingCountry<id3_bioseal_bioseal_document_issuing_country_class_member>`
    - string
    - The identifier of the country issuing the document. For AFNOR XP Z42-101 only.
  * - :ref:`documentIssuingDate<id3_bioseal_bioseal_document_issuing_date_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The document issuing date.
  * - :ref:`documentScope<id3_bioseal_bioseal_document_scope_class_member>`
    - string
    - The identification code of the scope on which the document type is defined. For AFNOR XP Z42-101 only.
  * - :ref:`documentType<id3_bioseal_bioseal_document_type_class_member>`
    - string
    - The document type identification code. For AFNOR XP Z42-101 only.
  * - :ref:`expirationDate<id3_bioseal_bioseal_expiration_date_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The BioSeal expiration date.
  * - :ref:`extendedFormat<id3_bioseal_bioseal_extended_format_class_member>`
    - :ref:`BiosealFormat<id3_bioseal_bioseal_format_enum>`
    - The BioSeal format with prefix information.
  * - :ref:`externalResourceCallback<id3_bioseal_bioseal_external_resource_callback_class_member>`
    - :ref:`ResourceCallbackHandler<id3_bioseal_resource_callback_handler_callback>`
    - The callback used to retrieve an external resource (LoTL, TSL, certificate, manifest, CRL) with specified URI.
  * - :ref:`format<id3_bioseal_bioseal_format_class_member>`
    - :ref:`BiosealFormat<id3_bioseal_bioseal_format_enum>`
    - The BioSeal format without prefix information.
  * - :ref:`hasPrefix<id3_bioseal_bioseal_has_prefix_class_member>`
    - bool
    - Prefix is present.
  * - :ref:`headerVersion<id3_bioseal_bioseal_header_version_class_member>`
    - int
    - The header version.
  * - :ref:`htmlView<id3_bioseal_bioseal_html_view_class_member>`
    - string
    - The presentation view, in HTML format, created from the manifest and the data contained in the BioSeal.
  * - :ref:`issuingAgencyCode<id3_bioseal_bioseal_issuing_agency_code_class_member>`
    - string
    - The Issuing Agency Code (IAC). For ISO 22376:2023 format only.
  * - :ref:`log<id3_bioseal_bioseal_log_class_member>`
    - :ref:`Log<id3_bioseal_log_class>`
    - The log.
  * - :ref:`lotlUrl<id3_bioseal_bioseal_lotl_url_class_member>`
    - string
    - The URL to the LoTL (List of Trust List).
  * - :ref:`manifest<id3_bioseal_bioseal_manifest_class_member>`
    - :ref:`Manifest<id3_bioseal_manifest_class>`
    - The manifest information.
  * - :ref:`manifestId<id3_bioseal_bioseal_manifest_id_class_member>`
    - int
    - The manifest ID in ISO 22385 format.
  * - :ref:`manifestUrl<id3_bioseal_bioseal_manifest_url_class_member>`
    - string
    - The URL to the manifest.
  * - :ref:`payload<id3_bioseal_bioseal_payload_class_member>`
    - :ref:`Field<id3_bioseal_field_class>`
    - The payload containing the data specific to the BioSeal.
  * - :ref:`prefix<id3_bioseal_bioseal_prefix_class_member>`
    - string
    - The prefix.
  * - :ref:`signatureDate<id3_bioseal_bioseal_signature_date_class_member>`
    - :ref:`DateTime<id3_bioseal_date_time_class>`
    - The BioSeal signature date.
  * - :ref:`supportedLanguages<id3_bioseal_bioseal_supported_languages_class_member>`
    - :ref:`StringArray<id3_bioseal_string_array_class>`
    - The list of supported languages declared in the manifest.
  * - :ref:`tslUrl<id3_bioseal_bioseal_tsl_url_class_member>`
    - string
    - The URL to the TSL (Trust Service List).
  * - :ref:`userAuthentication<id3_bioseal_bioseal_user_authentication_class_member>`
    - :ref:`UserAuthentication<id3_bioseal_user_authentication_class>`
    - The user authentication parameters.
  * - :ref:`verificationResult<id3_bioseal_bioseal_verification_result_class_member>`
    - :ref:`VerificationResult<id3_bioseal_verification_result_struct>`
    - The last verification result.
  * - :ref:`verifiesCrlUpdates<id3_bioseal_bioseal_verifies_crl_updates_class_member>`
    - bool
    - Indicates whether the verification process should verify the next CRL update.
  * - :ref:`verifiesGovernance<id3_bioseal_bioseal_verifies_governance_class_member>`
    - bool
    - Indicates whether the governance certification chain is verified.
  * - :ref:`verifiesSignature<id3_bioseal_bioseal_verifies_signature_class_member>`
    - bool
    - Indicates whether the VDS signature is verified.

Static Methods
--------------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`computeSha256<id3_bioseal_bioseal_compute_sha256_class_method>`
    - Computes SHA256.

Methods
-------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`buildHtmlView<id3_bioseal_bioseal_build_html_view_class_method>`
    - Builds the presentation view, in HTML format.
  * - :ref:`buildVdsAsJson<id3_bioseal_bioseal_build_vds_as_json_class_method>`
    - Builds a representation of the VDS, in JSON format.
  * - :ref:`buildVdsAsXml<id3_bioseal_bioseal_build_vds_as_xml_class_method>`
    - Builds a representation of the VDS, in a XML format.
  * - :ref:`clear<id3_bioseal_bioseal_clear_class_method>`
    - Clears all internal data.
  * - :ref:`clearDownloadCache<id3_bioseal_bioseal_clear_download_cache_class_method>`
    - Clears the internal download cache.
  * - :ref:`findBiometrics<id3_bioseal_bioseal_find_biometrics_class_method>`
    - Finds the biometric field in payload.
  * - :ref:`findFieldsByExtension<id3_bioseal_bioseal_find_fields_by_extension_class_method>`
    - Finds fields by extension type.
  * - :ref:`findFieldsByExtensionName<id3_bioseal_bioseal_find_fields_by_extension_name_class_method>`
    - Finds fields by extension name.
  * - :ref:`getDocumentDescription<id3_bioseal_bioseal_get_document_description_class_method>`
    - Gets the description of the document.
  * - :ref:`getDocumentName<id3_bioseal_bioseal_get_document_name_class_method>`
    - Gets the name of the document.
  * - :ref:`setTimeZoneOffset<id3_bioseal_bioseal_set_time_zone_offset_class_method>`
    - Sets the time zone offset in seconds.
  * - :ref:`verifyFromBuffer<id3_bioseal_bioseal_verify_from_buffer_class_method>`
    - Decodes and verifies the specified data buffer.
  * - :ref:`verifyFromString<id3_bioseal_bioseal_verify_from_string_class_method>`
    - Decodes and verifies the specified string buffer.
