CheckIdCardInformationRequest.php 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  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. * CheckIdCardInformation请求参数结构体
  21. *
  22. * @method string getImageBase64() 获取身份证人像面的 Base64 值
  23. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  24. 支持的图片大小:所下载图片经Base64编码后不超过 7M。
  25. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  26. ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
  27. * @method void setImageBase64(string $ImageBase64) 设置身份证人像面的 Base64 值
  28. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  29. 支持的图片大小:所下载图片经Base64编码后不超过 7M。
  30. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  31. ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
  32. * @method string getImageUrl() 获取身份证人像面的 Url 地址
  33. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  34. 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
  35. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
  36. 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  37. * @method void setImageUrl(string $ImageUrl) 设置身份证人像面的 Url 地址
  38. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  39. 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
  40. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
  41. 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  42. * @method string getConfig() 获取以下可选字段均为bool 类型,默认false:
  43. CopyWarn,复印件告警
  44. BorderCheckWarn,边框和框内遮挡告警
  45. ReshootWarn,翻拍告警
  46. DetectPsWarn,PS检测告警
  47. TempIdWarn,临时身份证告警
  48. Quality,图片质量告警(评价图片模糊程度)
  49. SDK 设置方式参考:
  50. Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
  51. API 3.0 Explorer 设置方式参考:
  52. Config = {"CopyWarn":true,"ReshootWarn":true}
  53. * @method void setConfig(string $Config) 设置以下可选字段均为bool 类型,默认false:
  54. CopyWarn,复印件告警
  55. BorderCheckWarn,边框和框内遮挡告警
  56. ReshootWarn,翻拍告警
  57. DetectPsWarn,PS检测告警
  58. TempIdWarn,临时身份证告警
  59. Quality,图片质量告警(评价图片模糊程度)
  60. SDK 设置方式参考:
  61. Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
  62. API 3.0 Explorer 设置方式参考:
  63. Config = {"CopyWarn":true,"ReshootWarn":true}
  64. * @method boolean getIsEncrypt() 获取是否需要对返回中的敏感信息进行加密。默认false。
  65. 其中敏感信息包括:Response.IdNum、Response.Name
  66. * @method void setIsEncrypt(boolean $IsEncrypt) 设置是否需要对返回中的敏感信息进行加密。默认false。
  67. 其中敏感信息包括:Response.IdNum、Response.Name
  68. */
  69. class CheckIdCardInformationRequest extends AbstractModel
  70. {
  71. /**
  72. * @var string 身份证人像面的 Base64 值
  73. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  74. 支持的图片大小:所下载图片经Base64编码后不超过 7M。
  75. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  76. ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
  77. */
  78. public $ImageBase64;
  79. /**
  80. * @var string 身份证人像面的 Url 地址
  81. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  82. 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
  83. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
  84. 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  85. */
  86. public $ImageUrl;
  87. /**
  88. * @var string 以下可选字段均为bool 类型,默认false:
  89. CopyWarn,复印件告警
  90. BorderCheckWarn,边框和框内遮挡告警
  91. ReshootWarn,翻拍告警
  92. DetectPsWarn,PS检测告警
  93. TempIdWarn,临时身份证告警
  94. Quality,图片质量告警(评价图片模糊程度)
  95. SDK 设置方式参考:
  96. Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
  97. API 3.0 Explorer 设置方式参考:
  98. Config = {"CopyWarn":true,"ReshootWarn":true}
  99. */
  100. public $Config;
  101. /**
  102. * @var boolean 是否需要对返回中的敏感信息进行加密。默认false。
  103. 其中敏感信息包括:Response.IdNum、Response.Name
  104. */
  105. public $IsEncrypt;
  106. /**
  107. * @param string $ImageBase64 身份证人像面的 Base64 值
  108. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  109. 支持的图片大小:所下载图片经Base64编码后不超过 7M。
  110. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  111. ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。
  112. * @param string $ImageUrl 身份证人像面的 Url 地址
  113. 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
  114. 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
  115. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
  116. 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  117. * @param string $Config 以下可选字段均为bool 类型,默认false:
  118. CopyWarn,复印件告警
  119. BorderCheckWarn,边框和框内遮挡告警
  120. ReshootWarn,翻拍告警
  121. DetectPsWarn,PS检测告警
  122. TempIdWarn,临时身份证告警
  123. Quality,图片质量告警(评价图片模糊程度)
  124. SDK 设置方式参考:
  125. Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true})
  126. API 3.0 Explorer 设置方式参考:
  127. Config = {"CopyWarn":true,"ReshootWarn":true}
  128. * @param boolean $IsEncrypt 是否需要对返回中的敏感信息进行加密。默认false。
  129. 其中敏感信息包括:Response.IdNum、Response.Name
  130. */
  131. function __construct()
  132. {
  133. }
  134. /**
  135. * For internal only. DO NOT USE IT.
  136. */
  137. public function deserialize($param)
  138. {
  139. if ($param === null) {
  140. return;
  141. }
  142. if (array_key_exists("ImageBase64",$param) and $param["ImageBase64"] !== null) {
  143. $this->ImageBase64 = $param["ImageBase64"];
  144. }
  145. if (array_key_exists("ImageUrl",$param) and $param["ImageUrl"] !== null) {
  146. $this->ImageUrl = $param["ImageUrl"];
  147. }
  148. if (array_key_exists("Config",$param) and $param["Config"] !== null) {
  149. $this->Config = $param["Config"];
  150. }
  151. if (array_key_exists("IsEncrypt",$param) and $param["IsEncrypt"] !== null) {
  152. $this->IsEncrypt = $param["IsEncrypt"];
  153. }
  154. }
  155. }