CardVerifyResult.php 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  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. * 核身过程中,鉴伪或OCR单次结果。
  21. *
  22. * @method boolean getIsPass() 获取鉴伪或OCR是否成功
  23. * @method void setIsPass(boolean $IsPass) 设置鉴伪或OCR是否成功
  24. * @method FileInfo getCardVideo() 获取身份证鉴伪视频,仅开启证件视频鉴伪功能时返回,url链接有效期10分钟。
  25. 注意:此字段可能返回 null,表示取不到有效值。
  26. * @method void setCardVideo(FileInfo $CardVideo) 设置身份证鉴伪视频,仅开启证件视频鉴伪功能时返回,url链接有效期10分钟。
  27. 注意:此字段可能返回 null,表示取不到有效值。
  28. * @method FileInfo getCardImage() 获取证件照图片,url链接有效期10分钟。
  29. 注意:此字段可能返回 null,表示取不到有效值。
  30. * @method void setCardImage(FileInfo $CardImage) 设置证件照图片,url链接有效期10分钟。
  31. 注意:此字段可能返回 null,表示取不到有效值。
  32. * @method FileInfo getCardInfoOcrJson() 获取证件照的文字识别结果,如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
  33. IdCardType为HK时:
  34. - CnName string 中文姓名
  35. - EnName string 英文姓名
  36. - TelexCode string 中文姓名对应电码
  37. - Sex string 性别 :“男M”或“女F”
  38. - Birthday string 出生日期
  39. - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
  40. - IdNum string 身份证号码
  41. - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
  42. - FirstIssueDate string 首次签发日期
  43. - CurrentIssueDate string 最近领用日期
  44. IdCardType为ML时:
  45. - Sex string 男:LELAKI 女:PEREMPUAN
  46. - Birthday string 生日
  47. - ID string 证号
  48. - Name string 名字
  49. - Address string 地址
  50. - Type string 证件类型
  51. IdCardType为PhilippinesVoteID时:
  52. - Birthday string 生日
  53. - Address string 地址
  54. - LastName string 姓氏
  55. - FirstName string 姓名
  56. - VIN string VIN号
  57. - CivilStatus string 婚姻状况
  58. - Citizenship string 国籍
  59. - PrecinctNo string 地区
  60. IdCardType为PhilippinesDrivingLicense时:
  61. - Sex string 性别
  62. - Birthday string 生日
  63. - Name string 姓名
  64. - Address string 地址
  65. - LastName string 姓氏
  66. - FirstName string 首姓名
  67. - MiddleName string 中间姓名
  68. - Nationality string 国籍
  69. - LicenseNo string 证号
  70. - ExpiresDate string 有效期
  71. - AgencyCode string 机构代码
  72. 注意:此字段可能返回 null,表示取不到有效值。
  73. * @method void setCardInfoOcrJson(FileInfo $CardInfoOcrJson) 设置证件照的文字识别结果,如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
  74. IdCardType为HK时:
  75. - CnName string 中文姓名
  76. - EnName string 英文姓名
  77. - TelexCode string 中文姓名对应电码
  78. - Sex string 性别 :“男M”或“女F”
  79. - Birthday string 出生日期
  80. - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
  81. - IdNum string 身份证号码
  82. - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
  83. - FirstIssueDate string 首次签发日期
  84. - CurrentIssueDate string 最近领用日期
  85. IdCardType为ML时:
  86. - Sex string 男:LELAKI 女:PEREMPUAN
  87. - Birthday string 生日
  88. - ID string 证号
  89. - Name string 名字
  90. - Address string 地址
  91. - Type string 证件类型
  92. IdCardType为PhilippinesVoteID时:
  93. - Birthday string 生日
  94. - Address string 地址
  95. - LastName string 姓氏
  96. - FirstName string 姓名
  97. - VIN string VIN号
  98. - CivilStatus string 婚姻状况
  99. - Citizenship string 国籍
  100. - PrecinctNo string 地区
  101. IdCardType为PhilippinesDrivingLicense时:
  102. - Sex string 性别
  103. - Birthday string 生日
  104. - Name string 姓名
  105. - Address string 地址
  106. - LastName string 姓氏
  107. - FirstName string 首姓名
  108. - MiddleName string 中间姓名
  109. - Nationality string 国籍
  110. - LicenseNo string 证号
  111. - ExpiresDate string 有效期
  112. - AgencyCode string 机构代码
  113. 注意:此字段可能返回 null,表示取不到有效值。
  114. * @method string getRequestId() 获取单次流程请求标示。
  115. * @method void setRequestId(string $RequestId) 设置单次流程请求标示。
  116. */
  117. class CardVerifyResult extends AbstractModel
  118. {
  119. /**
  120. * @var boolean 鉴伪或OCR是否成功
  121. */
  122. public $IsPass;
  123. /**
  124. * @var FileInfo 身份证鉴伪视频,仅开启证件视频鉴伪功能时返回,url链接有效期10分钟。
  125. 注意:此字段可能返回 null,表示取不到有效值。
  126. */
  127. public $CardVideo;
  128. /**
  129. * @var FileInfo 证件照图片,url链接有效期10分钟。
  130. 注意:此字段可能返回 null,表示取不到有效值。
  131. */
  132. public $CardImage;
  133. /**
  134. * @var FileInfo 证件照的文字识别结果,如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
  135. IdCardType为HK时:
  136. - CnName string 中文姓名
  137. - EnName string 英文姓名
  138. - TelexCode string 中文姓名对应电码
  139. - Sex string 性别 :“男M”或“女F”
  140. - Birthday string 出生日期
  141. - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
  142. - IdNum string 身份证号码
  143. - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
  144. - FirstIssueDate string 首次签发日期
  145. - CurrentIssueDate string 最近领用日期
  146. IdCardType为ML时:
  147. - Sex string 男:LELAKI 女:PEREMPUAN
  148. - Birthday string 生日
  149. - ID string 证号
  150. - Name string 名字
  151. - Address string 地址
  152. - Type string 证件类型
  153. IdCardType为PhilippinesVoteID时:
  154. - Birthday string 生日
  155. - Address string 地址
  156. - LastName string 姓氏
  157. - FirstName string 姓名
  158. - VIN string VIN号
  159. - CivilStatus string 婚姻状况
  160. - Citizenship string 国籍
  161. - PrecinctNo string 地区
  162. IdCardType为PhilippinesDrivingLicense时:
  163. - Sex string 性别
  164. - Birthday string 生日
  165. - Name string 姓名
  166. - Address string 地址
  167. - LastName string 姓氏
  168. - FirstName string 首姓名
  169. - MiddleName string 中间姓名
  170. - Nationality string 国籍
  171. - LicenseNo string 证号
  172. - ExpiresDate string 有效期
  173. - AgencyCode string 机构代码
  174. 注意:此字段可能返回 null,表示取不到有效值。
  175. */
  176. public $CardInfoOcrJson;
  177. /**
  178. * @var string 单次流程请求标示。
  179. */
  180. public $RequestId;
  181. /**
  182. * @param boolean $IsPass 鉴伪或OCR是否成功
  183. * @param FileInfo $CardVideo 身份证鉴伪视频,仅开启证件视频鉴伪功能时返回,url链接有效期10分钟。
  184. 注意:此字段可能返回 null,表示取不到有效值。
  185. * @param FileInfo $CardImage 证件照图片,url链接有效期10分钟。
  186. 注意:此字段可能返回 null,表示取不到有效值。
  187. * @param FileInfo $CardInfoOcrJson 证件照的文字识别结果,如果鉴伪失败或者ocr失败则该参数为空。url链接有效期10分钟。格式为json文本信息。
  188. IdCardType为HK时:
  189. - CnName string 中文姓名
  190. - EnName string 英文姓名
  191. - TelexCode string 中文姓名对应电码
  192. - Sex string 性别 :“男M”或“女F”
  193. - Birthday string 出生日期
  194. - Permanent int 永久性居民身份证。0:非永久; 1:永久; -1:未知。
  195. - IdNum string 身份证号码
  196. - Symbol string 证件符号,出生日期下的符号,例如"***AZ"
  197. - FirstIssueDate string 首次签发日期
  198. - CurrentIssueDate string 最近领用日期
  199. IdCardType为ML时:
  200. - Sex string 男:LELAKI 女:PEREMPUAN
  201. - Birthday string 生日
  202. - ID string 证号
  203. - Name string 名字
  204. - Address string 地址
  205. - Type string 证件类型
  206. IdCardType为PhilippinesVoteID时:
  207. - Birthday string 生日
  208. - Address string 地址
  209. - LastName string 姓氏
  210. - FirstName string 姓名
  211. - VIN string VIN号
  212. - CivilStatus string 婚姻状况
  213. - Citizenship string 国籍
  214. - PrecinctNo string 地区
  215. IdCardType为PhilippinesDrivingLicense时:
  216. - Sex string 性别
  217. - Birthday string 生日
  218. - Name string 姓名
  219. - Address string 地址
  220. - LastName string 姓氏
  221. - FirstName string 首姓名
  222. - MiddleName string 中间姓名
  223. - Nationality string 国籍
  224. - LicenseNo string 证号
  225. - ExpiresDate string 有效期
  226. - AgencyCode string 机构代码
  227. 注意:此字段可能返回 null,表示取不到有效值。
  228. * @param string $RequestId 单次流程请求标示。
  229. */
  230. function __construct()
  231. {
  232. }
  233. /**
  234. * For internal only. DO NOT USE IT.
  235. */
  236. public function deserialize($param)
  237. {
  238. if ($param === null) {
  239. return;
  240. }
  241. if (array_key_exists("IsPass",$param) and $param["IsPass"] !== null) {
  242. $this->IsPass = $param["IsPass"];
  243. }
  244. if (array_key_exists("CardVideo",$param) and $param["CardVideo"] !== null) {
  245. $this->CardVideo = new FileInfo();
  246. $this->CardVideo->deserialize($param["CardVideo"]);
  247. }
  248. if (array_key_exists("CardImage",$param) and $param["CardImage"] !== null) {
  249. $this->CardImage = new FileInfo();
  250. $this->CardImage->deserialize($param["CardImage"]);
  251. }
  252. if (array_key_exists("CardInfoOcrJson",$param) and $param["CardInfoOcrJson"] !== null) {
  253. $this->CardInfoOcrJson = new FileInfo();
  254. $this->CardInfoOcrJson->deserialize($param["CardInfoOcrJson"]);
  255. }
  256. if (array_key_exists("RequestId",$param) and $param["RequestId"] !== null) {
  257. $this->RequestId = $param["RequestId"];
  258. }
  259. }
  260. }