regula-documentreader-webclient 7.7.322.dev0__py3-none-any.whl → 7.7.323.dev0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of regula-documentreader-webclient might be problematic. Click here for more details.

@@ -492,7 +492,7 @@ class Configuration:
492
492
  return "Python SDK Debug Report:\n"\
493
493
  "OS: {env}\n"\
494
494
  "Python Version: {pyversion}\n"\
495
- "Version of the API: 7.6.0\n"\
495
+ "Version of the API: 8.1.0\n"\
496
496
  "SDK Package Version: 1.0.0".\
497
497
  format(env=sys.platform, pyversion=sys.version)
498
498
 
@@ -60,6 +60,12 @@ class Light(int, Enum):
60
60
  UVB = 1048576
61
61
  WHITE_OBL = 2097152
62
62
  WHITE_SPECIAL = 4194304
63
+ WHITE_UV = 134
64
+ WHITE_FULL_HOLO = 67108870
65
+ HR_LIGHT = 1073741824
66
+ HR_WHITE = 1073741830
67
+ HR_UV = 1073741952
68
+ HR_IR = 1073741848
63
69
 
64
70
  @classmethod
65
71
  def from_json(cls, json_str: str) -> Self:
@@ -24,7 +24,8 @@ class LivenessParams(BaseModel):
24
24
  check_ed: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Electronic device detection", alias="checkED")
25
25
  check_black_and_white_copy: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Black and white copy check", alias="checkBlackAndWhiteCopy")
26
26
  check_dynaprint: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Dynaprint check", alias="checkDynaprint")
27
- __properties: ClassVar[List[str]] = ["checkOVI", "checkMLI", "checkHolo", "checkED", "checkBlackAndWhiteCopy", "checkDynaprint"]
27
+ check_geometry: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Geometry check", alias="checkGeometry")
28
+ __properties: ClassVar[List[str]] = ["checkOVI", "checkMLI", "checkHolo", "checkED", "checkBlackAndWhiteCopy", "checkDynaprint", "checkGeometry"]
28
29
 
29
30
  model_config = ConfigDict(
30
31
  populate_by_name=True,
@@ -82,7 +83,8 @@ class LivenessParams(BaseModel):
82
83
  "checkHolo": obj.get("checkHolo"),
83
84
  "checkED": obj.get("checkED"),
84
85
  "checkBlackAndWhiteCopy": obj.get("checkBlackAndWhiteCopy"),
85
- "checkDynaprint": obj.get("checkDynaprint")
86
+ "checkDynaprint": obj.get("checkDynaprint"),
87
+ "checkGeometry": obj.get("checkGeometry")
86
88
  })
87
89
  return _obj
88
90
 
@@ -97,7 +97,8 @@ class ProcessParams(BaseModel):
97
97
  select_longest_names: Optional[StrictBool] = Field(default=None, description="Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.", alias="selectLongestNames")
98
98
  do_barcodes: Optional[List[InputBarcodeType]] = Field(default=None, description="Set the types of barcodes to process.", alias="doBarcodes")
99
99
  strict_dl_category_expiry: Optional[StrictBool] = Field(default=None, description="Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases.", alias="strictDLCategoryExpiry")
100
- __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry"]
100
+ generate_alpha2_codes: Optional[StrictBool] = Field(default=None, description="Set to generate Alpha-2 codes for nationality and issuing state fields.", alias="generateAlpha2Codes")
101
+ __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes"]
101
102
 
102
103
  model_config = ConfigDict(
103
104
  populate_by_name=True,
@@ -229,7 +230,8 @@ class ProcessParams(BaseModel):
229
230
  "strictBarcodeDigitalSignatureCheck": obj.get("strictBarcodeDigitalSignatureCheck"),
230
231
  "selectLongestNames": obj.get("selectLongestNames"),
231
232
  "doBarcodes": obj.get("doBarcodes"),
232
- "strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry")
233
+ "strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry"),
234
+ "generateAlpha2Codes": obj.get("generateAlpha2Codes")
233
235
  })
234
236
  return _obj
235
237
 
@@ -37,6 +37,7 @@ class Scenario(str, Enum):
37
37
  CREDITCARD = 'CreditCard'
38
38
  CAPTURE = 'Capture'
39
39
  DTC = 'DTC'
