DetectInfoText.php 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450
  1. <?php
  2. /*
  3. * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace TencentCloud\Faceid\V20180301\Models;
  18. use TencentCloud\Common\AbstractModel;
  19. /**
  20. * 核身文本信息
  21. *
  22. * @method integer getErrCode() 获取本次流程最终验证结果。0为成功
  23. 注意:此字段可能返回 null,表示取不到有效值。
  24. * @method void setErrCode(integer $ErrCode) 设置本次流程最终验证结果。0为成功
  25. 注意:此字段可能返回 null,表示取不到有效值。
  26. * @method string getErrMsg() 获取本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
  27. 注意:此字段可能返回 null,表示取不到有效值。
  28. * @method void setErrMsg(string $ErrMsg) 设置本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
  29. 注意:此字段可能返回 null,表示取不到有效值。
  30. * @method string getIdCard() 获取本次验证使用的身份证号。
  31. 注意:此字段可能返回 null,表示取不到有效值。
  32. * @method void setIdCard(string $IdCard) 设置本次验证使用的身份证号。
  33. 注意:此字段可能返回 null,表示取不到有效值。
  34. * @method string getName() 获取本次验证使用的姓名。
  35. 注意:此字段可能返回 null,表示取不到有效值。
  36. * @method void setName(string $Name) 设置本次验证使用的姓名。
  37. 注意:此字段可能返回 null,表示取不到有效值。
  38. * @method string getOcrNation() 获取Ocr识别结果。民族。
  39. 注意:此字段可能返回 null,表示取不到有效值。
  40. * @method void setOcrNation(string $OcrNation) 设置Ocr识别结果。民族。
  41. 注意:此字段可能返回 null,表示取不到有效值。
  42. * @method string getOcrAddress() 获取Ocr识别结果。家庭住址。
  43. 注意:此字段可能返回 null,表示取不到有效值。
  44. * @method void setOcrAddress(string $OcrAddress) 设置Ocr识别结果。家庭住址。
  45. 注意:此字段可能返回 null,表示取不到有效值。
  46. * @method string getOcrBirth() 获取Ocr识别结果。生日。
  47. 注意:此字段可能返回 null,表示取不到有效值。
  48. * @method void setOcrBirth(string $OcrBirth) 设置Ocr识别结果。生日。
  49. 注意:此字段可能返回 null,表示取不到有效值。
  50. * @method string getOcrAuthority() 获取Ocr识别结果。签发机关。
  51. 注意:此字段可能返回 null,表示取不到有效值。
  52. * @method void setOcrAuthority(string $OcrAuthority) 设置Ocr识别结果。签发机关。
  53. 注意:此字段可能返回 null,表示取不到有效值。
  54. * @method string getOcrValidDate() 获取Ocr识别结果。有效日期。
  55. 注意:此字段可能返回 null,表示取不到有效值。
  56. * @method void setOcrValidDate(string $OcrValidDate) 设置Ocr识别结果。有效日期。
  57. 注意:此字段可能返回 null,表示取不到有效值。
  58. * @method string getOcrName() 获取Ocr识别结果。姓名。
  59. 注意:此字段可能返回 null,表示取不到有效值。
  60. * @method void setOcrName(string $OcrName) 设置Ocr识别结果。姓名。
  61. 注意:此字段可能返回 null,表示取不到有效值。
  62. * @method string getOcrIdCard() 获取Ocr识别结果。身份证号。
  63. 注意:此字段可能返回 null,表示取不到有效值。
  64. * @method void setOcrIdCard(string $OcrIdCard) 设置Ocr识别结果。身份证号。
  65. 注意:此字段可能返回 null,表示取不到有效值。
  66. * @method string getOcrGender() 获取Ocr识别结果。性别。
  67. 注意:此字段可能返回 null,表示取不到有效值。
  68. * @method void setOcrGender(string $OcrGender) 设置Ocr识别结果。性别。
  69. 注意:此字段可能返回 null,表示取不到有效值。
  70. * @method integer getLiveStatus() 获取本次流程最终活体结果。0为成功
  71. 注意:此字段可能返回 null,表示取不到有效值。
  72. * @method void setLiveStatus(integer $LiveStatus) 设置本次流程最终活体结果。0为成功
  73. 注意:此字段可能返回 null,表示取不到有效值。
  74. * @method string getLiveMsg() 获取本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
  75. 注意:此字段可能返回 null,表示取不到有效值。
  76. * @method void setLiveMsg(string $LiveMsg) 设置本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
  77. 注意:此字段可能返回 null,表示取不到有效值。
  78. * @method integer getComparestatus() 获取本次流程最终一比一结果。0为成功
  79. 注意:此字段可能返回 null,表示取不到有效值。
  80. * @method void setComparestatus(integer $Comparestatus) 设置本次流程最终一比一结果。0为成功
  81. 注意:此字段可能返回 null,表示取不到有效值。
  82. * @method string getComparemsg() 获取本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
  83. 注意:此字段可能返回 null,表示取不到有效值。
  84. * @method void setComparemsg(string $Comparemsg) 设置本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
  85. 注意:此字段可能返回 null,表示取不到有效值。
  86. * @method string getSim() 获取本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
  87. 注意:此字段可能返回 null,表示取不到有效值。
  88. * @method void setSim(string $Sim) 设置本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
  89. 注意:此字段可能返回 null,表示取不到有效值。
  90. * @method string getLocation() 获取地理位置经纬度。
  91. 注意:此字段可能返回 null,表示取不到有效值。
  92. * @method void setLocation(string $Location) 设置地理位置经纬度。
  93. 注意:此字段可能返回 null,表示取不到有效值。
  94. * @method string getExtra() 获取Auth接口带入额外信息。
  95. 注意:此字段可能返回 null,表示取不到有效值。
  96. * @method void setExtra(string $Extra) 设置Auth接口带入额外信息。
  97. 注意:此字段可能返回 null,表示取不到有效值。
  98. * @method array getLivenessDetail() 获取本次流程进行的活体一比一流水。
  99. 注意:此字段可能返回 null,表示取不到有效值。
  100. * @method void setLivenessDetail(array $LivenessDetail) 设置本次流程进行的活体一比一流水。
  101. 注意:此字段可能返回 null,表示取不到有效值。
  102. * @method string getMobile() 获取手机号码。
  103. 注意:此字段可能返回 null,表示取不到有效值。
  104. * @method void setMobile(string $Mobile) 设置手机号码。
  105. 注意:此字段可能返回 null,表示取不到有效值。
  106. * @method string getCompareLibType() 获取本次流程最终比对库源类型。包括:
  107. 权威库;
  108. 业务方自有库(用户上传照片、客户的混合库、混合部署库);
  109. 二次验证库;
  110. 人工审核库;
  111. 注意:此字段可能返回 null,表示取不到有效值。
  112. * @method void setCompareLibType(string $CompareLibType) 设置本次流程最终比对库源类型。包括:
  113. 权威库;
  114. 业务方自有库(用户上传照片、客户的混合库、混合部署库);
  115. 二次验证库;
  116. 人工审核库;
  117. 注意:此字段可能返回 null,表示取不到有效值。
  118. * @method integer getLivenessMode() 获取本次流程最终活体类型。包括:
  119. 0:未知
  120. 1:数字活体
  121. 2:动作活体
  122. 3:静默活体
  123. 4:一闪活体(动作+光线)
  124. 注意:此字段可能返回 null,表示取不到有效值。
  125. * @method void setLivenessMode(integer $LivenessMode) 设置本次流程最终活体类型。包括:
  126. 0:未知
  127. 1:数字活体
  128. 2:动作活体
  129. 3:静默活体
  130. 4:一闪活体(动作+光线)
  131. 注意:此字段可能返回 null,表示取不到有效值。
  132. */
  133. class DetectInfoText extends AbstractModel
  134. {
  135. /**
  136. * @var integer 本次流程最终验证结果。0为成功
  137. 注意:此字段可能返回 null,表示取不到有效值。
  138. */
  139. public $ErrCode;
  140. /**
  141. * @var string 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
  142. 注意:此字段可能返回 null,表示取不到有效值。
  143. */
  144. public $ErrMsg;
  145. /**
  146. * @var string 本次验证使用的身份证号。
  147. 注意:此字段可能返回 null,表示取不到有效值。
  148. */
  149. public $IdCard;
  150. /**
  151. * @var string 本次验证使用的姓名。
  152. 注意:此字段可能返回 null,表示取不到有效值。
  153. */
  154. public $Name;
  155. /**
  156. * @var string Ocr识别结果。民族。
  157. 注意:此字段可能返回 null,表示取不到有效值。
  158. */
  159. public $OcrNation;
  160. /**
  161. * @var string Ocr识别结果。家庭住址。
  162. 注意:此字段可能返回 null,表示取不到有效值。
  163. */
  164. public $OcrAddress;
  165. /**
  166. * @var string Ocr识别结果。生日。
  167. 注意:此字段可能返回 null,表示取不到有效值。
  168. */
  169. public $OcrBirth;
  170. /**
  171. * @var string Ocr识别结果。签发机关。
  172. 注意:此字段可能返回 null,表示取不到有效值。
  173. */
  174. public $OcrAuthority;
  175. /**
  176. * @var string Ocr识别结果。有效日期。
  177. 注意:此字段可能返回 null,表示取不到有效值。
  178. */
  179. public $OcrValidDate;
  180. /**
  181. * @var string Ocr识别结果。姓名。
  182. 注意:此字段可能返回 null,表示取不到有效值。
  183. */
  184. public $OcrName;
  185. /**
  186. * @var string Ocr识别结果。身份证号。
  187. 注意:此字段可能返回 null,表示取不到有效值。
  188. */
  189. public $OcrIdCard;
  190. /**
  191. * @var string Ocr识别结果。性别。
  192. 注意:此字段可能返回 null,表示取不到有效值。
  193. */
  194. public $OcrGender;
  195. /**
  196. * @var integer 本次流程最终活体结果。0为成功
  197. 注意:此字段可能返回 null,表示取不到有效值。
  198. */
  199. public $LiveStatus;
  200. /**
  201. * @var string 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
  202. 注意:此字段可能返回 null,表示取不到有效值。
  203. */
  204. public $LiveMsg;
  205. /**
  206. * @var integer 本次流程最终一比一结果。0为成功
  207. 注意:此字段可能返回 null,表示取不到有效值。
  208. */
  209. public $Comparestatus;
  210. /**
  211. * @var string 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
  212. 注意:此字段可能返回 null,表示取不到有效值。
  213. */
  214. public $Comparemsg;
  215. /**
  216. * @var string 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
  217. 注意:此字段可能返回 null,表示取不到有效值。
  218. */
  219. public $Sim;
  220. /**
  221. * @var string 地理位置经纬度。
  222. 注意:此字段可能返回 null,表示取不到有效值。
  223. */
  224. public $Location;
  225. /**
  226. * @var string Auth接口带入额外信息。
  227. 注意:此字段可能返回 null,表示取不到有效值。
  228. */
  229. public $Extra;
  230. /**
  231. * @var array 本次流程进行的活体一比一流水。
  232. 注意:此字段可能返回 null,表示取不到有效值。
  233. */
  234. public $LivenessDetail;
  235. /**
  236. * @var string 手机号码。
  237. 注意:此字段可能返回 null,表示取不到有效值。
  238. */
  239. public $Mobile;
  240. /**
  241. * @var string 本次流程最终比对库源类型。包括:
  242. 权威库;
  243. 业务方自有库(用户上传照片、客户的混合库、混合部署库);
  244. 二次验证库;
  245. 人工审核库;
  246. 注意:此字段可能返回 null,表示取不到有效值。
  247. */
  248. public $CompareLibType;
  249. /**
  250. * @var integer 本次流程最终活体类型。包括:
  251. 0:未知
  252. 1:数字活体
  253. 2:动作活体
  254. 3:静默活体
  255. 4:一闪活体(动作+光线)
  256. 注意:此字段可能返回 null,表示取不到有效值。
  257. */
  258. public $LivenessMode;
  259. /**
  260. * @param integer $ErrCode 本次流程最终验证结果。0为成功
  261. 注意:此字段可能返回 null,表示取不到有效值。
  262. * @param string $ErrMsg 本次流程最终验证结果描述。(仅描述用,文案更新时不会通知。)
  263. 注意:此字段可能返回 null,表示取不到有效值。
  264. * @param string $IdCard 本次验证使用的身份证号。
  265. 注意:此字段可能返回 null,表示取不到有效值。
  266. * @param string $Name 本次验证使用的姓名。
  267. 注意:此字段可能返回 null,表示取不到有效值。
  268. * @param string $OcrNation Ocr识别结果。民族。
  269. 注意:此字段可能返回 null,表示取不到有效值。
  270. * @param string $OcrAddress Ocr识别结果。家庭住址。
  271. 注意:此字段可能返回 null,表示取不到有效值。
  272. * @param string $OcrBirth Ocr识别结果。生日。
  273. 注意:此字段可能返回 null,表示取不到有效值。
  274. * @param string $OcrAuthority Ocr识别结果。签发机关。
  275. 注意:此字段可能返回 null,表示取不到有效值。
  276. * @param string $OcrValidDate Ocr识别结果。有效日期。
  277. 注意:此字段可能返回 null,表示取不到有效值。
  278. * @param string $OcrName Ocr识别结果。姓名。
  279. 注意:此字段可能返回 null,表示取不到有效值。
  280. * @param string $OcrIdCard Ocr识别结果。身份证号。
  281. 注意:此字段可能返回 null,表示取不到有效值。
  282. * @param string $OcrGender Ocr识别结果。性别。
  283. 注意:此字段可能返回 null,表示取不到有效值。
  284. * @param integer $LiveStatus 本次流程最终活体结果。0为成功
  285. 注意:此字段可能返回 null,表示取不到有效值。
  286. * @param string $LiveMsg 本次流程最终活体结果描述。(仅描述用,文案更新时不会通知。)
  287. 注意:此字段可能返回 null,表示取不到有效值。
  288. * @param integer $Comparestatus 本次流程最终一比一结果。0为成功
  289. 注意:此字段可能返回 null,表示取不到有效值。
  290. * @param string $Comparemsg 本次流程最终一比一结果描述。(仅描述用,文案更新时不会通知。)
  291. 注意:此字段可能返回 null,表示取不到有效值。
  292. * @param string $Sim 本次流程活体一比一的分数,取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人,也可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)
  293. 注意:此字段可能返回 null,表示取不到有效值。
  294. * @param string $Location 地理位置经纬度。
  295. 注意:此字段可能返回 null,表示取不到有效值。
  296. * @param string $Extra Auth接口带入额外信息。
  297. 注意:此字段可能返回 null,表示取不到有效值。
  298. * @param array $LivenessDetail 本次流程进行的活体一比一流水。
  299. 注意:此字段可能返回 null,表示取不到有效值。
  300. * @param string $Mobile 手机号码。
  301. 注意:此字段可能返回 null,表示取不到有效值。
  302. * @param string $CompareLibType 本次流程最终比对库源类型。包括:
  303. 权威库;
  304. 业务方自有库(用户上传照片、客户的混合库、混合部署库);
  305. 二次验证库;
  306. 人工审核库;
  307. 注意:此字段可能返回 null,表示取不到有效值。
  308. * @param integer $LivenessMode 本次流程最终活体类型。包括:
  309. 0:未知
  310. 1:数字活体
  311. 2:动作活体
  312. 3:静默活体
  313. 4:一闪活体(动作+光线)
  314. 注意:此字段可能返回 null,表示取不到有效值。
  315. */
  316. function __construct()
  317. {
  318. }
  319. /**
  320. * For internal only. DO NOT USE IT.
  321. */
  322. public function deserialize($param)
  323. {
  324. if ($param === null) {
  325. return;
  326. }
  327. if (array_key_exists("ErrCode",$param) and $param["ErrCode"] !== null) {
  328. $this->ErrCode = $param["ErrCode"];
  329. }
  330. if (array_key_exists("ErrMsg",$param) and $param["ErrMsg"] !== null) {
  331. $this->ErrMsg = $param["ErrMsg"];
  332. }
  333. if (array_key_exists("IdCard",$param) and $param["IdCard"] !== null) {
  334. $this->IdCard = $param["IdCard"];
  335. }
  336. if (array_key_exists("Name",$param) and $param["Name"] !== null) {
  337. $this->Name = $param["Name"];
  338. }
  339. if (array_key_exists("OcrNation",$param) and $param["OcrNation"] !== null) {
  340. $this->OcrNation = $param["OcrNation"];
  341. }
  342. if (array_key_exists("OcrAddress",$param) and $param["OcrAddress"] !== null) {
  343. $this->OcrAddress = $param["OcrAddress"];
  344. }
  345. if (array_key_exists("OcrBirth",$param) and $param["OcrBirth"] !== null) {
  346. $this->OcrBirth = $param["OcrBirth"];
  347. }
  348. if (array_key_exists("OcrAuthority",$param) and $param["OcrAuthority"] !== null) {
  349. $this->OcrAuthority = $param["OcrAuthority"];
  350. }
  351. if (array_key_exists("OcrValidDate",$param) and $param["OcrValidDate"] !== null) {
  352. $this->OcrValidDate = $param["OcrValidDate"];
  353. }
  354. if (array_key_exists("OcrName",$param) and $param["OcrName"] !== null) {
  355. $this->OcrName = $param["OcrName"];
  356. }
  357. if (array_key_exists("OcrIdCard",$param) and $param["OcrIdCard"] !== null) {
  358. $this->OcrIdCard = $param["OcrIdCard"];
  359. }
  360. if (array_key_exists("OcrGender",$param) and $param["OcrGender"] !== null) {
  361. $this->OcrGender = $param["OcrGender"];
  362. }
  363. if (array_key_exists("LiveStatus",$param) and $param["LiveStatus"] !== null) {
  364. $this->LiveStatus = $param["LiveStatus"];
  365. }
  366. if (array_key_exists("LiveMsg",$param) and $param["LiveMsg"] !== null) {
  367. $this->LiveMsg = $param["LiveMsg"];
  368. }
  369. if (array_key_exists("Comparestatus",$param) and $param["Comparestatus"] !== null) {
  370. $this->Comparestatus = $param["Comparestatus"];
  371. }
  372. if (array_key_exists("Comparemsg",$param) and $param["Comparemsg"] !== null) {
  373. $this->Comparemsg = $param["Comparemsg"];
  374. }
  375. if (array_key_exists("Sim",$param) and $param["Sim"] !== null) {
  376. $this->Sim = $param["Sim"];
  377. }
  378. if (array_key_exists("Location",$param) and $param["Location"] !== null) {
  379. $this->Location = $param["Location"];
  380. }
  381. if (array_key_exists("Extra",$param) and $param["Extra"] !== null) {
  382. $this->Extra = $param["Extra"];
  383. }
  384. if (array_key_exists("LivenessDetail",$param) and $param["LivenessDetail"] !== null) {
  385. $this->LivenessDetail = [];
  386. foreach ($param["LivenessDetail"] as $key => $value){
  387. $obj = new DetectDetail();
  388. $obj->deserialize($value);
  389. array_push($this->LivenessDetail, $obj);
  390. }
  391. }
  392. if (array_key_exists("Mobile",$param) and $param["Mobile"] !== null) {
  393. $this->Mobile = $param["Mobile"];
  394. }
  395. if (array_key_exists("CompareLibType",$param) and $param["CompareLibType"] !== null) {
  396. $this->CompareLibType = $param["CompareLibType"];
  397. }
  398. if (array_key_exists("LivenessMode",$param) and $param["LivenessMode"] !== null) {
  399. $this->LivenessMode = $param["LivenessMode"];
  400. }
  401. }
  402. }