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

onfido/models/us_driving_licence_shared.py

@@ -0,0 +1,185 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UsDrivingLicenceShared(BaseModel):
+    """
+    An object that contains all accepted fields for the Driver's License Data Verification report.
+    """ # noqa: E501
+    id_number: StrictStr = Field(description="Driving licence ID number")
+    issue_state: Annotated[str, Field(strict=True)] = Field(description="Two letter code of issuing state (state-issued driving licenses only)")
+    address_line_1: Optional[StrictStr] = Field(default=None, description="Line 1 of the address")
+    address_line_2: Optional[StrictStr] = Field(default=None, description="Line 2 of the address")
+    city: Optional[StrictStr] = Field(default=None, description="The city of the owner's address")
+    date_of_birth: Optional[date] = Field(default=None, description="Date of birth in yyyy-mm-dd format")
+    document_category: Optional[StrictStr] = Field(default=None, description="Document category.")
+    expiration_date: Optional[date] = Field(default=None, description="Expiration date of the driving licence in yyyy-mm-dd format")
+    eye_color_code: Optional[StrictStr] = Field(default=None, description="Eye color code.")
+    first_name: Optional[StrictStr] = Field(default=None, description="The owner's first name")
+    gender: Optional[StrictStr] = None
+    issue_date: Optional[date] = Field(default=None, description="Issue date in yyyy-mm-dd format")
+    last_name: Optional[StrictStr] = Field(default=None, description="The owner's surname")
+    middle_name: Optional[StrictStr] = Field(default=None, description="The owner's middle name")
+    name_suffix: Optional[StrictStr] = Field(default=None, description="The owner's name suffix")
+    postal_code: Optional[StrictStr] = Field(default=None, description="The postcode or ZIP of the owner's address")
+    state: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="2-characters state code")
+    weight_measure: Optional[StrictInt] = Field(default=None, description="Weight in pounds")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id_number", "issue_state", "address_line_1", "address_line_2", "city", "date_of_birth", "document_category", "expiration_date", "eye_color_code", "first_name", "gender", "issue_date", "last_name", "middle_name", "name_suffix", "postal_code", "state", "weight_measure"]
+
+    @field_validator('issue_state')
+    def issue_state_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[A-Z]{2}$", value):
+            raise ValueError(r"must validate the regular expression /^[A-Z]{2}$/")
+        return value
+
+    @field_validator('document_category')
+    def document_category_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['driver license', 'driver permit', 'id card']):
+            raise ValueError("must be one of enum values ('driver license', 'driver permit', 'id card')")
+        return value
+
+    @field_validator('eye_color_code')
+    def eye_color_code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK']):
+            raise ValueError("must be one of enum values ('BLK', 'BLU', 'BRO', 'DIC', 'GRY', 'GRN', 'HAZ', 'MAR', 'PNK')")
+        return value
+
+    @field_validator('gender')
+    def gender_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Male', 'Female']):
+            raise ValueError("must be one of enum values ('Male', 'Female')")
+        return value
+
+    @field_validator('state')
+    def state_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^[A-Z]{2}$", value):
+            raise ValueError(r"must validate the regular expression /^[A-Z]{2}$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UsDrivingLicenceShared from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "gender",
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsDrivingLicenceShared from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id_number": obj.get("id_number"),
+            "issue_state": obj.get("issue_state"),
+            "address_line_1": obj.get("address_line_1"),
+            "address_line_2": obj.get("address_line_2"),
+            "city": obj.get("city"),
+            "date_of_birth": obj.get("date_of_birth"),
+            "document_category": obj.get("document_category"),
+            "expiration_date": obj.get("expiration_date"),
+            "eye_color_code": obj.get("eye_color_code"),
+            "first_name": obj.get("first_name"),
+            "gender": obj.get("gender"),
+            "issue_date": obj.get("issue_date"),
+            "last_name": obj.get("last_name"),
+            "middle_name": obj.get("middle_name"),
+            "name_suffix": obj.get("name_suffix"),
+            "postal_code": obj.get("postal_code"),
+            "state": obj.get("state"),
+            "weight_measure": obj.get("weight_measure")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/video_reasons.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VideoReasons(BaseModel):
+    """
+    VideoReasons
+    """ # noqa: E501
+    fake_webcam: Optional[StrictStr] = Field(default=None, description="Flags when evidence is found that a fake webcam was used.")
+    challenge_reuse: Optional[StrictStr] = Field(default=None, description="Flags when evidence is found that the video was uploaded in an attempt to circumvent the randomness of the speaking and head turn challenges")
+    emulator: Optional[StrictStr] = Field(default=None, description="Flags when evidence is found that an Android emulator was used.")
+    reasons: Optional[StrictStr] = Field(default=None, description="Additional comma separated details such as the name of the fake webcam.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["fake_webcam", "challenge_reuse", "emulator", "reasons"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VideoReasons from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VideoReasons from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "fake_webcam": obj.get("fake_webcam"),
+            "challenge_reuse": obj.get("challenge_reuse"),
+            "emulator": obj.get("emulator"),
+            "reasons": obj.get("reasons")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_aml_breakdown.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List, Optional
+from onfido.models.watchlist_aml_breakdown_adverse_media import WatchlistAmlBreakdownAdverseMedia
+from onfido.models.watchlist_aml_breakdown_legal_and_regulatory_warnings import WatchlistAmlBreakdownLegalAndRegulatoryWarnings
+from onfido.models.watchlist_aml_breakdown_politically_exposed_person import WatchlistAmlBreakdownPoliticallyExposedPerson
+from onfido.models.watchlist_aml_breakdown_sanction import WatchlistAmlBreakdownSanction
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistAmlBreakdown(BaseModel):
+    """
+    WatchlistAmlBreakdown
+    """ # noqa: E501
+    sanction: Optional[WatchlistAmlBreakdownSanction] = None
+    politically_exposed_person: Optional[WatchlistAmlBreakdownPoliticallyExposedPerson] = None
+    legal_and_regulatory_warnings: Optional[WatchlistAmlBreakdownLegalAndRegulatoryWarnings] = None
+    adverse_media: Optional[WatchlistAmlBreakdownAdverseMedia] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["sanction", "politically_exposed_person", "legal_and_regulatory_warnings", "adverse_media"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdown from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of sanction
+        if self.sanction:
+            _dict['sanction'] = self.sanction.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of politically_exposed_person
+        if self.politically_exposed_person:
+            _dict['politically_exposed_person'] = self.politically_exposed_person.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of legal_and_regulatory_warnings
+        if self.legal_and_regulatory_warnings:
+            _dict['legal_and_regulatory_warnings'] = self.legal_and_regulatory_warnings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of adverse_media
+        if self.adverse_media:
+            _dict['adverse_media'] = self.adverse_media.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdown from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sanction": WatchlistAmlBreakdownSanction.from_dict(obj["sanction"]) if obj.get("sanction") is not None else None,
+            "politically_exposed_person": WatchlistAmlBreakdownPoliticallyExposedPerson.from_dict(obj["politically_exposed_person"]) if obj.get("politically_exposed_person") is not None else None,
+            "legal_and_regulatory_warnings": WatchlistAmlBreakdownLegalAndRegulatoryWarnings.from_dict(obj["legal_and_regulatory_warnings"]) if obj.get("legal_and_regulatory_warnings") is not None else None,
+            "adverse_media": WatchlistAmlBreakdownAdverseMedia.from_dict(obj["adverse_media"]) if obj.get("adverse_media") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_aml_breakdown_adverse_media.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistAmlBreakdownAdverseMedia(BaseModel):
+    """
+    Asserts if there are any records found of negative events reported by publicly and generally available media sources.
+    """ # noqa: E501
+    result: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["result"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdownAdverseMedia from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdownAdverseMedia from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result": obj.get("result")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Onfido API v3.6
+
+    The Onfido API (v3.6)
+
+    The version of the OpenAPI document: v3.6
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchlistAmlBreakdownLegalAndRegulatoryWarnings(BaseModel):
+    """
+    Asserts if there are any records found in Law-Enforcement and Regulatory bodies Monitored Lists (including Terrorism, Money Laundering and Most Wanted lists).
+    """ # noqa: E501
+    result: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["result"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdownLegalAndRegulatoryWarnings from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchlistAmlBreakdownLegalAndRegulatoryWarnings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result": obj.get("result")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+