40
+ RFID = 'RFID'
40
41
 
41
42
  @classmethod
42
43
  def from_json(cls, json_str: str) -> Self:
@@ -71,6 +71,8 @@ class SecurityFeatureType(int, Enum):
71
71
  CONTACT_CHIP_CLASSIFICATION = 51
72
72
  HEAD_POSITION_CHECK = 52
73
73
  LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
74
+ LIVENESS_DYNAPRINT = 54
75
+ LIVENESS_GEOMETRY_CHECK = 55
74
76
 
75
77
  @classmethod
76
78
  def from_json(cls, json_str: str) -> Self:
@@ -20,7 +20,7 @@ class SymbolRecognitionResult(BaseModel):
20
20
  """
21
21
  Describes a single character recognition results in the text field line
22
22
  """ # noqa: E501
23
- symbol_rect: RectangleCoordinates = Field(alias="SymbolRect")
23
+ symbol_rect: Optional[RectangleCoordinates] = Field(default=None, alias="SymbolRect")
24
24
  candidates_count: Union[StrictFloat, StrictInt] = Field(description="Number of significant elements of ListOfCandidates array", alias="CandidatesCount")
25
25
  list_of_candidates: List[SymbolCandidate] = Field(description="Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)", alias="ListOfCandidates")
26
26
  base_line_bottom: Optional[StrictInt] = Field(default=None, alias="BaseLineBottom")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: regula_documentreader_webclient
3
- Version: 7.7.322.dev0
3
+ Version: 7.7.323.dev0
4
4
  Summary: Regula's Document Reader python client
5
5
  Home-page: https://regulaforensics.com
6
6
  Author: Regula Forensics, Inc.
@@ -20,7 +20,7 @@ regula/documentreader/webclient/ext/models/authenticity/security_feature.py,sha2
20
20
  regula/documentreader/webclient/gen/__init__.py,sha256=pgq20ZqtwGg6nHsu4phO5RmSAOo2vTu-yKsD5lIXhTY,21764
21
21
  regula/documentreader/webclient/gen/api_client.py,sha256=HHg6WD9kdtzfaP_W15MQDVv6dHAC3axjYT-CnnL4iwQ,27357
22
22
  regula/documentreader/webclient/gen/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
23
- regula/documentreader/webclient/gen/configuration.py,sha256=JCc_wWrUv01B__2Ty7JFW_HGmlTMbeE1wAEi5cWRBe8,18084
23
+ regula/documentreader/webclient/gen/configuration.py,sha256=0hMqlAxYaL30050LBPnHrh6Sg1EIfSfQLr0eGNRNz1w,18084
24
24
  regula/documentreader/webclient/gen/exceptions.py,sha256=fYFXlhg-wAlI9z7BBe-1Eifxm9tiBONwsXkH_VMq4RE,6228
25
25
  regula/documentreader/webclient/gen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
26
26
  regula/documentreader/webclient/gen/rest.py,sha256=y7sJJqeEmZH-cdSovKzh4w3GhJZ7-fQH6C9tNr7NLao,9246
@@ -128,11 +128,11 @@ regula/documentreader/webclient/gen/models/lcid.py,sha256=D0MBIfktXYPPkRVCUSSHyN
128
128
  regula/documentreader/webclient/gen/models/lexical_analysis_result.py,sha256=14ymAFRmQV3xgXdHkH1lf3wU-xq9sAEUYJby_U3VAHA,3473
129
129
  regula/documentreader/webclient/gen/models/license_item.py,sha256=niMcTCpIz_b1MaVxsnah5f5iXJaHWtpns3qQ8HoM5D4,2336
130
130
  regula/documentreader/webclient/gen/models/license_result.py,sha256=xzd8-RvvEsRaGbQiBko1594vGhya6aDtMLBEZqdw6oI,2775
131
- regula/documentreader/webclient/gen/models/light.py,sha256=UOVjHaNjt7tR_bX5ILymzUrgCblATwJ0KLgvIzANtiM,1396
131
+ regula/documentreader/webclient/gen/models/light.py,sha256=6VPk1tZpZn0ph0ykDxLuMDM2eq-va-eIWguP100tPa4,1544
132
132
  regula/documentreader/webclient/gen/models/list_transactions_by_tag_response.py,sha256=yT8dwshY6BI-pk2prcLvCE3OOwWt5IBXEczkwpgtXHc,2968
