onfido-python 3.1.0__py3-none-any.whl → 3.3.0__py3-none-any.whl

onfido/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.1.0"
+__version__ = "3.3.0"
 
 # import apis into sdk package
 from onfido.api.default_api import DefaultApi

onfido/api/default_api.py

@@ -5359,6 +5359,287 @@ class DefaultApi:
 
 
 
+    @validate_call
+    def download_qes_document(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> bytearray:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def download_qes_document_with_http_info(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[bytearray]:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def download_qes_document_without_preload_content(
+        self,
+        workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")],
+        file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")],
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Retrieves the signed document or application form
+
+        Retrieves the signed document or application form depending on the file_id provided. 
+
+        :param workflow_run_id: The unique identifier of the Workflow Run for which you want to retrieve the signed document. (required)
+        :type workflow_run_id: str
+        :param file_id: The unique identifier of the file which you want to retrieve. (required)
+        :type file_id: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._download_qes_document_serialize(
+            workflow_run_id=workflow_run_id,
+            file_id=file_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '302': None,
+            '200': "bytearray",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _download_qes_document_serialize(
+        self,
+        workflow_run_id,
+        file_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if workflow_run_id is not None:
+            
+            _query_params.append(('workflow_run_id', workflow_run_id))
+            
+        if file_id is not None:
+            
+            _query_params.append(('file_id', file_id))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/pdf', 
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/qualified_electronic_signature/documents',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def download_signed_evidence_file(
         self,

onfido/api_client.py

@@ -88,7 +88,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'onfido-python/3.1.0'
+        self.user_agent = 'onfido-python/3.3.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

onfido/configuration.py

@@ -383,7 +383,7 @@ conf = onfido.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3.6\n"\
-               "SDK Package Version: 3.1.0".\
+               "SDK Package Version: 3.3.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

onfido/models/document.py

@@ -48,8 +48,8 @@ class Document(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['jpg', 'png', 'pdf']):
-            raise ValueError("must be one of enum values ('jpg', 'png', 'pdf')")
+        if value not in set(['jpg', 'jpeg', 'png', 'pdf']):
+            raise ValueError("must be one of enum values ('jpg', 'jpeg', 'png', 'pdf')")
         return value
 
     @field_validator('side')

onfido/models/document_properties.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from datetime import date
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
@@ -36,12 +36,14 @@ class DocumentProperties(BaseModel):
     """ # noqa: E501
     date_of_birth: Optional[date] = None
     date_of_expiry: Optional[date] = None
+    personal_number: Optional[StrictStr] = None
     document_numbers: Optional[List[DocumentPropertiesDocumentNumbersInner]] = None
     document_type: Optional[StrictStr] = None
     first_name: Optional[StrictStr] = None
+    middle_name: Optional[StrictStr] = None
+    last_name: Optional[StrictStr] = None
     gender: Optional[StrictStr] = None
     issuing_country: Optional[StrictStr] = None
-    last_name: Optional[StrictStr] = None
     nationality: Optional[StrictStr] = None
     issuing_state: Optional[StrictStr] = None
     issuing_date: Optional[date] = None
@@ -55,7 +57,22 @@ class DocumentProperties(BaseModel):
     widow_name: Optional[StrictStr] = None
     alias_name: Optional[StrictStr] = None
     issuing_authority: Optional[StrictStr] = None
+    remarks: Optional[StrictStr] = None
+    civil_state: Optional[StrictStr] = None
+    expatriation: Optional[StrictStr] = None
+    father_name: Optional[StrictStr] = None
+    mother_name: Optional[StrictStr] = None
+    religion: Optional[StrictStr] = None
+    type_of_permit: Optional[StrictStr] = None
+    version_number: Optional[StrictStr] = None
+    document_subtype: Optional[StrictStr] = None
+    profession: Optional[StrictStr] = None
+    security_document_number: Optional[StrictStr] = None
+    tax_number: Optional[StrictStr] = None
+    nist_identity_evidence_strength: Optional[StrictStr] = None
+    has_issuance_confirmation: Optional[StrictStr] = None
     real_id_compliance: Optional[StrictBool] = None
+    security_tier: Optional[StrictStr] = None
     address_lines: Optional[DocumentPropertiesAddressLines] = None
     barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
     nfc: Optional[DocumentPropertiesNfc] = None
@@ -63,7 +80,37 @@ class DocumentProperties(BaseModel):
     document_classification: Optional[DocumentPropertiesDocumentClassification] = None
     extracted_data: Optional[DocumentPropertiesExtractedData] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "document_numbers", "document_type", "first_name", "gender", "issuing_country", "last_name", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "real_id_compliance", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data"]
+    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data"]
+
+    @field_validator('nist_identity_evidence_strength')
+    def nist_identity_evidence_strength_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength']):
+            raise ValueError("must be one of enum values ('superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength')")
+        return value
+
+    @field_validator('has_issuance_confirmation')
+    def has_issuance_confirmation_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['true', 'false', 'unspecified']):
+            raise ValueError("must be one of enum values ('true', 'false', 'unspecified')")
+        return value
+
+    @field_validator('security_tier')
+    def security_tier_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier']):
+            raise ValueError("must be one of enum values ('tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -154,12 +201,14 @@ class DocumentProperties(BaseModel):
         _obj = cls.model_validate({
             "date_of_birth": obj.get("date_of_birth"),
             "date_of_expiry": obj.get("date_of_expiry"),
+            "personal_number": obj.get("personal_number"),
             "document_numbers": [DocumentPropertiesDocumentNumbersInner.from_dict(_item) for _item in obj["document_numbers"]] if obj.get("document_numbers") is not None else None,
             "document_type": obj.get("document_type"),
             "first_name": obj.get("first_name"),
+            "middle_name": obj.get("middle_name"),
+            "last_name": obj.get("last_name"),
             "gender": obj.get("gender"),
             "issuing_country": obj.get("issuing_country"),
-            "last_name": obj.get("last_name"),
             "nationality": obj.get("nationality"),
             "issuing_state": obj.get("issuing_state"),
             "issuing_date": obj.get("issuing_date"),
@@ -173,7 +222,22 @@ class DocumentProperties(BaseModel):
             "widow_name": obj.get("widow_name"),
             "alias_name": obj.get("alias_name"),
             "issuing_authority": obj.get("issuing_authority"),
+            "remarks": obj.get("remarks"),
+            "civil_state": obj.get("civil_state"),
+            "expatriation": obj.get("expatriation"),
+            "father_name": obj.get("father_name"),
+            "mother_name": obj.get("mother_name"),
+            "religion": obj.get("religion"),
+            "type_of_permit": obj.get("type_of_permit"),
+            "version_number": obj.get("version_number"),
+            "document_subtype": obj.get("document_subtype"),
+            "profession": obj.get("profession"),
+            "security_document_number": obj.get("security_document_number"),
+            "tax_number": obj.get("tax_number"),
+            "nist_identity_evidence_strength": obj.get("nist_identity_evidence_strength"),
+            "has_issuance_confirmation": obj.get("has_issuance_confirmation"),
             "real_id_compliance": obj.get("real_id_compliance"),
+            "security_tier": obj.get("security_tier"),
             "address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
             "barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
             "nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,

onfido/models/document_shared.py

@@ -41,8 +41,8 @@ class DocumentShared(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['jpg', 'png', 'pdf']):
-            raise ValueError("must be one of enum values ('jpg', 'png', 'pdf')")
+        if value not in set(['jpg', 'jpeg', 'png', 'pdf']):
+            raise ValueError("must be one of enum values ('jpg', 'jpeg', 'png', 'pdf')")
         return value
 
     @field_validator('side')

onfido/models/document_with_driver_verification_report_all_of_properties.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from datetime import date
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from onfido.models.document_properties_address_lines import DocumentPropertiesAddressLines
 from onfido.models.document_properties_barcode_inner import DocumentPropertiesBarcodeInner
@@ -38,12 +38,14 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     """ # noqa: E501
     date_of_birth: Optional[date] = None
     date_of_expiry: Optional[date] = None
+    personal_number: Optional[StrictStr] = None
     document_numbers: Optional[List[DocumentPropertiesDocumentNumbersInner]] = None
     document_type: Optional[StrictStr] = None
     first_name: Optional[StrictStr] = None
+    middle_name: Optional[StrictStr] = None
+    last_name: Optional[StrictStr] = None
     gender: Optional[StrictStr] = None
     issuing_country: Optional[StrictStr] = None
-    last_name: Optional[StrictStr] = None
     nationality: Optional[StrictStr] = None
     issuing_state: Optional[StrictStr] = None
     issuing_date: Optional[date] = None
@@ -57,7 +59,22 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     widow_name: Optional[StrictStr] = None
     alias_name: Optional[StrictStr] = None
     issuing_authority: Optional[StrictStr] = None
+    remarks: Optional[StrictStr] = None
+    civil_state: Optional[StrictStr] = None
+    expatriation: Optional[StrictStr] = None
+    father_name: Optional[StrictStr] = None
+    mother_name: Optional[StrictStr] = None
+    religion: Optional[StrictStr] = None
+    type_of_permit: Optional[StrictStr] = None
+    version_number: Optional[StrictStr] = None
+    document_subtype: Optional[StrictStr] = None
+    profession: Optional[StrictStr] = None
+    security_document_number: Optional[StrictStr] = None
+    tax_number: Optional[StrictStr] = None
+    nist_identity_evidence_strength: Optional[StrictStr] = None
+    has_issuance_confirmation: Optional[StrictStr] = None
     real_id_compliance: Optional[StrictBool] = None
+    security_tier: Optional[StrictStr] = None
     address_lines: Optional[DocumentPropertiesAddressLines] = None
     barcode: Optional[List[DocumentPropertiesBarcodeInner]] = None
     nfc: Optional[DocumentPropertiesNfc] = None
@@ -71,7 +88,37 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
     vehicle_class_details: Optional[List[DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner]] = Field(default=None, description="Detailed classes/categories information")
     passenger_vehicle: Optional[DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "document_numbers", "document_type", "first_name", "gender", "issuing_country", "last_name", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "real_id_compliance", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "vehicle_class_details", "passenger_vehicle"]
+    __properties: ClassVar[List[str]] = ["date_of_birth", "date_of_expiry", "personal_number", "document_numbers", "document_type", "first_name", "middle_name", "last_name", "gender", "issuing_country", "nationality", "issuing_state", "issuing_date", "categorisation", "mrz_line1", "mrz_line2", "mrz_line3", "address", "place_of_birth", "spouse_name", "widow_name", "alias_name", "issuing_authority", "remarks", "civil_state", "expatriation", "father_name", "mother_name", "religion", "type_of_permit", "version_number", "document_subtype", "profession", "security_document_number", "tax_number", "nist_identity_evidence_strength", "has_issuance_confirmation", "real_id_compliance", "security_tier", "address_lines", "barcode", "nfc", "driving_licence_information", "document_classification", "extracted_data", "drivers_licence", "restricted_licence", "raw_licence_category", "raw_vehicle_classes", "vehicle_class_details", "passenger_vehicle"]
+
+    @field_validator('nist_identity_evidence_strength')
+    def nist_identity_evidence_strength_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength']):
+            raise ValueError("must be one of enum values ('superior', 'strong', 'fair', 'weak', 'unacceptable', 'unspecified_identity_evidence_strength')")
+        return value
+
+    @field_validator('has_issuance_confirmation')
+    def has_issuance_confirmation_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['true', 'false', 'unspecified']):
+            raise ValueError("must be one of enum values ('true', 'false', 'unspecified')")
+        return value
+
+    @field_validator('security_tier')
+    def security_tier_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier']):
+            raise ValueError("must be one of enum values ('tier_1', 'tier_2', 'tier_3', 'tier_4', 'tier_5', 'unspecified_security_tier')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -172,12 +219,14 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
         _obj = cls.model_validate({
             "date_of_birth": obj.get("date_of_birth"),
             "date_of_expiry": obj.get("date_of_expiry"),
+            "personal_number": obj.get("personal_number"),
             "document_numbers": [DocumentPropertiesDocumentNumbersInner.from_dict(_item) for _item in obj["document_numbers"]] if obj.get("document_numbers") is not None else None,
             "document_type": obj.get("document_type"),
             "first_name": obj.get("first_name"),
+            "middle_name": obj.get("middle_name"),
+            "last_name": obj.get("last_name"),
             "gender": obj.get("gender"),
             "issuing_country": obj.get("issuing_country"),
-            "last_name": obj.get("last_name"),
             "nationality": obj.get("nationality"),
             "issuing_state": obj.get("issuing_state"),
             "issuing_date": obj.get("issuing_date"),
@@ -191,7 +240,22 @@ class DocumentWithDriverVerificationReportAllOfProperties(BaseModel):
             "widow_name": obj.get("widow_name"),
             "alias_name": obj.get("alias_name"),
             "issuing_authority": obj.get("issuing_authority"),
+            "remarks": obj.get("remarks"),
+            "civil_state": obj.get("civil_state"),
+            "expatriation": obj.get("expatriation"),
+            "father_name": obj.get("father_name"),
+            "mother_name": obj.get("mother_name"),
+            "religion": obj.get("religion"),
+            "type_of_permit": obj.get("type_of_permit"),
+            "version_number": obj.get("version_number"),
+            "document_subtype": obj.get("document_subtype"),
+            "profession": obj.get("profession"),
+            "security_document_number": obj.get("security_document_number"),
+            "tax_number": obj.get("tax_number"),
+            "nist_identity_evidence_strength": obj.get("nist_identity_evidence_strength"),
+            "has_issuance_confirmation": obj.get("has_issuance_confirmation"),
             "real_id_compliance": obj.get("real_id_compliance"),
+            "security_tier": obj.get("security_tier"),
             "address_lines": DocumentPropertiesAddressLines.from_dict(obj["address_lines"]) if obj.get("address_lines") is not None else None,
             "barcode": [DocumentPropertiesBarcodeInner.from_dict(_item) for _item in obj["barcode"]] if obj.get("barcode") is not None else None,
             "nfc": DocumentPropertiesNfc.from_dict(obj["nfc"]) if obj.get("nfc") is not None else None,

onfido/models/webhook_event_payload_object.py

@@ -29,10 +29,11 @@ class WebhookEventPayloadObject(BaseModel):
     """ # noqa: E501
     id: StrictStr = Field(description="The unique identifier of the resource.")
     status: Optional[StrictStr] = Field(default=None, description="The current state of the object, if available.")
+    started_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was started, if available.")
     completed_at_iso8601: Optional[datetime] = Field(default=None, description="The date and time when the operation was completed, if available.")
     href: StrictStr = Field(description="The uri of the resource.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["id", "status", "completed_at_iso8601", "href"]
+    __properties: ClassVar[List[str]] = ["id", "status", "started_at_iso8601", "completed_at_iso8601", "href"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -94,6 +95,7 @@ class WebhookEventPayloadObject(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "status": obj.get("status"),
+            "started_at_iso8601": obj.get("started_at_iso8601"),
             "completed_at_iso8601": obj.get("completed_at_iso8601"),
             "href": obj.get("href")
         })

onfido/webhook_event_verifier.py

@@ -1,21 +1,24 @@
 import hmac
 import hashlib
-import json
 
 from .models import WebhookEvent
 
+
 class OnfidoInvalidSignatureError(Exception):
     pass
 
+
 class WebhookEventVerifier:
     def __init__(self, webhook_token):
         self.webhook_token = webhook_token
 
     def read_payload(self, raw_event, signature):
         # Compute the the actual HMAC signature from the raw request body.
-        event_signature = hmac.new(key=self.webhook_token.encode("utf-8"),
-                                   msg=raw_event.encode("utf-8"),
-                                   digestmod=hashlib.sha256).hexdigest()
+        event_signature = hmac.new(
+            key=self.webhook_token.encode("utf-8"),
+            msg=raw_event.encode("utf-8"),
+            digestmod=hashlib.sha256,
+        ).hexdigest()
 
         # Compare the signatures (prevent against timing attacks).
         if not hmac.compare_digest(signature, event_signature):

{onfido_python-3.1.0.dist-info → onfido_python-3.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: onfido-python
-Version: 3.1.0
+Version: 3.3.0
 Summary: Python library for the Onfido API
 Home-page: 
 Author: OpenAPI Generator community

{onfido_python-3.1.0.dist-info → onfido_python-3.3.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-onfido/__init__.py,sha256=VrBQDCcdxyUQsfrw0d2SJihjONvolMo8xk60aodGfL4,27053
-onfido/api_client.py,sha256=vg4wTa9ZeuzaM1CgZyhMT9-GV_pRm828uAf3lfqh0wA,26205
+onfido/__init__.py,sha256=oZ8T3TqtvOz-mDpbgg2FIAptR9vAbVUsYcGLmaJkv8Y,27053
+onfido/api_client.py,sha256=CGsFK2H5x8VO4yXLH8nA7YyxSob2FosUT3vauvu3u5w,26205
 onfido/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-onfido/configuration.py,sha256=moVSShURgTuKaLvP7ibfuqI0AiqxtuO21m6T-GStR1A,14613
+onfido/configuration.py,sha256=DiBi_YlOW9Hzhglao7GZB3LJGGqM4DOiDmfo5GnipNA,14613
 onfido/exceptions.py,sha256=5W4DJIPVwIzljxoedh5czPXOTBaq6CTTVD92h5ZyN88,5894
 onfido/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 onfido/rest.py,sha256=NSJRLqL8U0UzO2YY0KCP4_BmvhOedRHC7zGVTrJ1VFU,9415
-onfido/webhook_event_verifier.py,sha256=Xy1eK8zorxqCKvLmJw9hS_-B6j_N-akJjxjZp0M8u20,847
+onfido/webhook_event_verifier.py,sha256=3BSbY5D8NTXDbxCX0POuyu5a09dEeWgmikrTe_pttkI,814
 onfido/api/__init__.py,sha256=hqeJm_GD67zukfFQ-H5PPPxYgZZ0DKOMPGTNRAjc3gw,94
-onfido/api/default_api.py,sha256=LlouO2AJZplA7pOfPqDsmUSaPS8dFoQZG-0CDd1l77Y,675834
+onfido/api/default_api.py,sha256=Eelike5MvHvPpw8u8KchC9Bfn4sPkjMk7TH0LyeHTMs,687639
 onfido/models/__init__.py,sha256=XJ5d4YV52FNXwBYQabTrtVBd-Y61_po8BdxlCJd-prg,26401
 onfido/models/address.py,sha256=47oVzKVhn6Qxd24HMIuAQmVKgHPyfOnlFmBnthi2wOE,6812
 onfido/models/address_builder.py,sha256=SjuOn2_T7Yic2l7qhaxd-euaijx85BziRkunp5j292M,6840
@@ -42,7 +42,7 @@ onfido/models/device_intelligence_breakdown_properties_device.py,sha256=DUWTZDuh
 onfido/models/device_intelligence_breakdown_properties_geolocation.py,sha256=78wKBOHlNHAc96ZWMPa6hQQPbYKX6ospdNYgyL56-qM,3618
 onfido/models/device_intelligence_breakdown_properties_ip.py,sha256=NaFRkErYehw5bOf-hbz2xuWYJ0gz0ErDhBR0SpcZpBQ,3783
 onfido/models/device_intelligence_report.py,sha256=5loxXEhqlhMrZc9r4lJ8XzaLpz-NoOD11P2gPzckqPs,5468
-onfido/models/document.py,sha256=ZFRqyDtso3DtKSbRecnlc6VAhCxGGGlp-8YGDSs1TdQ,5525
+onfido/models/document.py,sha256=IF9bzlAXgTK1ZoSNILrZ4mHPXVhlQGl0DGS1JxLn_Hk,5541
 onfido/models/document_breakdown.py,sha256=x7lFBT2V2jJvW0JZ6-U_Ca9vjjPOvtCVJP0i__tYc_Y,7813
 onfido/models/document_breakdown_age_validation.py,sha256=ioeCHhNEJB4DnY7cqv-oBa87g46mpnq6BBzBIiafXB8,3699
 onfido/models/document_breakdown_age_validation_breakdown.py,sha256=6idaiBhh_9xFguIEwVbgJqO5qldeNwiAhWJg0U2h3io,3692
@@ -81,7 +81,7 @@ onfido/models/document_breakdown_visual_authenticity_breakdown_template.py,sha25
 onfido/models/document_cdq_reasons.py,sha256=1m2qxLuIeC1HKVQim9TLt95l76FDi_rJi0uBYKtd03E,5214
 onfido/models/document_iq_reasons.py,sha256=OKiCuxShiJ4uBrALjsK_Z_z28fnLwPEYev5YV6cDOVc,5392
 onfido/models/document_odp_reasons.py,sha256=RQ6UAGnhkg7hfwOaEqAbuxdjIh2F1QyAhsoIpRsQfN0,3966
-onfido/models/document_properties.py,sha256=owd2EBTyVzz3Q1tO4GkvBYrBgs6z2aIDvnK6uLC_6kk,9420
+onfido/models/document_properties.py,sha256=d6D_RgJLVS_LMuR1ff9RwtDzv59FkBrMRxnHvySrtIE,12860
 onfido/models/document_properties_address_lines.py,sha256=KBEQPfyCQNpoA_VjP6vKroWqnOa_sy-G_UnyiBox-jI,3606
 onfido/models/document_properties_barcode_inner.py,sha256=FVPy1Gc65ECQDY3cuF8J5jhuUNBceyua0ldUepaGZmA,5150
 onfido/models/document_properties_document_classification.py,sha256=YRa0qNQBNXCPnHJn9_N0lKaXzhVCC-xKPezBBaYR7mU,3400
@@ -91,13 +91,13 @@ onfido/models/document_properties_extracted_data.py,sha256=vW-B2osOZhlGdeanDlgBD
 onfido/models/document_properties_nfc.py,sha256=0ToFxpEA45NN6Oy9jpOzmLktJpWLAWhBREjehJds-1Y,4475
 onfido/models/document_report.py,sha256=0D7BPKmtW1yi_STY_pnS0yHS1prACWFZUqFyn1iBaEw,5817
 onfido/models/document_response.py,sha256=feTxv5jfkyXhoJaaE4fNlWPWrXqdjRGOYnqqUoMzuMg,3956
-onfido/models/document_shared.py,sha256=EF8s5VmoocjhuGII5Nb9qhpwYar7cS7h0ilbIIcRdSs,4542
+onfido/models/document_shared.py,sha256=R4jJg6D-GXSrTpXavHpdHfvNWIYaY1s4XfiwFUr682g,4558
 onfido/models/document_types.py,sha256=i-LPmO8G7e-YfuzvvvJZ40SZYebjk227CndXtZOXCrk,1824
 onfido/models/document_video_report.py,sha256=os-qrNYCUECejSC35jPLUsXDxe7y6f5g0s3_QD8__Eo,5837
 onfido/models/document_video_with_address_information_report.py,sha256=m_-BBX6i36ETlHJO9NwZIY7eVmJMdgoiYPjjg0NT9Sw,5925
 onfido/models/document_with_address_information_report.py,sha256=BkksAiZC-ooMik5JJxVMFrKtIZ5ZzMFIO2roRx7lhxU,5905
 onfido/models/document_with_driver_verification_report.py,sha256=LkwKvOa7WaQRXw2A3incYjK8_b4tC_upnoxpaQ8Eek0,6043
-onfido/models/document_with_driver_verification_report_all_of_properties.py,sha256=27ZUfACsDEEqgFnGZllE7LqhWJkpQocQ_An00QO1qNk,12244
+onfido/models/document_with_driver_verification_report_all_of_properties.py,sha256=4Eyh2f8O4fVtwf2aOGwZuV9DPlVpRmimJgAjqB0fURQ,15684
 onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.py,sha256=xI7noUuOz8MIrJ7iErenQgww2EmgTukpYehLBcC1zZI,3792
 onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.py,sha256=7IYp8uXyMjA2WKyEDkQw_3_ZixPVosy3x7XcXSksXVQ,3866
 onfido/models/document_with_driving_licence_information_report.py,sha256=vGMnVXPNdsgCcvWLGPNvO2FnGUZFYK89SVAbAQlXkUY,5933
@@ -268,7 +268,7 @@ onfido/models/webhook_builder.py,sha256=pwhg4W9CuRSdup25LJAV099md70EHPJ9H9gEaREG
 onfido/models/webhook_create.py,sha256=8Ur6l4YhUAaIl4WCd-dWqPVmHGZ-2cxROA--U0BLVus,3070
 onfido/models/webhook_event.py,sha256=g5lobXwKJsA0J34puBVMcLbm7vcrVlZoFTuvRvCFE9o,3323
 onfido/models/webhook_event_payload.py,sha256=06DUF1HdWTbWhB6_tSHoGXiZuEwoil3WJxoDiNoPZUk,3954
-onfido/models/webhook_event_payload_object.py,sha256=99d1pPcVCyjZAttqiimNekwdj2JU4Seu31zTGoqeXcI,3664
+onfido/models/webhook_event_payload_object.py,sha256=Cvccr6bVuT43yECl2xTJPjjiYUfvgDVlqRTHSYjzSDE,3895
 onfido/models/webhook_event_type.py,sha256=AP1JjrpjTyoATidiS0O_WnKyIEN4wrW-V0udJu-aLqs,1569
 onfido/models/webhook_resend.py,sha256=pDG9j6l-hrUq9UU_XI_g5zZTsvE69zgeSynYQ936R6Y,3463
 onfido/models/webhook_response.py,sha256=VpnpGMafbWR7oj2Tws-sQlVmNzP9RPEMKvQ_g6wrbt0,3557
@@ -284,8 +284,8 @@ onfido/models/workflow_run_response.py,sha256=YKYOf78z7GA2IG0B_EDJMqEtdqssVdzzhC
 onfido/models/workflow_run_response_error.py,sha256=93xJUVTdo4PUsMzOdcsAifRWlZiTh6nO-nDPUc2SMTs,3311
 onfido/models/workflow_run_shared.py,sha256=fHcZBs61MokjwyaAD1tDKoefpoTwM-DCeiBkjV5n6E8,4561
 onfido/models/workflow_run_shared_link.py,sha256=8uAlWkhDF9g_7CuVfhoAXgZqcv6LZHOIc4c_CqMxths,4682
-onfido_python-3.1.0.dist-info/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
-onfido_python-3.1.0.dist-info/METADATA,sha256=YCqVUTzumAzHazUwigv74xlbaKG87pcZH6bsDvz3E1c,482
-onfido_python-3.1.0.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
-onfido_python-3.1.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
-onfido_python-3.1.0.dist-info/RECORD,,
+onfido_python-3.3.0.dist-info/LICENSE,sha256=SKY_O1OkFX8yNWFuVVfYTsXvN46jsgtff-xReserHw4,1073
+onfido_python-3.3.0.dist-info/METADATA,sha256=40NH6GKoTftSKonaG_9fSJYypX6SsLHjEKpm3FP2Nxg,482
+onfido_python-3.3.0.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+onfido_python-3.3.0.dist-info/top_level.txt,sha256=NHu8xI4S4Avh7xUark3dpdk9atpIVgyf-ptjHXU0-Ns,7
+onfido_python-3.3.0.dist-info/RECORD,,

{onfido_python-3.1.0.dist-info → onfido_python-3.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.0)
+Generator: setuptools (70.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any