FaceidClient.php 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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;
  18. use TencentCloud\Common\AbstractClient;
  19. use TencentCloud\Common\Profile\ClientProfile;
  20. use TencentCloud\Common\Credential;
  21. use TencentCloud\Faceid\V20180301\Models as Models;
  22. /**
  23. * @method Models\ApplyLivenessTokenResponse ApplyLivenessToken(Models\ApplyLivenessTokenRequest $req) 每次调用活体服务前,需要先调用本接口获取Token,需要保存此Token用来发起核验流程,并且在核验完成后获取结果信息。
  24. * @method Models\ApplySdkVerificationTokenResponse ApplySdkVerificationToken(Models\ApplySdkVerificationTokenRequest $req) 每次调用Web核验服务前,需要先调用本接口获取Token,需要保存此Token用来发起核验流程,并且在核验完成后获取结果信息。
  25. * @method Models\ApplyWebVerificationTokenResponse ApplyWebVerificationToken(Models\ApplyWebVerificationTokenRequest $req) 每次调用Web核验服务前,需要先调用本接口获取BizToken,需要保存此BizToken用来发起核验流程,并且在核验完成后获取结果信息。
  26. * @method Models\BankCard2EVerificationResponse BankCard2EVerification(Models\BankCard2EVerificationRequest $req) 本接口用于校验姓名和银行卡号的真实性和一致性。
  27. * @method Models\BankCard4EVerificationResponse BankCard4EVerification(Models\BankCard4EVerificationRequest $req) 本接口用于输入银行卡号、姓名、开户证件号、开户手机号,校验信息的真实性和一致性。
  28. * @method Models\BankCardVerificationResponse BankCardVerification(Models\BankCardVerificationRequest $req) 本接口用于银行卡号、姓名、开户证件号信息的真实性和一致性。
  29. * @method Models\CheckBankCardInformationResponse CheckBankCardInformation(Models\CheckBankCardInformationRequest $req) 银行卡基础信息查询
  30. * @method Models\CheckEidTokenStatusResponse CheckEidTokenStatus(Models\CheckEidTokenStatusRequest $req) 用于轮询E证通H5场景EidToken验证状态。
  31. * @method Models\CheckIdCardInformationResponse CheckIdCardInformation(Models\CheckIdCardInformationRequest $req) 传入身份证人像面照片,识别身份证照片上的信息,并将姓名、身份证号、身份证人像照片与权威库的证件照进行比对,是否属于同一个人,从而验证身份证信息的真实性。
  32. * @method Models\CheckIdNameDateResponse CheckIdNameDate(Models\CheckIdNameDateRequest $req) 本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。
  33. * @method Models\CheckPhoneAndNameResponse CheckPhoneAndName(Models\CheckPhoneAndNameRequest $req) 手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
  34. * @method Models\CreateUploadUrlResponse CreateUploadUrl(Models\CreateUploadUrlRequest $req) 生成一个临时的UploadUrl用于上传资源文件,客户需要使用HTTP PUT方法上传,上传完成后将ResourceUrl传给TargetAction对应接口完成资源传递(具体字段由使用场景确定)。
  35. 数据存储于Region参数对应地域的腾讯云COS Bucket,存储有效期2小时。
  36. * @method Models\DetectAuthResponse DetectAuth(Models\DetectAuthRequest $req) 每次调用人脸核身SaaS化服务前,需先调用本接口获取BizToken,用来串联核身流程,在验证完成后,用于获取验证结果信息。
  37. * @method Models\DetectReflectLivenessAndCompareResponse DetectReflectLivenessAndCompare(Models\DetectReflectLivenessAndCompareRequest $req) 使用活体比对(光线)SDK生成的数据包检测活体,并和传入的图片进行比对。
  38. 图片和SDK生成的数据内容必须存储在腾讯云COS,COS Bucket所在的Region需要和本接口请求的Region保持一致,推荐使用生成上传链接接口来完成资源传递。
  39. * @method Models\EncryptedPhoneVerificationResponse EncryptedPhoneVerification(Models\EncryptedPhoneVerificationRequest $req) 本接口用于校验手机号、姓名和身份证号的真实性和一致性,入参支持明文、MD5和SHA256加密传输。
  40. * @method Models\GenerateReflectSequenceResponse GenerateReflectSequence(Models\GenerateReflectSequenceRequest $req) 根据活体比对(光线)SDK采集的机器信息生成适合的光线序列,将光线序列传入SDK后开启核身。
  41. SDK生成的数据内容必须存储在腾讯云COS,COS Bucket所在的Region需要和本接口请求的Region保持一致,推荐使用生成上传链接接口来完成资源传递。
  42. * @method Models\GetActionSequenceResponse GetActionSequence(Models\GetActionSequenceRequest $req) 使用动作活体检测模式前,需调用本接口获取动作顺序。
  43. * @method Models\GetDetectInfoResponse GetDetectInfo(Models\GetDetectInfoRequest $req) 完成验证后,用BizToken调用本接口获取结果信息,BizToken生成后三天内(3\*24\*3,600秒)可多次拉取。
  44. * @method Models\GetDetectInfoEnhancedResponse GetDetectInfoEnhanced(Models\GetDetectInfoEnhancedRequest $req) 完成验证后,用BizToken调用本接口获取结果信息,BizToken生成后三天内(3\*24\*3,600秒)可多次拉取。
  45. * @method Models\GetEidResultResponse GetEidResult(Models\GetEidResultRequest $req) 完成验证后,用EidToken调用本接口获取结果信息,EidToken生成后三天内(3\*24\*3,600秒)可多次拉取。
  46. * @method Models\GetEidTokenResponse GetEidToken(Models\GetEidTokenRequest $req) 每次调用E证通服务前,需先调用本接口获取EidToken,用来串联E证通流程,在验证完成后,用于获取E证通结果信息。
  47. * @method Models\GetFaceIdResultResponse GetFaceIdResult(Models\GetFaceIdResultRequest $req) 完成验证后,用FaceIdToken调用本接口获取结果信息,FaceIdToken生成后三天内(3\*24\*3,600秒)可多次拉取。
  48. * @method Models\GetFaceIdTokenResponse GetFaceIdToken(Models\GetFaceIdTokenRequest $req) 每次调用人脸核身SDK服务前,需先调用本接口获取SDKToken,用来串联核身流程,在验证完成后,用于获取验证结果信息,该token仅能核身一次。
  49. * @method Models\GetLiveCodeResponse GetLiveCode(Models\GetLiveCodeRequest $req) 使用数字活体检测模式前,需调用本接口获取数字验证码。
  50. * @method Models\GetLivenessResultResponse GetLivenessResult(Models\GetLivenessResultRequest $req) 完成活体检测流程后,用核验令牌(SdkToken)调用本接口查询对应核验结果信息。Token申请后2小时内有效,可多次调用。
  51. * @method Models\GetRealNameAuthResultResponse GetRealNameAuthResult(Models\GetRealNameAuthResultRequest $req) 获取微信实名认证结果
  52. * @method Models\GetRealNameAuthTokenResponse GetRealNameAuthToken(Models\GetRealNameAuthTokenRequest $req) 该接口仅限微信公众号中使用,传入姓名和身份证号获取回调URL,在微信公众号中打开验证姓名和身份证号与微信实名的信息是否一致。
  53. * @method Models\GetSdkVerificationResultResponse GetSdkVerificationResult(Models\GetSdkVerificationResultRequest $req) 完成Sdk核验流程后,用核验令牌(Token)调用本接口查询对应核验结果信息。Token申请后三天内有效,可多次调用。
  54. * @method Models\GetWeChatBillDetailsResponse GetWeChatBillDetails(Models\GetWeChatBillDetailsRequest $req) 查询微信渠道服务(微信小程序、微信原生H5、微信普通H5)的账单明细及计费状态。
  55. * @method Models\GetWebVerificationResultResponse GetWebVerificationResult(Models\GetWebVerificationResultRequest $req) 完成Web核验流程后,用核验令牌(BizToken)调用本接口查询对应核验结果信息。BizToken申请后三天内(3\*24\*3,600秒)有效,可多次调用。
  56. * @method Models\IdCardOCRVerificationResponse IdCardOCRVerification(Models\IdCardOCRVerificationRequest $req) 本接口用于校验姓名和身份证号的真实性和一致性,您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。
  57. * @method Models\IdCardVerificationResponse IdCardVerification(Models\IdCardVerificationRequest $req) 传入姓名和身份证号,校验两者的真实性和一致性。
  58. * @method Models\ImageRecognitionResponse ImageRecognition(Models\ImageRecognitionRequest $req) 传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人。
  59. * @method Models\LivenessResponse Liveness(Models\LivenessRequest $req) 活体检测
  60. * @method Models\LivenessCompareResponse LivenessCompare(Models\LivenessCompareRequest $req) 传入视频和照片,先判断视频中是否为真人,判断为真人后,再判断该视频中的人与上传照片是否属于同一个人。
  61. * @method Models\LivenessRecognitionResponse LivenessRecognition(Models\LivenessRecognitionRequest $req) 传入视频和身份信息,先判断视频中是否为真人,判断为真人后,再判断该视频中的人与权威库的证件照是否属于同一个人。
  62. * @method Models\MinorsVerificationResponse MinorsVerification(Models\MinorsVerificationRequest $req) 通过传入手机号或姓名和身份证号,结合权威数据源和腾讯健康守护可信模型,判断该信息是否真实且年满18周岁。腾讯健康守护可信模型覆盖了上十亿手机库源,覆盖率高、准确率高,如果不在库中的手机号,还可以通过姓名+身份证进行兜底验证。
  63. * @method Models\MobileNetworkTimeVerificationResponse MobileNetworkTimeVerification(Models\MobileNetworkTimeVerificationRequest $req) 本接口用于查询手机号在网时长,输入手机号进行查询。
  64. * @method Models\MobileStatusResponse MobileStatus(Models\MobileStatusRequest $req) 本接口用于验证手机号的状态,您可以输入手机号进行查询。
  65. * @method Models\ParseNfcDataResponse ParseNfcData(Models\ParseNfcDataRequest $req) 解析SDK获取到的证件NFC数据,接口传入SDK返回的ReqId,返回证件信息(个别字段为特定证件类型特有)。SDK生成的ReqId五分钟内有效,重复查询仅收一次费。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。
  66. * @method Models\PhoneVerificationResponse PhoneVerification(Models\PhoneVerificationRequest $req) 本接口用于校验手机号、姓名和身份证号的真实性和一致性。支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
  67. * @method Models\PhoneVerificationCMCCResponse PhoneVerificationCMCC(Models\PhoneVerificationCMCCRequest $req) 本接口用于校验中国移动手机号、姓名和身份证号的真实性和一致性。中国移动支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
  68. * @method Models\PhoneVerificationCTCCResponse PhoneVerificationCTCC(Models\PhoneVerificationCTCCRequest $req) 本接口用于校验中国电信手机号、姓名和身份证号的真实性和一致性。中国电信支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
  69. * @method Models\PhoneVerificationCUCCResponse PhoneVerificationCUCC(Models\PhoneVerificationCUCCRequest $req) 本接口用于校验中国联通手机号、姓名和身份证号的真实性和一致性。中国联通支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
  70. * @method Models\VideoLivenessCompareResponse VideoLivenessCompare(Models\VideoLivenessCompareRequest $req) 传入视频和照片地址,先判断视频中是否为真人,判断为真人后,再判断该视频中的人与上传照片是否属于同一个人。
  71. */
  72. class FaceidClient extends AbstractClient
  73. {
  74. /**
  75. * @var string
  76. */
  77. protected $endpoint = "faceid.tencentcloudapi.com";
  78. /**
  79. * @var string
  80. */
  81. protected $service = "faceid";
  82. /**
  83. * @var string
  84. */
  85. protected $version = "2018-03-01";
  86. /**
  87. * @param Credential $credential
  88. * @param string $region
  89. * @param ClientProfile|null $profile
  90. * @throws TencentCloudSDKException
  91. */
  92. function __construct($credential, $region, $profile=null)
  93. {
  94. parent::__construct($this->endpoint, $this->version, $credential, $region, $profile);
  95. }
  96. public function returnResponse($action, $response)
  97. {
  98. $respClass = "TencentCloud"."\\".ucfirst("faceid")."\\"."V20180301\\Models"."\\".ucfirst($action)."Response";
  99. $obj = new $respClass();
  100. $obj->deserialize($response);
  101. return $obj;
  102. }
  103. }