133
133
  regula/documentreader/webclient/gen/models/list_verified_fields.py,sha256=jklFQCZR9n9SXgpdp4Yz2AFPttiKTkSqHoWL81ZM4UU,3216
134
134
  regula/documentreader/webclient/gen/models/list_verified_fields_item.py,sha256=LHm1JtDx1GumCOfhaqVv6NlY8eTS0ND-11_2KG4HaYU,2751
135
- regula/documentreader/webclient/gen/models/liveness_params.py,sha256=xOO1IZaMDWPhPigQRvzXsktrrlVfjeydAk0gUIR9LxQ,3481
135
+ regula/documentreader/webclient/gen/models/liveness_params.py,sha256=nlxqwyvUXqjLqojNtOQYmw9wQ2e7s4xKwUN2yoE-Dp0,3702
136
136
  regula/documentreader/webclient/gen/models/log_level.py,sha256=50zJkPpvDt4PYrlgBJp0QHGW2wYO2TLa_5qy_MIxPcY,562
137
137
  regula/documentreader/webclient/gen/models/measure_system.py,sha256=CltBZGhqVVeuAIKEkrSnN7A2Ao65BBEtwaieEJMbdnQ,497
138
138
  regula/documentreader/webclient/gen/models/mrz_detect_mode_enum.py,sha256=gc8c4HTAa5yRutUhXOFbO2ZKhphArW0vhenb24bEJTE,643
@@ -162,7 +162,7 @@ regula/documentreader/webclient/gen/models/photo_ident_result.py,sha256=YpDPqn36
162
162
  regula/documentreader/webclient/gen/models/point.py,sha256=_khsO-Zo2SIqXIPHQALJz4F6kB2lDqIi0Yhg7c8ImRw,2234
163
163
  regula/documentreader/webclient/gen/models/point_array.py,sha256=xcg4DqZl-oNKJt9BPyASdeGNTlPrO7G31zTMEzZkL2g,2768
164
164
  regula/documentreader/webclient/gen/models/points_container.py,sha256=6KKKe2sFAwg3d0QDWyejfQEHTqTzTE56o6MqSX5gO6A,2951
165
- regula/documentreader/webclient/gen/models/process_params.py,sha256=l5R0Hm8EPPpv6OotJ-lxhv6E5o8wBLLWnm1STKp_OW4,23711
165
+ regula/documentreader/webclient/gen/models/process_params.py,sha256=FiEgx5Qs2MKltIeb7zysVTMv7wBHgksvBbfFb9LQChk,23987
166
166
  regula/documentreader/webclient/gen/models/process_params_rfid.py,sha256=YzSY3dormyWNln3ispy5G4j_7yhNhWJgKQpT45_ad5k,2646
167
167
  regula/documentreader/webclient/gen/models/process_request.py,sha256=SC4zwX2P9A9VjLe7tGXhUvx5Z3mzmsgJOWZAUocZ4JI,6129
168
168
  regula/documentreader/webclient/gen/models/process_request_image.py,sha256=yA0hfvr-KGBGFyR97fQZsAkDX3mh4XZEVsWDXiOLTPQ,2948
@@ -215,10 +215,10 @@ regula/documentreader/webclient/gen/models/rfid_text_data_result.py,sha256=K7oc0
215
215
  regula/documentreader/webclient/gen/models/rfid_type.py,sha256=Iar7yWbbSUnMsac5NMgG4BpkULYe4j97iJAZ01oM7dk,639
216
216
  regula/documentreader/webclient/gen/models/rfid_validity.py,sha256=GdTJug93a4K1REDy4QeMLgVNf878TtbnYGT1R-0fuD4,2980
217
217
  regula/documentreader/webclient/gen/models/rfidpkd_resource_type.py,sha256=apzhMDECSR6nA1XshnyBhF1UvssokP7oAk3xOPVB9p0,658
218
- regula/documentreader/webclient/gen/models/scenario.py,sha256=Y1IoTAM_o-xfxHIl89g_VDsTu-kZk-X9tzSNNc713AU,1025
218
+ regula/documentreader/webclient/gen/models/scenario.py,sha256=8uKVzKXSk0cHuskSOYANSzT3q2rrJXkYyywntSwgxSU,1043
219
219
  regula/documentreader/webclient/gen/models/security_feature_item.py,sha256=a1ka9Tw-riXi0HfrLY1CWxdwg0xSO5wBb-bIIDQ1HOY,4033
220
220
  regula/documentreader/webclient/gen/models/security_feature_result.py,sha256=cVastS4po4D0X5ob2yGYKMDwcHHZWbh8-eQ49_U5MaU,4693
221
- regula/documentreader/webclient/gen/models/security_feature_type.py,sha256=GxIvB9kdlBy8cVA2qVm-DE7KmB_fc4K1ujmlEgpAhtg,2224
221
+ regula/documentreader/webclient/gen/models/security_feature_type.py,sha256=Z9qIAKRFU_MvpSkHABQLssAFXv8uJJQzefZYwnk7Bi8,2285
222
222
  regula/documentreader/webclient/gen/models/security_object_certificates.py,sha256=T-qOwejw7bwUM-baidHAMfC_kaQfjt2JboQAxoPJfDQ,2760
223
223
  regula/documentreader/webclient/gen/models/source.py,sha256=j869nKh9ZZQaTWN_BLvwMQ_1xQBZSPmMMumiF6s8ojw,591
224
224
  regula/documentreader/webclient/gen/models/source_validity.py,sha256=LQI27yhQHF2PkwTpzsJeycoKu-zI4GJ18buyRoPRulg,2447
@@ -230,7 +230,7 @@ regula/documentreader/webclient/gen/models/string_recognition_result.py,sha256=a
230
230
  regula/documentreader/webclient/gen/models/symbol.py,sha256=c5p8WFPEQS7I9SvIoN49VekjNG4e2_F1OXTZyMtL2fI,2273
231
231
  regula/documentreader/webclient/gen/models/symbol_candidate.py,sha256=WCywBDAYYK2MS6tw5CsO3pP_KjpGXbg_U5c18Fr4Kt0,2923
232
232
  regula/documentreader/webclient/gen/models/symbol_estimation_item.py,sha256=TaNaYi3cM0ZGZx0gruyzYdgVMjtAibJPX6lTcA3hk0w,5192
233
- regula/documentreader/webclient/gen/models/symbol_recognition_result.py,sha256=LnSih7x848uHfo1-irmpo7jmGvVG8222H7xfS8vp9OQ,4340
233
+ regula/documentreader/webclient/gen/models/symbol_recognition_result.py,sha256=-ug0c7lvggzzdG2aD0IavkJg8Gy1WfiWj90Dskj8Uqo,4364
234
234
  regula/documentreader/webclient/gen/models/t_doc_binary_info.py,sha256=Kwb-GcTKJGyQ-rz2qSPxEMBKrM1WYcXBlA0tgAivs8A,3398
235
235
  regula/documentreader/webclient/gen/models/t_doc_binary_info_item.py,sha256=Q23P-odDMVeVjAOGRFLN4IASCAAesysAvP3Oq-w0HLA,2684
236
236
  regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info.py,sha256=D7_cQi_DwxkJ0ojTrAT7o-eUYM31Nb7yC3becKlzrcI,3020
@@ -257,7 +257,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
257
257
  regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=sOnkL-c9WIJPHcUjT5_KzxMiVZK574iOBppANc7zRSs,4861
258
258
  regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
259
259
  regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=55PY8Wwn1Nh0msc-ynPZqlkmc6QwsghIy9-ICqvbRcA,5040
260
- regula_documentreader_webclient-7.7.322.dev0.dist-info/METADATA,sha256=E2obIIRbZCgfMaEwy48BsBWfZpB4nVovClkrYFQOnCY,3805
261
- regula_documentreader_webclient-7.7.322.dev0.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
262
- regula_documentreader_webclient-7.7.322.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
263
- regula_documentreader_webclient-7.7.322.dev0.dist-info/RECORD,,
260
+ regula_documentreader_webclient-7.7.323.dev0.dist-info/METADATA,sha256=b3Ag6BtQEHitxwLsR0mOY0DennfUJSwP6mgPEa19T6Q,3805
261
+ regula_documentreader_webclient-7.7.323.dev0.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
262
+ regula_documentreader_webclient-7.7.323.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
263
+ regula_documentreader_webclient-7.7.323.dev0.dist-info/RECORD,,