diff options
Diffstat (limited to 'data/zh_cn/cloudauth/2019-03-07')
| -rw-r--r-- | data/zh_cn/cloudauth/2019-03-07/api-docs.php | 17511 |
1 files changed, 17511 insertions, 0 deletions
diff --git a/data/zh_cn/cloudauth/2019-03-07/api-docs.php b/data/zh_cn/cloudauth/2019-03-07/api-docs.php new file mode 100644 index 0000000..473cb7e --- /dev/null +++ b/data/zh_cn/cloudauth/2019-03-07/api-docs.php @@ -0,0 +1,17511 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cloudauth', + 'version' => '2019-03-07', + ], + 'directories' => [ + [ + 'id' => 172202, + 'title' => '金融级实人', + 'type' => 'directory', + 'children' => [ + 'LivenessFaceVerify', + 'CompareFaceVerify', + 'ContrastFaceVerify', + 'DescribeFaceVerify', + 'InitFaceVerify', + 'DescribeFaceGuardRisk', + 'AIGCFaceVerify', + 'DeleteFaceVerifyResult', + ], + ], + [ + 'id' => 187371, + 'title' => '信息核验', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 322831, + 'title' => '人脸检测', + 'type' => 'directory', + 'children' => [ + 'DeepfakeDetect', + ], + ], + [ + 'id' => 322832, + 'title' => '凭证检测', + 'type' => 'directory', + 'children' => [ + 'CredentialProductVerifyV2', + 'CredentialVerifyV2', + 'CredentialVerify', + ], + ], + [ + 'id' => 322833, + 'title' => '银行卡核验', + 'type' => 'directory', + 'children' => [ + 'BankMetaVerify', + ], + ], + [ + 'id' => 322834, + 'title' => '手机号核验', + 'type' => 'directory', + 'children' => [ + 'MobileRecycledMetaVerify', + 'MobileDetect', + 'Mobile3MetaSimpleVerify', + 'Mobile3MetaDetailVerify', + 'Mobile2MetaVerify', + 'MobileOnlineTime', + 'MobileOnlineStatus', + 'Mobile3MetaSimpleStandardVerify', + 'Mobile3MetaDetailStandardVerify', + ], + ], + [ + 'id' => 322835, + 'title' => '身份核验', + 'type' => 'directory', + 'children' => [ + 'Id2MetaStandardVerify', + 'Id2MetaVerify', + 'Id2MetaVerifyWithOCR', + 'Id3MetaVerify', + 'Id2MetaPeriodVerify', + 'InitCardVerify', + 'DescribeCardVerify', + 'Id3MetaVerifyWithOCR', + ], + ], + [ + 'id' => 187373, + 'title' => '车辆核验', + 'type' => 'directory', + 'children' => [ + 'VehicleMetaVerifyV2', + 'VehicleMetaVerify', + 'Vehicle5ItemQuery', + 'VehicleQuery', + 'VehicleInsureQuery', + ], + ], + ], + ], + [ + 'id' => 186118, + 'title' => '实人认证（已停止售卖，文档停止更新）', + 'type' => 'directory', + 'children' => [ + 'VerifyMaterial', + 'DescribeVerifyToken', + 'DescribeVerifyResult', + 'CompareFaces', + 'DetectFaceAttributes', + ], + ], + [ + 'id' => 172203, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribePageFaceVerifyData', + 'CreateCloudauthstScene', + 'DeleteCloudauthstScene', + 'DescribeSmartStatisticsPageList', + 'CreateAntCloudAuthScene', + 'UpdateAntCloudAuthScene', + 'DeleteAntCloudAuthScene', + 'RemoveWhiteListSetting', + 'InsertWhiteListSetting', + 'PageQueryWhiteListSetting', + [ + 'id' => 172209, + 'title' => 'AIGC生成图片检测', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 59190, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAuthKey', + 'DescribeOssUploadToken', + ], + ], + [ + 'id' => 59198, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateVerifySetting', + ], + ], + [ + 'id' => 59208, + 'title' => 'SDK', + 'type' => 'directory', + 'children' => [ + 'DescribeVerifySDK', + ], + ], + [ + 'id' => 59215, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDeviceInfo', + 'DescribeDeviceInfo', + ], + ], + ], + ], + 'DeleteWhitelistSetting', + 'CreateWhitelistSetting', + 'DescribeWhitelistSetting', + 'DescribeAntAndCloudAuthUserStatus', + 'DescribeCloudauthstSceneList', + 'DescribeListAntCloudAuthScenes', + 'DescribeListFaceVerifyData', + 'DescribeListFaceVerifyInfos', + 'DescribeOssStatus', + 'DescribePageSetting', + 'DescribeProductCode', + 'DescribeVerifyDeviceRiskStatistics', + 'DescribeVerifyFailStatistics', + 'DescribeVerifyPersonasDeviceModelStatistics', + 'DescribeVerifyPersonasOsStatistics', + 'DescribeVerifyPersonasProvinceStatistics', + 'DescribeVerifyPersonasSexStatistics', + 'DescribeVerifySearchPageList', + 'DescribeVerifyStatistics', + 'DescribeMetaSearchPageList', + 'DescribeMetaStatisticsList', + 'DescribeMetaStatisticsPageList', + 'QuerySceneConfigs', + 'CreateSceneConfig', + 'UpdateSceneConfig', + 'DeleteSceneConfig', + 'QueryVerifyDownloadTask', + 'DownloadVerifyRecords', + 'QueryVerifyFlowPackage', + 'QueryVerifyInvokeSatistic', + 'QueryCustomizeFlowStrategy', + 'DeleteCustomizeFlowStrategy', + 'DeleteAllCustomizeFlowStrategy', + 'ModifyCustomizeFlowStrategyList', + 'ModifyControlStrategy', + 'QueryControlStrategy', + 'DeleteControlStrategy', + 'ModifyBlackListStrategy', + 'QueryBlackListStrategy', + 'DeleteBlackListStrategy', + 'DescribeInfoCheckExportRecord', + 'DescribeOssStatusV2', + 'DescribeAuthVerify', + 'InitAuthVerify', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'LivenessFaceVerify' => [ + 'summary' => '人脸静默活体（LivenessFaceVerify）指通过API接口传入提前获取的人脸图片进行真实人脸检测的服务。其算法主要识别人脸是否为屏幕翻拍、打印图片等活体攻击类型。该服务适用于低风险业务场景或配合离线人脸识别SDK使用。若您的业务对真实人脸安全要求较高，推荐您集成App或者WebSDK模式或者集成人脸Deepfake检测服务，辅助识别更多维度人脸伪造风险。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59165', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证场景ID。该ID在控制台创建认证场景后自动生成。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => ' '."\n" + .'100000****', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户服务端自定义的业务唯一标识，用于后续定位排查问题。'."\n" + .'取值最长为32位长度的字母数字组合，请确保唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '固定值：LR_FR_MIN。', + 'type' => 'string', + 'required' => false, + 'example' => 'LR_FR_MIN', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '照片Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'DeviceToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '设备Token，用于风险识别。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户网络IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '您自定义的用户ID（最长100个字符），请保持唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://ware.cdeledu.com/upfile/uploadPic/2025/03/21/dd62fbb9c966433ab0ba9a7252816b30.jpg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的Bucket名 。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-1494517779820665', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'facedetect/17483113370916034.jpg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '活体检测参数', + 'type' => 'string', + 'required' => false, + 'example' => 'FRONT_CAMERA_LIVENESS', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许裁剪人脸图片：'."\n" + ."\n" + .'- T：允许剪裁'."\n" + ."\n" + .'- F（默认）：不允许剪裁', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'ResultObject' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '实人认证请求的唯一标识。', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + 'SubCode' => [ + 'description' => '认证结果码。', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => '人脸认证主体附件信息，包含人脸质量、人脸攻击、人脸或OCR图片以及意愿认证等数据信息。', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"verifyScore": 50.28594166529785}}', + ], + 'Passed' => [ + 'description' => '认证结果，取值：'."\n" + ."\n" + .'- T：通过'."\n" + ."\n" + .'- F：未通过', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0f24b\\",\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"verifyScore\\\\\\": 50.28594166529785}}\\",\\n \\"Passed\\": \\"T\\"\\n }\\n}","type":"json"}]', + 'title' => '人脸静默活体检测', + 'description' => '调用LivenessFaceVerify接口对人脸图片进行活体检测。', + ], + 'CompareFaceVerify' => [ + 'summary' => '金融级人脸比对纯服务端API。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59095', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '商户请求的唯一标识。'."\n" + ."\n" + .'值为32位长度的字母数字组合前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '固定值：PV_FC。', + 'type' => 'string', + 'required' => false, + 'example' => 'PV_FC', + ], + ], + [ + 'name' => 'SourceFaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '照片Base64编码。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1048676, + ], + ], + [ + 'name' => 'SourceFaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS照片地址，目前只支持已授权OSS照片地址。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'SourceCertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '之前实人认证通过的CertifyId，认证时的照片作为人脸比对照片。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'SourceOssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的 Bucket 名。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'SourceOssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'TargetFaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '底库照片Base64编码。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种底库人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1048676, + ], + ], + [ + 'name' => 'TargetFaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '底库OSS照片地址，目前只支持已授权OSS照片地址。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种底库人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'TargetCertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '之前实人认证通过的 CertifyId，认证时的照片作为人脸比对照片。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种底库人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'TargetOssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的Bucket名 。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种底库人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'TargetOssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。'."\n" + ."\n" + .'> FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种底库人脸照片传入方式，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许裁剪，默认不允许，T/F'."\n" + ."\n" + .'- T：表示需要检测'."\n" + .'- F：表示需要检测（默认F）', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => '人脸比对结果信息。', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '实人认证请求的唯一标识。', + 'type' => 'string', + 'example' => '08573be80f944d95ac812e019e3655a8', + ], + 'VerifyScore' => [ + 'description' => '人脸比对分。', + 'type' => 'number', + 'format' => 'float', + 'example' => '99.60875', + ], + 'Passed' => [ + 'description' => '是否通过，通过为T，不通过为F。', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"VerifyScore\\": 99.60875,\\n \\"Passed\\": \\"T\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '人脸比对方案纯服务端API', + 'description' => '- 接口名：CompareFaceVerify。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 接口说明：通过服务端接入实现实人认证的接口。'."\n" + ."\n" + .'#### 传入照片格式要求'."\n" + .'当您在进行人脸比对的时候，请传入满足以下所有条件的2张人脸照片。'."\n" + ."\n" + .'- 近期照片/底库近期照片，人脸完整清晰无遮挡，表情自然，正对摄像头。'."\n" + .'- 照片清晰、曝光正常，脸部无过黑、过亮、光晕等情况、角度无太大偏差。'."\n" + .'- 分辨率不超过1920\\*1080，至少640\\*480，推荐短边缩放到720像素，压缩率大于0.9。'."\n" + .'- 照片大小：<1MB。'."\n" + .'- 支持 90、180 和270度照片，多人脸的情况会选取最大脸。', + 'requestParamsDescription' => '> 以Source开头的参数代表您要上传的近期人脸照片参数，以Target开头的参数代表您要上传的底库近期人脸照片参数。传入照片格式要求请参见[传入照片格式要求](#传入照片格式要求)。'."\n" + .'如果您选择OSS方式传入人脸照片，您必须同时传入OssBucketName和OssObjectName字段。OSS入参格式仅支持开通实人认证时授权的OSS生成的URL、Bucket和文件名 。关于如何查询授权的OSS，请参见[开通OSS空间并授权](https://help.aliyun.com/document_detail/163532.html?spm=a2c4g.11186623.2.15.36945bc3y5uWz6#title-409-lcd-pp0) 。'."\n" + .'如果您选择FaceContrastPicture（照片Base64编码）方式传入人脸照片，请注意检查照片大小，不要传入过大的照片；您可以通过OSS方式上传较大的人脸照片。', + 'responseParamsDescription' => '返回值示例：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Code": "200",'."\n" + .' "Message": "success",'."\n" + .' "RequestId": "23699272-B263-4B6C-BC04-0EBA1AB6F6D5",'."\n" + .' "ResultObject": {'."\n" + .' "Passed": "T",'."\n" + .' "VerifyScore": 99.60875'."\n" + .' }'."\n" + .'}'."\n" + .'```', + 'extraInfo' => ' ## 返回码'."\n" + ."\n" + .'|返回码|返回信息|描述|'."\n" + .'|----|-------|--|'."\n" + .'|200|success|成功。|'."\n" + .'|400|参数不能为空|参数不能为空。|'."\n" + .'|401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .'|402|应用配置不存在|应用配置不存在。|'."\n" + .'|404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .'|410|未开通服务|未开通OSS产品或未完成OSS读写授权，请登录控制台完成授权。|'."\n" + .'|411|RAM 无权限|需要给子账号授予AliyunAntCloudAuthFullAccess的操作权限。|'."\n" + .'|412|欠费中|金融级实人认证或OSS存在欠费，请充值后操作。|'."\n" + .'|419|传入图片不可用|图片无法下载、图片内容为空、图片分辨率不符合要求或提取不到人脸特征，建议更换图片。|'."\n" + .'|420|数据重复|图片传入方式超过2种。<ul> <li> FaceContrastPicture</li> <li> FaceContrastPictureUrl </li><li> Oss</li> <li> CertifyId</li><ul>|'."\n" + .'|421|传入图片过大|图片超过了1 MB，建议压缩图片或更换图片上传方式。|'."\n" + .'|422|下载图片超时|图片下载超过了3秒，请排查网络后重新操作。|'."\n" + .'|423|状态错误|传入的certifyID认证状态需要为T，您也可以更换其他方式传入图片。|'."\n" + .'|500|系统错误|系统内部错误，请联系工程师排查。|'."\n" + ."\n\n" + ."\n\n", + ], + 'ContrastFaceVerify' => [ + 'summary' => '该接口用于提交认证材料以进行核实比对，并同步返回认证结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59096', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '商户请求的唯一标识。'."\n" + .'值为32位长度的字母数字组合。前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '固定值：ID_MIN。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_MIN', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'formData', + 'schema' => [ + 'description' => '证件类型。'."\n" + .'当前支持身份证，必须传入IDENTITY_CARD。', + 'type' => 'string', + 'required' => false, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'formData', + 'schema' => [ + 'description' => '真实姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '照片Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + ], + ], + [ + 'name' => 'DeviceToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '风险识别-设备token。', + 'type' => 'string', + 'required' => false, + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户IP。', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '客户业务自定义的用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OSS照片地址，目前只支持已授权OSS照片地址。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种传入图片方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '之前实人认证通过的CertifyId，认证时的照片作为比对照片。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种传入图片方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的Bucket 名 。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种传入图片方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种传入图片方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '活体检测类型', + 'type' => 'string', + 'required' => false, + 'example' => 'FRONT_CAMERA_LIVENESS', + ], + ], + [ + 'name' => 'FaceContrastFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '本地视频文件。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许裁剪人脸图片：'."\n" + ."\n" + .'- T：允许剪裁'."\n" + ."\n" + .'- F（默认）：不允许剪裁', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密类型。为空表示不加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'SM2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => '请求结果', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '实人认证请求的唯一标识。', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + 'SubCode' => [ + 'description' => '认证结果描述。详情见下方SubCode 说明。', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => '认证主体附件信息，主要为图片类材料，JSON格式，如下。', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"verifyScore": 50.28594166529785}}', + ], + 'IdentityInfo' => [ + 'description' => '认证的主体信息，一般的认证场景返回为空。', + 'type' => 'string', + 'example' => 'null', + ], + 'Passed' => [ + 'description' => '是否通过，通过为T，不通过为F。', + 'type' => 'string', + 'example' => 'T', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\",\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"verifyScore\\\\\\": 50.28594166529785}}\\",\\n \\"IdentityInfo\\": \\"null\\",\\n \\"Passed\\": \\"T\\"\\n }\\n}","type":"json"}]', + 'title' => '实人认证方案纯服务端API', + 'description' => '- 接口名：ContrastFaceVerify。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 接口说明：通过服务端接入实现实人认证的接口。'."\n" + ."\n" + .'#### 传入图片格式要求'."\n" + .'当您在进行实人认证的时候，请传入满足以下所有条件的图片。'."\n" + ."\n" + .'- 近期照片，人脸完整清晰无遮挡，表情自然，正对摄像头。'."\n" + .'- 照片清晰、曝光正常，脸部无过黑、过亮、光晕等情况、角度无太大偏差。'."\n" + .'- 分辨率不超过1920\\*1080，至少640\\*480，推荐短边缩放到720像素，压缩率大于0.9。'."\n" + .'- 照片大小：<1MB。'."\n" + .'- 支持90、180 和270度照片，多人脸的情况会选取最大脸。', + 'requestParamsDescription' => '> 如果您选择OSS方式传入人脸照片，您必须传入OssBucketName和OssObjectName 字段。OSS入参格式仅支持开通实人认证服务时授权的OSS生成的URL、Bucket和文件名 。'."\n" + .'如果您选择FaceContrastPicture（照片Base64编码）方式传入人脸照片，请注意检查照片大小，不要传入过大的照片；您可以通过 OSS方式上传较大的人脸照片。', + 'responseParamsDescription' => 'ResultObject.MaterialInfo的JSON格式示例：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' // 是否为攻击：攻击为T，非攻击为F'."\n" + .' "faceAttack": "F",'."\n" + .' "facialPictureFront": {'."\n" + .' // 活体人脸质量分数'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // 人脸比对分数'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n", + 'extraInfo' => '## 返回码'."\n" + ."\n" + .'|返回码|返回信息|描述|'."\n" + .' |----|-------|--|'."\n" + .' |200|success|成功。|'."\n" + .' |400|参数不能为空|参数不能为空。|'."\n" + .' |401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .' |402|应用配置不存在|应用配置不存在。|'."\n" + .' |404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .' |405|您的年龄未满14周岁，不允许使用此产品|未满14周岁的用户无法使用本产品，建议人工审核。|'."\n" + .' |410|未开通服务|未开通OSS产品或未完成OSS读写授权，请登录控制台完成授权。|'."\n" + .' |411|RAM无权限|需要给子账号授予 AliyunAntCloudAuthFullAccess 的操作权限。|'."\n" + .' |412|欠费中|金融级实人认证或OSS存在欠费，请充值后操作。|'."\n" + .' |417|无法使用刷脸服务|当前身份信息比对源不可用。若信息正确，建议人工审核。|'."\n" + .' |418|刷脸失败次数过多|当天刷脸认证次数过多，请明天再试。|'."\n" + .' |419|传入图片不可用|图片无法下载、图片内容为空、图片分辨率不符合要求或提取不到人脸特征，建议更换图片。|'."\n" + .' |420|数据重复|图片传入方式超过1种。<ul> <li> FaceContrastPicture</li> <li> FaceContrastPictureUrl </li><li> Oss</li> <li> CertifyId</li><ul>|'."\n" + .' |421|传入图片过大|图片超过了1 MB，建议压缩图片或更换图片上传方式。|'."\n" + .'|422|下载图片超时|图片下载超过了3秒，请排查网络后重新操作。|'."\n" + .'|423|状态错误|传入的certifyID认证状态需要为T，您也可以更换其他方式传入图片。|'."\n" + .'|500|系统错误|系统内部错误，请反馈工程师排查。|'."\n" + ."\n\n" + .'ResultObject.SubCode说明：'."\n" + ."\n" + .'|错误码|认证描述文案|是否计费|可能原因和运营建议|'."\n" + .'|---|------|----|---------|'."\n" + .'|200|认证通过|是| |'."\n" + .'|201|姓名和身份证不一致|是|可能用户的信息有误或假信息，建议用户确认后重新操作。|'."\n" + .'|202|查询不到身份信息|是|可能是用户户口迁移、军人等特殊状态导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|203|查询不到照片或照片不可用|是|可能是公安库数据问题导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|204|人脸比对不一致|是|可能不是同一人或活体照片质量较低，建议根据业务情况分层处理，若为同一人可重新操作。|'."\n" + .'|205|活体检测存在风险|是|可能存在攻击风险，建议人工审核分层处理，若为真人可重新操作。|'."\n" + .'|206|业务策略限制|是|可能存在异常风险操作，建议人工确认后操作。|', + ], + 'DescribeFaceVerify' => [ + 'summary' => '当接入方移动端收到回调之后，其服务端可以调用此接口，来获取相应的认证状态和认证资料。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59117', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + ], + [ + 'name' => 'PictureReturnType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片返回类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'JPG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'SubCode' => [ + 'description' => '认证结果描述，详情见下方SubCode说明。', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => '认证主体附件信息，主要为图片类材料。JSON格式，见下方示例。', + 'type' => 'string', + 'example' => '{"faceAttack": "F","facialPictureFront": {"qualityScore": 88.3615493774414,"pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg","ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779","ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg"}}', + ], + 'IdentityInfo' => [ + 'description' => '认证的主体信息，一般的认证场景返回为空。', + 'type' => 'string', + 'example' => 'null', + ], + 'DeviceToken' => [ + 'description' => '设备token。', + 'type' => 'string', + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + 'Passed' => [ + 'description' => '是否通过，通过为 T，不通过为 F。', + 'type' => 'string', + 'example' => 'T', + ], + 'DeviceRisk' => [ + 'description' => '设备风险标签。', + 'type' => 'string', + 'example' => 'ROOT,VPN,HOOK', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'string', + 'example' => 'True', + ], + 'UserInfo' => [ + 'description' => '记录在生僻字模式下用户输入的身份信息与对应编码。返回数据为JSON格式字符串，姓名中无生僻字返回为空字符串。'."\n" + ."\n" + .'- name：指用户输入的姓名。'."\n" + ."\n" + .'- verifyName：指通过验证的最终姓名编码。例如生僻字是通过转码认证通过：“王先生”，实际认证通过是“王先升”。'."\n" + ."\n" + .'- number：指用户输入的证件号码。', + 'type' => 'string', + 'example' => '{'."\n" + .' "number": "610***********1110",'."\n" + .' "name": "王先生",'."\n" + .' "verifyName": "王先"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"{\\\\\\"faceAttack\\\\\\": \\\\\\"F\\\\\\",\\\\\\"facialPictureFront\\\\\\": {\\\\\\"qualityScore\\\\\\": 88.3615493774414,\\\\\\"pictureUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg\\\\\\",\\\\\\"ossBucketName\\\\\\": \\\\\\"cn-shanghai-aliyun-cloudauth-1260051251634779\\\\\\",\\\\\\"ossObjectName\\\\\\": \\\\\\"verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg\\\\\\"}}\\",\\n \\"IdentityInfo\\": \\"null\\",\\n \\"DeviceToken\\": \\"McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx\\",\\n \\"Passed\\": \\"T\\",\\n \\"DeviceRisk\\": \\"ROOT,VPN,HOOK\\",\\n \\"Success\\": \\"True\\",\\n \\"UserInfo\\": \\"{\\\\n \\\\\\"number\\\\\\": \\\\\\"610***********1110\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"王先生\\\\\\",\\\\n \\\\\\"verifyName\\\\\\": \\\\\\"王先\\\\\\"\\\\n}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResultObject>\\n <Passed>T</Passed>\\n <DeviceToken>McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx</DeviceToken>\\n <IdentityInfo>null</IdentityInfo>\\n <MaterialInfo>{\\"faceAttack\\": \\"F\\",\\"facialPictureFront\\": {\\"qualityScore\\": 88.3615493774414,\\"pictureUrl\\": \\"https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg\\",\\"ossBucketName\\": \\"cn-shanghai-aliyun-cloudauth-1260051251634779\\",\\"ossObjectName\\": \\"verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg\\"}}</MaterialInfo>\\n <SubCode>200</SubCode>\\n</ResultObject>\\n<RequestId>130A2C10-B9EE-4D84-88E3-5384FF039795</RequestId>\\n<Message>success</Message>\\n<Code>200</Code>","errorExample":""}]', + 'title' => '查询认证详情接口', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' > 判断认证结果请以ResultObject.Passed或ResultObject.SubCode字段为准。'."\n" + ."\n" + .'#### ResultObject.MaterialInfo的JSON格式示例'."\n" + .'- APP认证方案 & 活体人脸验证方案'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' // 是否为攻击：攻击为T，非攻击为F'."\n" + .' "faceAttack": "F", '."\n" + .' // 认证的照片信息'."\n" + .' "facialPictureFront": {'."\n" + .' // 活体人脸质量分数'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // 人脸比对分数'."\n" + .' "verifyScore": 50.28594166529785,'."\n" + .' // 照片https地址，有效期15分钟，从查询时开始计时 '."\n" + .' "pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg",'."\n" + .' // 照片存放客户上海区域的OSS里，此为照片的bucket名'."\n" + .' "ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779",'."\n" + .' // 照片存放客户上海区域的OSS里，此为照片的文件名'."\n" + .' "ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg" '."\n" + .' }'."\n" + .' }'."\n" + .' ```'."\n" + ."\n" + .'- 活体检测方案'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' // 是否为攻击：攻击为T，非攻击为F'."\n" + .' "faceAttack": "F", '."\n" + .' // 认证的照片信息'."\n" + .' "facialPictureFront": {'."\n" + .' // 活体人脸质量分数'."\n" + .' "qualityScore": 88.3615493774414,'."\n" + .' // 照片https地址，有效期15分钟，从查询时开始计时 '."\n" + .' "pictureUrl": "https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg",'."\n" + .' // 照片存放客户上海区域的OSS里，此为照片的bucket名'."\n" + .' "ossBucketName": "cn-shanghai-aliyun-cloudauth-1260051251634779",'."\n" + .' // 照片存放客户上海区域的OSS里，此为照片的文件名'."\n" + .' "ossObjectName": "verify/1260051251634779/6ba7bcfccf33f56cdb44ed086f36ce3e0.jpeg" '."\n" + .' }'."\n" + .' }'."\n" + .' ```'."\n" + ."\n\n" + ."\n" + .'#### ResultObject.SubCode说明'."\n" + ."\n" + .'|错误码|认证描述文案|是否计费|可能原因和运营建议|'."\n" + .'|---|------|----|---------|'."\n" + .' |200|认证通过|是| |'."\n" + .'|201|姓名和身份证不一致|是|可能用户的信息有误或假信息，建议用户确认后重新操作。|'."\n" + .'|202|查询不到身份信息|是|可能是用户户口迁移、军人等特殊状态导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|203|查询不到照片或照片不可用|是|可能是公安库数据问题导致，建议预留人工审核入口，进行人工审核。|'."\n" + .'|204|人脸比对不一致|是|可能不是同一人或活体照片质量较低，建议根据业务情况分层处理，若为同一人可重新操作。|'."\n" + .'|205|活体检测存在风险|是|可能存在攻击风险，建议人工审核分层处理，若为真人可重新操作。|'."\n" + .'|206|业务策略限制|是|可能存在异常风险操作，建议人工确认后操作。|'."\n" + ."\n", + 'extraInfo' => ' ## 结果码'."\n" + ."\n" + .'|Code|Message|描述|'."\n" + .'|----|-------|--|'."\n" + .'|200|success|成功。|'."\n" + .'|400|参数不能为空|参数不能为空。|'."\n" + .'|401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .'|403|认证未完成|认证未完成。|'."\n" + .'|404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .'|406|无效的certifyId|无效的certifyId。|'."\n" + .'|410|未开通服务|未开通OSS产品或未完成OSS读写授权。|'."\n" + .'|411|RAM无权限|需要给子账号授予AliyunAntCloudAuthFullAccess的操作权限。|'."\n" + .'|424|身份认证记录不存在|该certifyId还没有对应的身份认证提交记录。|'."\n" + .'|500|系统错误|系统内部错误。|', + ], + 'InitFaceVerify' => [ + 'summary' => '每次开始认证前，通过本接口获取CertifyId，用来串联认证请求中的各个接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59164', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthGDLZVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000006', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => '商户请求的唯一标识。'."\n" + ."\n" + .'值为32位长度的字母数字组合。前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '固定值。在不同的产品方案中，该参数值不同：'."\n" + .'- APP认证方案：参数固定值为ID_PRO'."\n" + .'- 活体人脸验证方案：参数固定值为PV_FV'."\n" + .'- 活体检测方案：参数固定值为LR_FR', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'CertType', + 'in' => 'query', + 'schema' => [ + 'description' => '证件类型。'."\n" + .'当前支持身份证，传入 IDENTITY_CARD。', + 'type' => 'string', + 'required' => false, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'CertName', + 'in' => 'query', + 'schema' => [ + 'description' => '真实姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ReturnUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '商户业务页面回跳的目标地址。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '照片Base64编码。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种图片传入方式中，选择其中一种传入即可。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', + 'maxLength' => 1548576, + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Metainfo环境参数，需要通过客户端SDK获取。', + 'type' => 'string', + 'required' => false, + 'example' => '{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '用户手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '130xxxxxxxx', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => '用户IP。', + 'type' => 'string', + 'required' => false, + 'example' => '114.xxx.xxx.xxx', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '客户业务自定义的用户ID，请保持唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123456789', + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS照片地址，目前只支持已授权OSS照片地址。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '><warning>以后将弃用></warning>'."\n" + ."\n" + .'之前实人认证通过的CertifyId，认证时的照片作为比对照片。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '0bfa7c493f850e5178b9f8613634c9xx', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '已授权OSS空间的Bucket名 。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx', + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、CertifyId、OSS四种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'verify/xxxxx/xxxxxx.jpeg', + ], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => [ + 'description' => '活体检测类型，取值：'."\n" + .'> 活体检测类型仅支持下列取值，暂不支持自定义动作或组合。'."\n" + ."\n" + .'说明'."\n" + .'活体检测类型仅支持下列取值，暂不支持自定义动作或组合。'."\n" + ."\n" + .'- **LIVENESS**（默认）：眨眼'."\n" + ."\n" + .'- **PHOTINUS_LIVENESS**：眨眼+ 炫彩'."\n" + ."\n" + .'- **MULTI_ACTION**：眨眼 + 摇头 （眨眼和摇头顺序随机）'."\n" + ."\n" + .'- **MOVE_ACTION**（推荐）：远近移动 + 眨眼'."\n" + ."\n" + .'- **MOVE_PHOTINUS**：远近移动 + 炫彩'."\n" + ."\n" + .'> '."\n" + .'>- **默认的活体检测类型**在下列版本中支持：'."\n" + .'> - Android SDK1.2.6及以上'."\n" + .'> - iOS SDK1.2.4及以上'."\n" + .'> - Harmony SDK1.0.0及以上'."\n" + .'>- 其他类型都在Android/iOS/Harmony的最新SDK版本上支持，建议集成最新版本使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'MOVE_ACTION', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '认证结果的回调通知地址，回调请求方式默认为GET，回调地址必须以`https`开头。平台在完成认证后会回调该地址，并自动添加`certifyId`、`passed`字段，`passed`字段值返回的是subcode值，示例：`https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200。`'."\n" + ."\n" + .'<notice>'."\n" + ."\n" + .'- 仅当认证完成（包含认证通过和认证未通过）时才会触发回调，若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时，若有需要可通过查询接口获取认证详情信息。'."\n" + .'- 该值的传入会在调用接口前做可访问校验，如果传入的地址不能在公网访问，会返回401。'."\n" + .'- 接口在回调后务必返回 HTTP 状态码 200，否则会触发重试，3秒内两次回调。'."\n" + ."\n" + .'</notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'query', + 'schema' => [ + 'description' => '安全Token，由您自行生成，用于防重复、防篡改校验。'."\n" + ."\n" + .'如果设置了该值会在回调地址显示**CallbackToken**字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许裁剪人脸图片，默认不允许。'."\n" + ."\n" + .'- T：表示允许剪裁。'."\n" + ."\n" + .'- F：表示不允许剪裁。'."\n" + ."\n" + .'>若您请求的图片并非来自标准活体检测SDK采集，建议您允许裁剪人脸图片。开启该功能后，将会对请求的图片先进行人脸裁剪与矫正，完成后会发起请求服务。', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + [ + 'name' => 'CertifyUrlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Web SDK设备类型。取值**WEB**或者**H5**。'."\n" + ."\n" + .'> 只支持Web SDK设备类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'WEB', + ], + ], + [ + 'name' => 'AuthId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户授权ID，最大长度为64位字符。', + 'type' => 'string', + 'required' => false, + 'example' => '92d46b9e9e2d703f2897f350d5bd4149', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => '传入加密算法，目前仅支持SM2国密算法。'."\n" + ."\n" + .'开启加密传输后，需传入加密后的CertName和CertNo。如何加密，请[参数加密说明](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.1a9d566eWdqwy8#task-2229332)。', + 'type' => 'string', + 'required' => false, + 'example' => 'SM2', + ], + ], + [ + 'name' => 'VoluntaryCustomizedContent', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义意愿内容。 当开启个性化设置时必填。格式为String List的JSON String。'."\n" + ."\n" + .'- 跟读场景下：不能超过60个中文字符（不含标点），List只有1个元素。'."\n" + ."\n" + .'- 问答场景下：最多设置3个问题，每一个问题不能超过30个中文字符，每个问题分别为List的1个元素。', + 'type' => 'string', + 'required' => false, + 'example' => '["本人王先生同意***协议。"]', + ], + ], + [ + 'name' => 'SuitableType', + 'in' => 'query', + 'schema' => [ + 'description' => '适老化配置参数，针对每笔认证请求生效，您可以根据自有App的业务属性、客群分布、操作特性等条件对于每笔认证请求选择不同的参数，包括以下选项，默认为0。'."\n" + ."\n" + .'- **0**：不开启，表示当前认证请求不开启适老化。'."\n" + ."\n" + .'- **1**：开启，表示当前认证请求开启适老化。'."\n" + ."\n" + .'- **2**：用户选择。'."\n" + ."\n\n" + .'支持终端用户选择认证模式，产品引导页提供“开启认证”和“长辈认证模式”两种认证入口，当用户选择“长辈认证模式”系统进入适老化模式。'."\n" + .'> '."\n" + .'> - 适老化参数仅在活体检测类型**Model**取值 **LIVENESS** 或者 **MULTI_ACTION**时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ProcedurePriority', + 'in' => 'query', + 'schema' => [ + 'description' => '移动端H5方式认证出现WebRTC或者Webassembly不兼容时的降级配置。'."\n" + ."\n" + .'- **keep**：不支持降级，直接返回。'."\n" + ."\n" + .'- **url**（默认）：支持降级，返回认证URL，用户使用此URL打开或者切换浏览器进行认证。'."\n" + ."\n" + .'- **video**：支持降级，使用系统相机录制一段3~5秒的眨眼视频进行认证。'."\n" + ."\n\n" + .'> '."\n" + .'> 当降级模式为Video时如下功能将失效，且产品安全性会降低，建议仅面向安全场景配置。'."\n" + .'> - 活体检测的类型设置将不生效。'."\n" + .'> - 视频存证VideoEvidence功能不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'url', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '获取护照NFC核验要素方式：'."\n" + ."\n" + .'- **1**：用户输入，终端用户使用阿里云SDK提供的UI界面手工输入证件要素信息。'."\n" + ."\n" + .'- **3**：外部参数传入，通过外部传入证件要素信息。'."\n" + ."\n" + .'> NFC解码护照芯片加密信息时需要获取护照三要素信息，包括姓名、出生日期和证件有效截止日期。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ReadImg', + 'in' => 'query', + 'schema' => [ + 'description' => '是否读取证件照片：'."\n" + ."\n" + .'- **Y**：读取'."\n" + ."\n" + .'- **N**：不读取'."\n" + ."\n" + .'> 如果在后续认证环节需要使用证件人脸照片，此处建议入参为Y。', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'Birthday', + 'in' => 'query', + 'schema' => [ + 'description' => '证件上的出生日期。'."\n" + ."\n" + .'当证件类型**CertType**取值**PASSPORT**，并且**Mode**取值为**3**时，此字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '1993-10-10', + ], + ], + [ + 'name' => 'ValidityDate', + 'in' => 'query', + 'schema' => [ + 'description' => '证件有效截止日期。'."\n" + ."\n" + .'当证件类型**CertType**取值**PASSPORT**，并且**Mode**取值为**3**时，此字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '2039-06-10', + ], + ], + [ + 'name' => 'CertifyUrlStyle', + 'in' => 'query', + 'schema' => [ + 'description' => '返回**CertifyUrl**类型，包括：'."\n" + ."\n" + .'- **L**：原始长链'."\n" + ."\n" + .'- **S**（默认）：短链', + 'type' => 'string', + 'required' => false, + 'example' => 'L', + ], + ], + [ + 'name' => 'FaceGuardOutput', + 'in' => 'query', + 'schema' => [ + 'description' => '设备助手标签种类，取值：**DeviceRisk**。'."\n" + ."\n" + .'>'."\n" + .'> - 选择输出设备助手会产生额外的费用，详情请参见[付费增值服务](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/face-guard?spm=a2c4g.11186623.0.0.443e5522rbHsR4)。'."\n" + .'> - 如果不需要输出设备助手标签，可以不传递参数或者传入空值。', + 'type' => 'string', + 'required' => false, + 'example' => 'DeviceRisk', + ], + ], + [ + 'name' => 'RarelyCharacters', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启生僻字模式：'."\n" + ."\n" + .'- **Y**：开启。用户认证前会弹出信息输入框，需输入生僻字姓名和身份证号码，同意协议后才能开始认证流程。'."\n" + ."\n" + .'- **N**：不开启（默认）', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'UiCustomUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'UI配置文件URL。'."\n" + ."\n" + .'您可以在[Web SDK UI自定义配置](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/web-sdk-ui-custom-configuration-description?spm=a2c4g.11186623.0.0.4c683f5c8K3I9p)说明中查看完整配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyundoc.com', + ], + ], + [ + 'name' => 'VideoEvidence', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启视频存证：'."\n" + ."\n" + .'- **true**：开启'."\n" + ."\n" + .'- **false**：不开启（默认）'."\n" + ."\n" + .'> 因为视频文件较大，当网络不稳定时系统会丢弃视频文件优先保障认证必要图片传输，建议您业务上设置为弱依赖视频。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AppQualityCheck', + 'in' => 'query', + 'schema' => [ + 'description' => 'SDK是否开启人脸严格质量检测：'."\n" + ."\n" + .'- **Y**：开启'."\n" + ."\n" + .'- **N**：不开启（默认）'."\n" + ."\n\n" + .'> '."\n" + .'> - 若开启该参数，SDK需集成[人脸严格质量检测模块](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping?spm=a2c4g.11186623.0.0.1a9d35c6ySFUPW)。受严格质量检测影响，会导致用户刷脸成功率下降。'."\n" + .'> - 仅支持安卓SDK 2.3.24及以上版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'CameraSelection', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启摄像头选择功能：'."\n" + ."\n" + .'- **Y**：开启'."\n" + ."\n" + .'- **N**：不开启（默认）'."\n" + ."\n" + .'> 该功能仅针对PC端集成模式生效，开启后支持用户自主选择摄像头认证。', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'NeedMultiFaceCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '终端检测到多人脸时是否拦截，取值：'."\n" + ."\n" + .'- **Y**：拦截，客户端提示需要重新刷脸。'."\n" + ."\n" + .'- **N**（默认）：不拦截，取刷脸画面中的最大脸发送服务端进行安全检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'H5DegradeConfirmBtn', + 'in' => 'query', + 'schema' => [ + 'description' => 'H5降级页面认证完成显示“我已完成认证”按钮开关：'."\n" + .'- **Y**：开启'."\n" + .'- **N（默认）**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0f24b', + ], + 'CertifyUrl' => [ + 'description' => 'Web浏览器进行实人认证的URL，认证结束后根据入参ReturnUrl进行跳转。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 初始化接口返回的认证CertifyUrl在**30分钟有效且仅能认证提交一次**，请您在有效期内使用，避免重复使用。'."\n" + .'- 此参数需要入参中**MetaInfo**正确传入，以返回与客户端匹配的CertifyUrl。如无法获取，请检查**MetaInfo**以及其他传入参数是否正确。'."\n" + ."\n" + .'- 此地址域名可能会随服务更新而变更，为保证服务正常可用，建议不要对此地址域名进行访问控制。'."\n" + ."\n" + .'- 浏览器跳转时尽量不要使用无痕模式或改变 URL，否则可能会出现**签名异常**的错误。'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'example' => 'https://t.aliyun.com/****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0f24b\\",\\n \\"CertifyUrl\\": \\"https://t.aliyun.com/****\\"\\n }\\n}","type":"json"}]', + 'title' => '初始化接口', + 'description' => '- 服务地址：cloudauth.aliyuncs.com'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 该接口针对不同的产品方案采用不同的参数，详情请参考[官方文档](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1)。'."\n" + ."\n" + .'#### 传入图片格式要求'."\n" + .'当您在进行实人认证的时候，请传入满足以下所有条件的图片。'."\n" + .'- 近期照片，人脸完整清晰无遮挡，表情自然，正对摄像头。'."\n" + .'- 照片清晰、曝光正常，脸部无过黑、过亮、光晕等情况、角度无太大偏差。'."\n" + .'- 分辨率不超过1920\\*1080，至少640\\*480，推荐短边缩放到720像素，压缩率大于0.9。'."\n" + .'- 照片大小：<1MB。'."\n" + .'- 支持90、180 和270度照片，多人脸的情况会选取最大脸。', + 'requestParamsDescription' => ' > 如果您选择OSS方式传入人脸图片，您必须传入OssBucketName和OssObjectName 字段。'."\n" + .'OSS入参格式仅支持开通实人认证服务时授权的OSS生成的URL、Bucket和文件名 。关于如何查询授权的OSS，请参见[开通OSS空间并授权](https://help.aliyun.com/document_detail/163108.html?spm=a2c4g.11186623.2.14.7dd9f397RmV0jw#section-4w2-trd-8q6)。'."\n" + .'如果您选择FaceContrastPicture（照片Base64编码）方式传入人脸照片，请注意检查照片大小，不要传入过大的照片；您可以通过OSS方式上传较大的人脸照片。'."\n" + ."\n" + .'根据选择的认证方案不同，所需传入的字段不太一样，具体可以参考下述表格中的说明。'."\n" + ."\n" + .'字段|APP认证方案|活体人脸验证方案|活体检测方案'."\n" + .'--|--|--|--'."\n" + .'CertType|是|可选传入|可选传入'."\n" + .'CertName|是|可选传入|可选传入'."\n" + .'CertNo|是|可选传入|可选传入'."\n" + .'UserId|可选传入|是|是'."\n" + .'FaceContrastPicture|否|是|否'."\n" + .'FaceContrastPictureUrl|否|是|否'."\n" + .'CertifyId|否|是|否'."\n" + .'OssBucketName|否|是|否'."\n" + .'OssObjectName|否|是|否'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ## 结果码'."\n" + ."\n" + .'|结果码|返回信息|描述|'."\n" + .'|----|-------|--|'."\n" + .'|200|success|成功。|'."\n" + .'|400|参数不能为空|参数不能为空。|'."\n" + .'|401|参数非法|非法参数。传入的姓名、身份证号码长度必须符合国家标准且不得包含英文字母等特殊字符。|'."\n" + .'|402|应用配置不存在|应用配置不存在。|'."\n" + .'|404|认证场景配置不存在|认证场景配置不存在，请先在控制台上创建认证场景。|'."\n" + .'|405|您的年龄未满14周岁，不允许使用此产品|未满14周岁的用户无法使用本产品，建议人工审核。|'."\n" + .'|410|未开通服务|未开通OSS产品或未完成OSS读写授权，请登录控制台完成授权。|'."\n" + .'|411|RAM无权限|需要给子账号授予 AliyunAntCloudAuthFullAccess 的操作权限。|'."\n" + .'|412|欠费中|金融级实人认证或OSS存在欠费，请充值后操作。|'."\n" + .'|414|设备类型不支持|当前移动设备不支持刷脸认证，请更换设备后操作。|'."\n" + .'|415|SDK版本不支持|当前认证SDK版本不支持刷脸认证，请升级SDK后操作。|'."\n" + .'|416|系统版本不支持|当前操作系统版本不支持刷脸认证，请升级系统或更换设备操作。|'."\n" + .'|417|无法使用刷脸服务|当前身份信息比对源不可用。若信息正确，建议人工审核。|'."\n" + .'|418|刷脸失败次数过多|当天刷脸认证次数过多，请明天再试。|'."\n" + .'|419|传入图片不可用|图片无法下载、图片内容为空、图片分辨率不符合要求或提取不到人脸特征，建议更换图片。|'."\n" + .'|420|数据重复|图片传入方式超过1种。<ul> <li> FaceContrastPicture</li> <li> FaceContrastPictureUrl </li><li> Oss</li> <li> CertifyId</li><ul>|'."\n" + .'421|传入图片过大|图片超过了1 MB，建议压缩图片或更换图片上传方式。'."\n" + .'422|下载图片超时|图片下载超过了3秒，请排查网络后重新操作。'."\n" + .'423|状态错误|传入的certifyID认证状态需要为T，您也可以更换其他方式传入图片。'."\n" + .'|500|系统错误|系统内部错误，请反馈工程师排查。|'."\n" + ."\n", + ], + 'DescribeFaceGuardRisk' => [ + 'summary' => '金融级人脸保镖服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '250715', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCPTLY3', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceToken', + 'in' => 'query', + 'schema' => [ + 'description' => '风险识别-设备token。', + 'type' => 'string', + 'required' => false, + 'example' => 'McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOxxxxxxx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => '该标识用于后续定位排查问题，您需要确保该值在您的业务中是唯一的。'."\n" + ."\n" + .'支持使用英文字母（包含大小写）、数字，最长不超过32个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35xxxx', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code，固定值：FACE_GUARD', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FACE_GUARD' => 'FACE_GUARD', + ], + 'example' => 'FACE_GUARD', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证ID', + 'type' => 'string', + 'required' => false, + 'example' => 'aba9830f471a4335af4612c8adaa91b0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'RiskExtends' => [ + 'description' => '拓展信息，JSON格式。（按租户需求定制返回）', + 'type' => 'string', + 'example' => '{'."\n" + .' "code": 200'."\n" + .' "badNet":false,'."\n" + .' "umid":"74e37355171ab62230063569350d368e",'."\n" + .' "fileTags":"basic_root,basic_hook",'."\n" + .' "queryCount":1,'."\n" + .' "querySessionCount":1,'."\n" + .' "queryUmidCount":1'."\n" + .' "platform":"Android"'."\n" + .'}', + ], + 'RiskTags' => [ + 'description' => '设备风险标签。'."\n" + ."\n" + .'- 多个设备风险标签以半角逗号（,）分隔，如“ROOT,VPN,HOOK”，'."\n" + ."\n" + .'- 如需了解更多设备风险标签及其含义，请参见官方文档人脸保镖标签说明。', + 'type' => 'string', + 'example' => 'ROOT,VPN,HOOK', + ], + 'CertifyId' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'example' => 'sha43d9cabd52d370d9f4cca9468f71e', + ], + 'GuardRiskScore' => [ + 'description' => '设备助手算法预测的设备风险可能性，分数越高代表设备风险越高。'."\n" + ."\n" + .'分值取值：0~100。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"RiskExtends\\": \\"{\\\\n \\\\\\"code\\\\\\": 200\\\\n \\\\\\"badNet\\\\\\":false,\\\\n \\\\\\"umid\\\\\\":\\\\\\"74e37355171ab62230063569350d368e\\\\\\",\\\\n \\\\\\"fileTags\\\\\\":\\\\\\"basic_root,basic_hook\\\\\\",\\\\n \\\\\\"queryCount\\\\\\":1,\\\\n \\\\\\"querySessionCount\\\\\\":1,\\\\n \\\\\\"queryUmidCount\\\\\\":1\\\\n \\\\\\"platform\\\\\\":\\\\\\"Android\\\\\\"\\\\n}\\",\\n \\"RiskTags\\": \\"ROOT,VPN,HOOK\\",\\n \\"CertifyId\\": \\"sha43d9cabd52d370d9f4cca9468f71e\\",\\n \\"GuardRiskScore\\": 80\\n }\\n}","type":"json"}]', + 'title' => '人脸保镖纯服务端接口', + ], + 'AIGCFaceVerify' => [ + 'summary' => 'AIGC生成图片检测，输出检测标识。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206861', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景，请参见添加认证场景。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => '客户服务端自定义的业务唯一标识，用于后续定位排查问题。取值最长为32位长度的字母数字组合，请确保唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品方案', + 'type' => 'string', + 'required' => false, + 'example' => 'LR_FR_AIGC', + ], + ], + [ + 'name' => 'FaceContrastPicture', + 'in' => 'formData', + 'schema' => [ + 'description' => '照片Base64编码。'."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、OSS三种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'."\n", + ], + ], + [ + 'name' => 'FaceContrastPictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '人像地址，公网可访问的HTTP、HTTPS链接。'."\n" + ."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、OSS三种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'OssBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '已授权OSS空间的Bucket名 。'."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、OSS三种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-aliyun-cloudauth-xxxxx'."\n", + ], + ], + [ + 'name' => 'OssObjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '已授权OSS空间的文件名。'."\n" + .'> 在FaceContrastPicture、FaceContrastPictureUrl、OSS三种图片传入方式中，选择其中一种传入即可。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'verify/xxxxx/xxxxxx.jpeg'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Message' => [ + 'description' => '消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '返回的结果', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '认证结果。取值：'."\n" + ."\n" + .'● Y：AIGC生成人脸。'."\n" + ."\n" + .'● N：未检测到', + 'type' => 'string', + 'enumValueTitles' => [ + 'Y' => 'AIGC生成人脸', + 'N' => '非AIGC生成人脸', + ], + 'example' => 'Y', + ], + 'Score' => [ + 'description' => '检测的分数', + 'type' => 'string', + 'example' => '1.0000', + ], + 'CertifyId' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"Y\\",\\n \\"Score\\": \\"1.0000\\",\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\"\\n }\\n}","type":"json"}]', + 'title' => 'AIGC生成图片检测', + ], + 'DeleteFaceVerifyResult' => [ + 'summary' => '金融级服务敏感数据删除接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247721', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'shae18209d29ce4e8ba252caae98ab15', + ], + ], + [ + 'name' => 'DeleteAfterQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '删除时是否依赖已获取到对应认证流程中的相关数据。'."\n" + ."\n" + .'- Y：需要。如果需成功删除相关数据，必须已通过DescribeFaceVerify接口获取处理结果。'."\n" + .'- N：不需要（默认）。通过纯服务端API集成模式时可直接传入N。', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'example' => 'sha58aeae7ea2f5ed069530f58df4e6d', + ], + 'DeleteResult' => [ + 'description' => '删除结果。取值如下：'."\n" + ."\n" + .'- Y：删除成功。'."\n" + .'- N：删除失败。', + 'type' => 'string', + 'example' => 'N', + ], + 'FailReason' => [ + 'description' => '删除失败原因'."\n" + ."\n" + .'- NOT_DELETE_REPEATEDLY：不能重复删除'."\n" + .'- NEED_QUERY_VERIFY_RESULT：需要先查询认证结果，再删除', + 'type' => 'string', + 'example' => 'NOT_DELETE_REPEATEDLY', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"sha58aeae7ea2f5ed069530f58df4e6d\\",\\n \\"DeleteResult\\": \\"N\\",\\n \\"FailReason\\": \\"NOT_DELETE_REPEATEDLY\\"\\n }\\n}","type":"json"}]', + 'title' => '金融级新增服务删除接口', + 'description' => '删除请求信息中个人信息相关的全部字段信息：姓名、身份证、手机号、ip、图片、视频、设备信息等', + ], + 'DeepfakeDetect' => [ + 'summary' => '传入人脸图片，通过算法检测是否存在深度伪造风险。包含AIGC生成人脸、深度伪造换脸、模板人脸、翻拍人脸等风险场景，输出风险标签与置信度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '226413', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthS6WIN6', + ], + ], + 'parameters' => [ + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => '商户请求的唯一标识，值为32位长度的字母数字组合。其中前几位字符由商户自定义的简称组成，中间部分可以包含一段时间，而后段可以采用随机或递增序列。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'FaceInputType', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸素材输入类型：'."\n" + ."\n" + .'- IMAGE（默认）：人脸图片'."\n" + .'- VIDEO：人脸视频'."\n" + ."\n" + .'> 视频处理时间较久，建议超时时间设置>3S。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IMAGE' => 'IMAGE', + 'VIDEO' => 'VIDEO', + ], + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '传入人脸图片URL地址。'."\n" + .'> FaceUrl和FaceBase64需选择传入其中一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg', + ], + ], + [ + 'name' => 'FaceBase64', + 'in' => 'formData', + 'schema' => [ + 'description' => '传入人脸图片的Base64格式编码。'."\n" + .'> FaceUrl和FaceBase64需选择传入其中一个。', + 'type' => 'string', + 'required' => false, + 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '风险结果：'."\n" + ."\n" + .'- **0**：低风险'."\n" + .'- **1**：高风险'."\n" + .'- **2**：可疑', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => '风险标签。多个标签使用半角逗号（,）隔开，包括：'."\n" + ."\n" + .'- 疑似深度伪造 SuspectDeepForgery'."\n" + .'- 疑似合成攻击 SuspectPSFace'."\n" + .'- 疑似黑产攻击 SuspectTemple'."\n" + .'- 疑似翻拍人脸 SuspectRemake', + 'type' => 'string', + 'example' => 'SuspectDeepForgery, SuspectPSFace', + ], + 'RiskScore' => [ + 'description' => '风险分值Map。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "SuspectPSFace": "1.0000",'."\n" + .' "SuspectDeepForgery": "0.8619",'."\n" + .' "SuspectRemake": "0.0126",'."\n" + .' "SuspectTemple": "0.0985"'."\n" + .' }', + 'description' => '风险分值标签及其分值。', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery, SuspectPSFace\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"1.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.8619\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0126\\\\\\",\\\\n \\\\\\"SuspectTemple\\\\\\": \\\\\\"0.0985\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '人脸Deepfake检测服务', + 'description' => '> 人脸Deepfake检测接口当前处于免费公测阶段，免费公测的截止时间为2024年8月30日23:59:59，公测期间QPS不能超过3次/秒。'."\n" + ."\n" + .'- 服务地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + 'requestParamsDescription' => '为了确保模型效果稳定，您需要确保传入的图片中为人脸图片且该人脸的角度正常。此外，还需要满足以下条件：'."\n" + ."\n" + .'- 图片格式：JPG，JPEG。'."\n" + .'- 图片大小：推荐50~100 KB，最大不超过1 MB。'."\n" + .'- 图片分辨率：建议640×480（高×宽），不超过1920×1080（高×宽），且保持照片的高大于宽。推荐短边缩放到720像素，压缩率0.8。'."\n" + .'- 图片质量：照片清晰、曝光正常，脸部无过黑、过亮、光晕等情况。'."\n" + .'- 图片人脸：当图片出现多人脸，系统会默认检测最大脸。', + ], + 'CredentialProductVerifyV2' => [ + 'summary' => '商品图片篡改检测服务的API接口。接口可检测图片篡改、质量（清晰度）及相似图。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证类型：仅支持取值：05 （商品图片）', + 'type' => 'string', + 'required' => true, + 'example' => '05', + 'enum' => [ + '05', + ], + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证名称：仅支持取值：0501（商品图片）', + 'type' => 'string', + 'required' => true, + 'example' => '0501', + 'enum' => [ + '0501', + ], + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片的url地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyundoc.com/picture*****.jpeg', + ], + ], + [ + 'name' => 'ImageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '图⽚的InputStream对象。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyundoc.com/picture*****.jpeg', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => '商户编号。', + 'type' => 'string', + 'required' => false, + 'example' => '无。', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '调用模式：'."\n" + .'仅支持取值：ANTI_FAKE_CHECK 。', + 'type' => 'string', + 'required' => true, + 'example' => 'ANTI_FAKE_CHECK', + 'enum' => [ + 'ANTI_FAKE_CHECK', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '- 0：低风险'."\n" + .'- 1：高风险'."\n" + .'- 2：可疑', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => '风险标签，多个标签用英文逗号隔开，包括：'."\n" + .'- PS：图片PS'."\n" + .'- LOW_QUALITY_PRODUCT：低质量（清晰度低）'."\n" + .'- SAME_BACKGROUND：图片相似', + 'type' => 'string', + 'example' => 'PS,LOW_QUALITY_PRODUCT', + ], + 'RiskScore' => [ + 'description' => '风险分值map。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .'"PS": "0.0211",'."\n" + .'"SAME_BACKGROUND": "0.0861"'."\n" + .'}', + 'description' => '风险分值。'."\n" + .'仅支持PS、SAME_BACKGROUND返回分值。', + ], + ], + 'MaterialInfo' => [ + 'description' => '其他信息，JSON格式。', + 'type' => 'string', + 'example' => '{'."\n" + .' "sameBackgroundDetail": {'."\n" + .' // 相似背景对于的原始图请求RequestId'."\n" + .' "originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + .' // 相似背景对于的原始图请求商户ID '."\n" + .' "originalMerchantId": "xxxxxxxx" '."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,LOW_QUALITY_PRODUCT\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"PS\\\\\\": \\\\\\"0.0211\\\\\\",\\\\n\\\\\\"SAME_BACKGROUND\\\\\\": \\\\\\"0.0861\\\\\\"\\\\n}\\"\\n },\\n \\"MaterialInfo\\": \\"{\\\\n \\\\\\"sameBackgroundDetail\\\\\\": {\\\\n // 相似背景对于的原始图请求RequestId\\\\n \\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n // 相似背景对于的原始图请求商户ID \\\\n \\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\" \\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '商品图片篡改检测服务', + 'description' => '传入电商商品图片，执行图片篡改、质量（清晰度）及相似图检测，返回风险标签及风险分值。', + ], + 'CredentialVerifyV2' => [ + 'summary' => '凭证核验', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证类型：'."\n" + ."\n" + .'- 01：个人卡证类'."\n" + .'- 02：经营场景类'."\n" + .'- 03：企业资质类', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 01：个人卡证类'."\n" + .' - 0101：身份证'."\n" + .' - 0102：银行卡'."\n" + .' - 0104：教师资格证'."\n" + .' - 0107：学生证'."\n" + .'- 02：经营场景类'."\n" + .' - 0201：门头照'."\n" + .' - 0202：柜台照'."\n" + .' - 0203：场景照'."\n" + .'- 03：企业资质类'."\n" + .' - 0301：工商营业执照', + 'type' => 'string', + 'required' => false, + 'example' => '0104'."\n", + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片地址，`imageUrl`与`imageFile`与`imageContext`任选一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg', + ], + ], + [ + 'name' => 'ImageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片输入流，`imageUrl`与`imageFile`与`imageContext`任选一个。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'ImageContext', + 'in' => 'formData', + 'schema' => [ + 'description' => '图⽚Base64编码，`imageUrl`与`imageFile`与`imageContext`任选一个。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'IsOcr', + 'in' => 'query', + 'schema' => [ + 'description' => '是否ocr'."\n" + .'><danger>已废弃></danger>', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IsCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启权威认证'."\n" + ."\n" + .'- ****0****：否'."\n" + .'- **1**：是'."\n" + .'><danger>已废弃></danger>', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号码。', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'CertNum', + 'in' => 'query', + 'schema' => [ + 'description' => '相关证书编号。', + 'type' => 'string', + 'required' => false, + 'example' => '4601*****', + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => '商户编号。****CredName****取值**02**时，此字段需要输入。', + 'type' => 'string', + 'required' => false, + 'example' => '无。', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '调用模式：'."\n" + ."\n" + .'- ANTI_FAKE_CHECK: 图片防伪检测'."\n" + ."\n" + .'- ANTI_FAKE_VL: 图片防伪检测及语义理解'."\n" + ."\n" + .'- IMAGE_VL_COG：图片语义理解'."\n" + ."\n" + .'默认取值 ANTI_FAKE_CHECK'."\n" + ."\n" + .'当且仅当CredType取值02时，ProductCode才能取值为ANTI_FAKE_VL或者IMAGE_VL_COG', + 'type' => 'string', + 'required' => false, + 'example' => 'ANTI_FAKE_CHECK', + ], + ], + [ + 'name' => 'PromptModel', + 'in' => 'query', + 'schema' => [ + 'description' => '图片语义理解prompt获取方式：'."\n" + ."\n" + .'- DEFAULT：系统默认'."\n" + ."\n" + .'- CUSTOM：客户自定义'."\n" + ."\n" + .'说明：当ProductCode取值ANTI_FAKE_VL或者IMAGE_VL_COG时，此项参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'description' => '图片语义理解，客户自定义prompt内容。'."\n" + ."\n" + .'当PromptModel取值CUSTOM，此项必输。', + 'type' => 'string', + 'required' => false, + 'example' => '无'."\n", + ], + ], + [ + 'name' => 'MerchantDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '商户详细信息：'."\n" + ."\n" + .'MerchantName：商户名称'."\n" + ."\n" + .'BusinessType：行业信息'."\n" + ."\n" + .'BusinessContent：经营内容'."\n" + ."\n" + .'PromptModel 传 DEFAULT时，此项必填。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '关键字key。', + 'type' => 'string', + 'required' => false, + 'example' => 'MerchantName', + ], + 'Value' => [ + 'description' => '关键字value。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '风险结果'."\n" + ."\n" + .'- 0：低风险'."\n" + .'- 1：高风险'."\n" + .'- 2：可疑', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => '风险标签，多个标签用半角逗号（,）隔开，包括：'."\n" + ."\n" + .'- PS：图片PS。'."\n" + .'- SCREEN_PHOTO：屏幕翻拍。'."\n" + .'- SCREENSHOT：屏幕截屏。'."\n" + .'- WATERMARK：水印。'."\n" + .'- SAME_BACKGROUND：背景相似。'."\n" + .'- ORIGINAL_PHOTO：非原始图', + 'type' => 'string', + 'example' => 'PS,SCREEN_PHOTO', + ], + 'RiskScore' => [ + 'description' => '风险分值Map。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "PS": "0.9458",'."\n" + .' "SCREEN_PHOTO": "0.1781",'."\n" + .' "WATERMARK": "0.1863"'."\n" + .'}', + 'description' => '风险分值。', + ], + ], + 'OcrInfo' => [ + 'description' => 'OCR识别结果。'."\n" + .'><danger>已废弃></danger>', + 'type' => 'string', + 'example' => '{'."\n" + .' "certNo":"20216*********",'."\n" + .' "certType":"小学教师资格",'."\n" + .' "gender":"男",'."\n" + .' "subject":"美术",'."\n" + .' "name":"李**",'."\n" + .' "ext_info":"{}",'."\n" + .' "birthDate":"1998-07-28",'."\n" + .' "idNo":"620************",'."\n" + .' "certOrg":""'."\n" + .'}', + ], + 'VerifyResult' => [ + 'description' => '权威验证结果'."\n" + .'><danger>已废弃></danger>', + 'type' => 'string', + 'example' => ' *', + ], + 'VerifyDetail' => [ + 'description' => '权威验证详情。'."\n" + .'><danger>已废弃></danger>', + 'type' => 'string', + 'example' => '**', + ], + 'MaterialInfo' => [ + 'description' => '其他信息，JSON格式。', + 'type' => 'string', + 'example' => '{'."\n" + ."\n" + .'"sameBackgroundDetail": {'."\n" + ."\n" + .'// 相似背景对于的原始图请求RequestId'."\n" + ."\n" + .'"originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + ."\n" + .'// 相似背景对于的原始图请求商户ID'."\n" + ."\n" + .'"originalMerchantId": "xxxxxxxx"'."\n" + ."\n" + .'}'."\n" + ."\n" + .'}', + ], + 'VlResult' => [ + 'description' => '通义千问解释。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '通义千问解释成功标识'."\n" + ."\n" + .'true：成功'."\n" + ."\n" + .'false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VlContent' => [ + 'description' => '图片理解结果：'."\n" + ."\n" + .'- 入参PromptModel 传 DEFAULT时，输出格式参考右侧示例值。'."\n" + ."\n" + .'- 入参PromptModel 传 CUSTOM，输出格式按照Prompt约定格式输出。', + 'type' => 'string', + 'example' => '{'."\n" + .' "CHK_DOOR_PHOTO":1, -- 是否门头照 1：是 0：否'."\n" + .' "CHK_INTERIOR_PHOTO":0, -- 是否内景照 1：是 0：否'."\n" + .' "CHK_COUNTER_PHOTO":0 -- 是否柜台照 1：是 0：否'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,SCREEN_PHOTO\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PS\\\\\\": \\\\\\"0.9458\\\\\\",\\\\n \\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.1781\\\\\\",\\\\n \\\\\\"WATERMARK\\\\\\": \\\\\\"0.1863\\\\\\"\\\\n}\\"\\n },\\n \\"OcrInfo\\": \\"{\\\\n \\\\\\"certNo\\\\\\":\\\\\\"20216*********\\\\\\",\\\\n \\\\\\"certType\\\\\\":\\\\\\"小学教师资格\\\\\\",\\\\n \\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\n \\\\\\"subject\\\\\\":\\\\\\"美术\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"李**\\\\\\",\\\\n \\\\\\"ext_info\\\\\\":\\\\\\"{}\\\\\\",\\\\n \\\\\\"birthDate\\\\\\":\\\\\\"1998-07-28\\\\\\",\\\\n \\\\\\"idNo\\\\\\":\\\\\\"620************\\\\\\",\\\\n \\\\\\"certOrg\\\\\\":\\\\\\"\\\\\\"\\\\n}\\",\\n \\"VerifyResult\\": \\" *\\",\\n \\"VerifyDetail\\": \\"**\\",\\n \\"MaterialInfo\\": \\"{\\\\n\\\\n\\\\\\"sameBackgroundDetail\\\\\\": {\\\\n\\\\n// 相似背景对于的原始图请求RequestId\\\\n\\\\n\\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n\\\\n// 相似背景对于的原始图请求商户ID\\\\n\\\\n\\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\"\\\\n\\\\n}\\\\n\\\\n}\\",\\n \\"VlResult\\": {\\n \\"Success\\": true,\\n \\"VlContent\\": \\"{\\\\n \\\\\\"CHK_DOOR_PHOTO\\\\\\":1, -- 是否门头照 1：是 0：否\\\\n \\\\\\"CHK_INTERIOR_PHOTO\\\\\\":0, -- 是否内景照 1：是 0：否\\\\n \\\\\\"CHK_COUNTER_PHOTO\\\\\\":0 -- 是否柜台照 1：是 0：否\\\\n}\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '凭证核验V2', + 'description' => '传入凭证图片信息，执行图片篡改及伪造检测、图片语义理解。返回风险检测结果。', + ], + 'CredentialVerify' => [ + 'summary' => '凭证核验', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219634', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNYJI62', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CredType', + 'in' => 'query', + 'schema' => [ + 'description' => '凭证类型：'."\n" + ."\n" + .'- 01：个人卡证类'."\n" + .'- 02：经营场景类'."\n" + .'- 03：企业资质类', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'CredName', + 'in' => 'query', + 'schema' => [ + 'description' => '- 01：个人卡证类'."\n" + .' - 0101：身份证'."\n" + .' - 0102：银行卡'."\n" + .' - 0104：教师资格证'."\n" + .' - 0107：学生证'."\n" + .'- 02：经营场景类'."\n" + .' - 0201：门头照'."\n" + .' - 0202：柜台照'."\n" + .' - 0203：场景照'."\n" + .'- 03：企业资质类'."\n" + .' - 0301：工商营业执照', + 'type' => 'string', + 'required' => false, + 'example' => '0104'."\n", + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片地址，`imageUrl`与`imageContext`任选一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg', + ], + ], + [ + 'name' => 'ImageContext', + 'in' => 'formData', + 'schema' => [ + 'description' => '图⽚Base64编码，`imageUrl`与`imageContext`任选一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + ], + ], + [ + 'name' => 'IsOCR', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启OCR识别。'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是'."\n" + ."\n" + .'仅当**CredType**取值**01**时，**isOCR**可设置为**1**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IsCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启权威认证'."\n" + ."\n" + .'- ****0****：否'."\n" + .'- **1**：是', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号码。', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'CertNum', + 'in' => 'query', + 'schema' => [ + 'description' => '相关证书编号。', + 'type' => 'string', + 'required' => false, + 'example' => '4601*****', + ], + ], + [ + 'name' => 'MerchantId', + 'in' => 'query', + 'schema' => [ + 'description' => '商户编号。****CredName****取值**02**时，此字段需要输入。', + 'type' => 'string', + 'required' => false, + 'example' => '无。', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '调用模式：'."\n" + ."\n" + .'* ANTI_FAKE_CHECK: 图片防伪检测'."\n" + ."\n" + .'* ANTI_FAKE_VL: 图片防伪检测及语义理解'."\n" + ."\n" + .'* IMAGE_VL_COG：图片语义理解'."\n" + ."\n" + .'默认取值 ANTI_FAKE_CHECK'."\n" + ."\n" + .'当且仅当CredType取值02时，ProductCode才能取值为ANTI_FAKE_VL或者IMAGE_VL_COG', + 'type' => 'string', + 'required' => false, + 'example' => 'ANTI_FAKE_CHECK', + ], + ], + [ + 'name' => 'PromptModel', + 'in' => 'query', + 'schema' => [ + 'description' => '图片语义理解prompt获取方式：'."\n" + ."\n" + .'* DEFAULT：系统默认'."\n" + ."\n" + .'* CUSTOM：客户自定义'."\n" + ."\n" + .'说明：当ProductCode取值ANTI_FAKE_VL或者IMAGE_VL_COG时，此项参数必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DEFAULT', + ], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => [ + 'description' => '图片语义理解，客户自定义prompt内容。'."\n" + ."\n" + .'当PromptModel取值CUSTOM，此项必输。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'MerchantDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '当PromptModel取值DEFAULT，此项必填', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '替换关键字key', + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + 'Value' => [ + 'description' => '替换关键字value', + 'type' => 'string', + 'required' => false, + 'example' => '关键字', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '风险结果：'."\n" + ."\n" + .'- **0**：低风险。'."\n" + .'- **1**：高风险。'."\n" + .'- ****2****：可疑。', + 'type' => 'string', + 'example' => '1', + ], + 'RiskTag' => [ + 'description' => '风险标签，多个标签用半角逗号（,）隔开，包括：'."\n" + ."\n" + .'- PS：图片PS。'."\n" + .'- SCREEN_PHOTO：屏幕翻拍。'."\n" + .'- SCREENSHOT：屏幕截屏。'."\n" + .'- WATERMARK：水印。'."\n" + .'- COLOR_PRINT：彩打复印。'."\n" + .'- WEB_IMAGE: 网络照片。'."\n" + .'- SAME_FACE：人脸相似。'."\n" + .'- SAME_BACKGROUND：背景相似。', + 'type' => 'string', + 'example' => 'PS,SCREEN_PHOTO', + ], + 'RiskScore' => [ + 'description' => '风险分值Map。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "PS": "0.9458",'."\n" + .' "SCREEN_PHOTO": "0.1781",'."\n" + .' "WATERMARK": "0.1863"'."\n" + .'}', + 'description' => '风险分值。', + ], + ], + 'OcrInfo' => [ + 'description' => 'OCR识别结果。', + 'type' => 'string', + 'example' => '{'."\n" + .' "certNo":"20216*********",'."\n" + .' "certType":"小学教师资格",'."\n" + .' "gender":"男",'."\n" + .' "subject":"美术",'."\n" + .' "name":"李**",'."\n" + .' "ext_info":"{}",'."\n" + .' "birthDate":"1998-07-28",'."\n" + .' "idNo":"620************",'."\n" + .' "certOrg":""'."\n" + .'}', + ], + 'VerifyResult' => [ + 'description' => '权威验证结果。', + 'type' => 'string', + 'example' => ' *', + ], + 'VerifyDetail' => [ + 'description' => '权威验证详情。', + 'type' => 'string', + 'example' => '**', + ], + 'MaterialInfo' => [ + 'description' => '其他信息，JSON格式。', + 'type' => 'string', + 'example' => '{'."\n" + ."\n" + .'"sameBackgroundDetail": {'."\n" + ."\n" + .'// 相似背景对于的原始图请求RequestId'."\n" + ."\n" + .'"originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";'."\n" + ."\n" + .'// 相似背景对于的原始图请求商户ID'."\n" + ."\n" + .'"originalMerchantId": "xxxxxxxx"'."\n" + ."\n" + .'}'."\n" + ."\n" + .'}', + ], + 'VlResult' => [ + 'description' => '通义千问解释', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '通义千问解释成功标识'."\n" + ."\n" + .'true：成功'."\n" + ."\n" + .'false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VlContent' => [ + 'description' => '通义千问解释内容', + 'type' => 'string', + 'example' => '{\\"这张图有没有明显的PS特征\\":0,\\"图片是否为正常经营照片\\":1,\\"图片中有没有58、美团、大众点评字样\\":0,\\"这张图有没有网站信息\\":0,\\"图片经营的场景是否为酒店\\":0}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS,SCREEN_PHOTO\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PS\\\\\\": \\\\\\"0.9458\\\\\\",\\\\n \\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.1781\\\\\\",\\\\n \\\\\\"WATERMARK\\\\\\": \\\\\\"0.1863\\\\\\"\\\\n}\\"\\n },\\n \\"OcrInfo\\": \\"{\\\\n \\\\\\"certNo\\\\\\":\\\\\\"20216*********\\\\\\",\\\\n \\\\\\"certType\\\\\\":\\\\\\"小学教师资格\\\\\\",\\\\n \\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\n \\\\\\"subject\\\\\\":\\\\\\"美术\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"李**\\\\\\",\\\\n \\\\\\"ext_info\\\\\\":\\\\\\"{}\\\\\\",\\\\n \\\\\\"birthDate\\\\\\":\\\\\\"1998-07-28\\\\\\",\\\\n \\\\\\"idNo\\\\\\":\\\\\\"620************\\\\\\",\\\\n \\\\\\"certOrg\\\\\\":\\\\\\"\\\\\\"\\\\n}\\",\\n \\"VerifyResult\\": \\" *\\",\\n \\"VerifyDetail\\": \\"**\\",\\n \\"MaterialInfo\\": \\"{\\\\n\\\\n\\\\\\"sameBackgroundDetail\\\\\\": {\\\\n\\\\n// 相似背景对于的原始图请求RequestId\\\\n\\\\n\\\\\\"originalRequestId\\\\\\": \\\\\\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\\\";\\\\n\\\\n// 相似背景对于的原始图请求商户ID\\\\n\\\\n\\\\\\"originalMerchantId\\\\\\": \\\\\\"xxxxxxxx\\\\\\"\\\\n\\\\n}\\\\n\\\\n}\\",\\n \\"VlResult\\": {\\n \\"Success\\": true,\\n \\"VlContent\\": \\"{\\\\\\\\\\\\\\"这张图有没有明显的PS特征\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"图片是否为正常经营照片\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"图片中有没有58、美团、大众点评字样\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"这张图有没有网站信息\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"图片经营的场景是否为酒店\\\\\\\\\\\\\\":0}\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Credential verification', + 'description' => '- 服务地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + 'requestParamsDescription' => '参数`imageUrl`或`imageContext`对应的图片必须符合以下规则：'."\n" + ."\n" + .'- 图片格式：支持PNG、JPG、JPEG、BMP和WebP格式。'."\n" + .'- 图片尺寸：图片长宽需要大于15像素，小于8192像素，且长宽比需要小于50。'."\n" + .' > 为了确保较好的识别效果，建议图像的长宽均大于500像素。'."\n" + .'- 图片大小：图片二进制文件不能超过10 MB。'."\n" + .' > 图片过大会影响接口响应速度，建议使用小于 1.5 MB图片。', + ], + 'BankMetaVerify' => [ + 'summary' => '银行卡要素（银行卡二要素、银行卡三要素和银行卡四要素）API接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '208613', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth883TGF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：MD5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => 'normal', + 'md5' => 'md5', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VerifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'VERIFY_BANK_CARD：银行卡认证模式。表示将传入的银行卡号和用户的真实姓名、身份证号，手机号是否匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'VERIFY_BANK_CARD', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '调用产品类型：'."\n" + ."\n" + .'- BANK_CARD_2_META：银⾏卡号+姓名核验。'."\n" + .'- BANK_CARD_3_META：银⾏卡号+姓名+身份证号核验。'."\n" + .'- BANK_CARD_4_META：银⾏卡号+姓名+身份证号+⼿机号核验。', + 'type' => 'string', + 'required' => false, + 'example' => 'BANK_CARD_2_META', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。'."\n" + ."\n" + .'- 当paramType取值normal时，输入姓名明文。'."\n" + .'- 当paramType取值md5时，姓名第一个字MD5加密（32位小写MD5）+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。'."\n" + ."\n" + .'- 当ProductType取值BANK_CARD_3_META时，此项必选。'."\n" + .'- 当paramType取值normal时，输入身份证号明文。'."\n" + .'- 当paramType取值md5时，身份证号前6位明文+出生年月日md5加密（32位小写MD5）+身份证号后4位。', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'BankCard', + 'in' => 'query', + 'schema' => [ + 'description' => '银行卡号。'."\n" + ."\n" + .'- 当paramType取值normal时，输入银行卡号明文。'."\n" + .'- 当paramType取值md5时，卡号除最后6位其他部分明文+最后6位md5值（32位小写）。', + 'type' => 'string', + 'required' => false, + 'example' => '610*************1181', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号。'."\n" + ."\n" + .'- 当ProductType取值BANK_CARD_4_META时，此项必选。'."\n" + .'- 当paramType取值normal时，输入手机号明文。'."\n" + .'- 当paramType取值md5时，输入手机号（32位小写MD5）。', + 'type' => 'string', + 'required' => false, + 'example' => '138******11', + ], + ], + [ + 'name' => 'IdentityType', + 'in' => 'query', + 'schema' => [ + 'description' => '证件类型。', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-A***B-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果。'."\n" + ."\n" + .'- 1：校验⼀致（计费）'."\n" + .'- 2：校验不⼀致（计费）'."\n" + .'- 3：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '核验详情：'."\n" + ."\n" + .'- **101**：验证通过。'."\n" + .'- **201**：认证信息不一致，持卡人信息有误。'."\n" + .'- **202**：认证信息不一致，银行卡未开通认证支付。'."\n" + .'- **203**：认证信息不一致，银行卡已过期。'."\n" + .'- **204**：认证信息不一致，银行卡为受限制的卡。'."\n" + .'- **205**：认证信息不一致，此卡被没收。'."\n" + .'- **206**：认证信息不一致，银行卡无效。'."\n" + .'- **207**：认证信息不一致，此卡无对应发卡行。'."\n" + .'- **208**：认证信息不一致，该卡未初始化或睡眠卡。'."\n" + .'- **209**：认证信息不一致，此卡为作弊卡、吞卡。'."\n" + .'- **210**：认证信息不一致，此卡已挂失。'."\n" + .'- **211**：认证信息不一致，密码错误次数超限。'."\n" + .'- **212**：认证信息不一致，发卡行不支持此交易。'."\n" + .'- **213**：认证信息不一致，卡状态不正常或卡无效。'."\n" + .'- **214**：认证信息不一致，未预留手机号。'."\n" + .'- **215**：认证信息不一致，输入的密码、有效期或CVN2有误。'."\n" + .'- **216**：认证信息不一致，其他卡异常情况。'."\n" + .'- **301**：无法验证，银行卡不支持该业务。'."\n" + .'- **302**：无法验证，验证失败或银行拒绝验证，请联系发卡行。'."\n" + .'- **303**：无法验证，银行卡暂不支持手机号验证。'."\n" + .'- **304**：无法验证，银行卡号有误。'."\n" + .'- **305**：无法验证，其他原因。'."\n" + .'- **306**：无法验证，验证次数超限。', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => '银行卡二，三，四要素核验', + 'description' => '银行卡核验， 包含：银行卡二要素（姓名+银行卡号），银行卡三要素（姓名+身份证号码+银行卡号）四要素（姓名+身份证号码+手机号+银行卡号）的一致性核验。'."\n" + .'- 服务地址：'."\n" + .' - 北京地域：cloudauth.cn-beijing.aliyuncs.com（IPv4）或cloudauth-dualstack.cn-beijing.aliyuncs.com（IPv6）。'."\n" + .' - 上海地域：cloudauth.cn-shanghai.aliyuncs.com（IPv4）或cloudauth-dualstack.cn-shanghai.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + ], + 'MobileRecycledMetaVerify' => [ + 'summary' => '手机号二次放号核验。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '加密方式：'."\n" + .'- normal：明文不加密'."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'RegisterDate', + 'in' => 'query', + 'schema' => [ + 'description' => '注册日期，格式：YYYYMMDD，例如19800101，即1980年01月01日。', + 'type' => 'string', + 'required' => true, + 'example' => '20200505', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号：'."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => true, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码：200表示成功，其他均为失败。'."\n" + .'重要'."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务核验结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '返回的结果', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '查询结果：'."\n" + ."\n" + .'- 1：有查询结果'."\n" + .'- 3：无查询结果', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '核验详细结果：'."\n" + ."\n" + .'- 101:注册时间大于等于手机号入网时间'."\n" + .'- 102:注册时间小于手机号入网时间'."\n" + .'- 103:新入网用户暂未同步'."\n" + .'- 301:数据异常/离网用户', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号二次放号核验', + 'description' => '传入手机号、手机号注册时间，通过权威数据源验证其真实性和一致性。', + ], + 'MobileDetect' => [ + 'summary' => '号码检测。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '218021', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + .'- normal：明文不加密'."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号列表。', + 'type' => 'string', + 'required' => false, + 'example' => '19833232569', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'ChargeCount' => [ + 'description' => '计费次数，一次请求中所有计费次数', + 'type' => 'string', + 'example' => '2', + ], + 'Items' => [ + 'description' => '核验结果集', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'Mobile' => [ + 'description' => '手机号', + 'type' => 'string', + 'example' => '131********', + ], + 'BizCode' => [ + 'description' => '核验结果'."\n" + ."\n" + .'- 1: 在网可用 '."\n" + .'- 2: 非在网可用状态'."\n" + .'- 3: 无查询结果', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '核验详情'."\n" + ."\n" + .'- 101:可用号'."\n" + .'- 102:空号'."\n" + .'- 103:停机 '."\n" + .'- 104:沉默号（近半年不活跃小号，新号，非智能机用户） '."\n" + .'- 105:风险号 （长时间关机或未开通语音服务以及易投诉的用户）'."\n" + .'- 301:查无记录', + 'type' => 'string', + 'example' => '101', + ], + 'IspName' => [ + 'description' => '运营商名称'."\n" + ."\n" + .'- CMCC：移动 '."\n" + .'- CUCC：联通 '."\n" + .'- CTCC：电信', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'Area' => [ + 'description' => '手机号归属地（只有明文手机号有）', + 'type' => 'string', + 'example' => '安徽-马**', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"ChargeCount\\": \\"2\\",\\n \\"Items\\": [\\n {\\n \\"Mobile\\": \\"131********\\",\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"Area\\": \\"安徽-马**\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '号码批量检测', + ], + 'Mobile3MetaSimpleVerify' => [ + 'summary' => '传入姓名和身份证号，通过权威数据源验证其真实性和一致性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194556', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + ."\n" + .'- normal：明文不加密'."\n" + ."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'说明'."\n" + .'仅支持二代居民身份证和港澳台居住证的证件号码。'."\n" + ."\n" + .'- paramType 传 normal 时：传入身份证号明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入身份证号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：传入姓名明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入姓名密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + ."\n" + .'- **CMCC**：移动。'."\n" + .'- **CUCC**：联通。'."\n" + .'- **CTCC**：电信。', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号三要素简版接口', + 'description' => '- 服务地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + ], + 'Mobile3MetaDetailVerify' => [ + 'summary' => '传入手机号、姓名、身份证号，通过权威数据源验证其真实性和一致性，如果不一致，返回不一致的原因。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194557', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + ."\n" + .'- normal：明文不加密'."\n" + ."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'说明'."\n" + .'仅支持二代居民身份证和港澳台居住证的证件号码。'."\n" + ."\n" + .'- paramType 传 normal 时：传入身份证号明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入身份证号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：传入姓名明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入姓名密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + ."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '核验详细结果：'."\n" + ."\n" + .'- **101**:验证通过。'."\n" + .'- **201**:⼿机号和姓名不⼀致，⼿机号和证件号不⼀致。'."\n" + .'- **202**:⼿机号和姓名⼀致，⼿机号和证件号不⼀致。'."\n" + .'- **203**:⼿机号和证件号⼀致，⼿机号和姓名不⼀致。'."\n" + .'- **204**:其他不⼀致。'."\n" + .'- **301**:查⽆记录。', + 'type' => 'string', + 'example' => '101', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + ."\n" + .'- **CMCC**：移动。'."\n" + .'- **CUCC**：联通。'."\n" + .'- **CTCC**：电信。', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号三要素详版接口', + 'description' => '- 服务地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + ], + 'Mobile2MetaVerify' => [ + 'summary' => '手机二要素核验', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + .'- normal：明文不加密'."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + .'- paramType 传 normal 时：传入姓名明文。'."\n" + .'- paramType 传 md5 时：传入姓名密文。', + 'type' => 'string', + 'required' => true, + 'example' => '● 明文：张三'."\n" + .'● 密文：'."\n" + .'32fa7bcd874161bea8ec8fd98f390ec9', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => true, + 'example' => '● 明文：186****2055'."\n" + .'● 密文：'."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果：'."\n" + .'- 1：校验⼀致'."\n" + .'- 2：校验不⼀致'."\n" + .'- 3：查⽆记录', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + .'- CMCC：移动'."\n" + .'- CUCC：联通'."\n" + .'- CTCC：电信', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => '手机二要素核验', + 'description' => '传入手机号、姓名，通过权威数据源验证其真实性和一致性。', + ], + 'MobileOnlineTime' => [ + 'summary' => '查询手机号在网时长。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216495', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：186****2055'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'849169cd3b20621c1c78bd61a11a4fc2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码。'."\n" + .'- 1：核验一致'."\n" + .'- 2：核验不一致'."\n" + .'- 3：查无记录', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => '运营商名称'."\n" + ."\n" + .'- CMCC：移动 '."\n" + .'- CUCC：联通 '."\n" + .'- CTCC：电信', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'TimeCode' => [ + 'description' => '- 1:[0,3)表示在网时长是 0~3 个月 '."\n" + .'- 2: [3,6)表示在网时长是 3~6 个月 '."\n" + .'- 3: [6,12)表示在网时长是 6~12 个月 '."\n" + .'- 4: [12,24)表示在网时长是 12~24 月 '."\n" + .'- 5: [24,+)表示在网时长是 24 个月以上', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"TimeCode\\": \\"5\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号在网时长', + ], + 'MobileOnlineStatus' => [ + 'summary' => '查询手机号在网状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216535', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '13665148158', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果'."\n" + ."\n" + .'- 1: 在网可用 '."\n" + .'- 2: 非在网可用状态（详见subCode）'."\n" + .'- 3: 无查询结果', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => '运营商名称'."\n" + ."\n" + .'- CMCC：移动 '."\n" + .'- CUCC：联通 '."\n" + .'- CTCC：电信', + 'type' => 'string', + 'example' => 'CMCC', + ], + 'SubCode' => [ + 'description' => '核验详情'."\n" + ."\n" + .'- 101:在网可用 '."\n" + .'- 201:停机 '."\n" + .'- 202:销号 '."\n" + .'- 203:在网但不可用 '."\n" + .'- 204:不在网 '."\n" + .'- 301:查无记录', + 'type' => 'string', + 'example' => '101', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号在网状态', + ], + 'Mobile3MetaSimpleStandardVerify' => [ + 'summary' => '手机号三要素简版_标准版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '257102', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入身份证号明文。'."\n" + .'- paramType 传 md5 时：传入身份证号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：传入姓名明文。'."\n" + .'- paramType 传 md5 时：传入姓名密文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '130********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果。'."\n" + ."\n" + .'- 1：校验⼀致（计费）'."\n" + .'- 2：校验不⼀致（计费）'."\n" + .'- 3：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + ."\n" + .'- **CMCC**：移动。'."\n" + .'- **CUCC**：联通。'."\n" + .'- **CTCC**：电信。'."\n" + .'- **CBCC**：广电。', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号三要素简版——标准版', + 'description' => '传入手机号、姓名、身份证号，通过权威数据源验证其真实性和一致性。', + ], + 'Mobile3MetaDetailStandardVerify' => [ + 'summary' => '手机号三要素详版_标准版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '257106', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthPZCZ2I', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入身份证号明文。'."\n" + .'- paramType 传 md5 时：传入身份证号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '429001********8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：传入姓名明文。'."\n" + .'- paramType 传 md5 时：传入姓名密文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'formData', + 'schema' => [ + 'description' => '手机号：'."\n" + ."\n" + .'- paramType 传 normal 时：传入手机号明文。'."\n" + .'- paramType 传 md5 时：传入手机号密文。', + 'type' => 'string', + 'required' => false, + 'example' => '138********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + 'SubCode' => [ + 'description' => '核验详细结果：'."\n" + ."\n" + .'- 101：验证通过 ，三要素校验一致。'."\n" + .'- 201：手机号与姓名、证件号对比均不一致。'."\n" + .'- 202：手机号与姓名一致，但与证件号不一致。'."\n" + .'- 203：手机号与姓名不一致，但与证件号一致。'."\n" + .'- 204：其他不一致。'."\n" + .'- 301：查无记录 。', + 'type' => 'string', + 'example' => '101', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + ."\n" + .'- **CMCC**：移动。'."\n" + .'- **CUCC**：联通。'."\n" + .'- **CTCC**：电信。'."\n" + .'- **CBCC**：广电。', + 'type' => 'string', + 'example' => 'CMCC', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', + 'title' => '手机号三要素详版——标准版', + 'description' => '传入手机号、姓名、身份证号，通过权威数据源验证其真实性和一致性，如果不一致，返回不一致的原因。', + ], + 'Id2MetaStandardVerify' => [ + 'summary' => '身份二要素标准版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '250706', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'- paramType 传 normal 时：输入身份证号明文。'."\n" + .'- paramType 传 md5 时：'."\n" + .'身份证号前6位（明文）+出生年月日（密文）+身份证号后4位（明文）。', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：输入姓名明文。'."\n" + .'- paramType 传 md5 时：姓名第一个字密文+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => '身份二要素标准版核验接口', + ], + 'Id2MetaVerify' => [ + 'summary' => '传入姓名和身份证号，通过权威数据源验证其真实性和一致性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '194526', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + ."\n" + .'- normal：明文不加密'."\n" + ."\n" + .'- md5：MD5加密', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'说明'."\n" + .'仅支持二代居民身份证和港澳台居住证的证件号码。'."\n" + ."\n" + .'- paramType 传 normal 时：输入身份证号明文。'."\n" + ."\n" + .'- paramType 传 md5 时：身份证号前6位（明文）+出生年月日（密文）+身份证号后4位（明文）。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：429001********8211'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'42900132fa7bcd874161bea8ec8fd98f390ec98211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + ."\n" + .'- paramType 传 normal 时：输入姓名明文。'."\n" + ."\n" + .'- paramType 传 md5 时：姓名第一个字密文+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '明文：张三'."\n" + ."\n" + .'密文：'."\n" + ."\n" + .'6499fc7409049355527ef6a2ba5706b8三', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => '身份二要素核验接口', + 'description' => '- 服务地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）。'."\n" + .'- 请求方法：POST和GET。'."\n" + .'- 传输协议：HTTPS。', + ], + 'Id2MetaVerifyWithOCR' => [ + 'summary' => 'API服务，入参身份证正反面，OCR提取姓名和身份证号，通过权威源核验其真实性及一致性。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片。'."\n" + .'公网可访问的HTTP、HTTPS链接。'."\n" + .'CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'CertFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片输入流。'."\n" + .'CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CertNationalUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证国徽面图片地址。国徽面'."\n" + .'公网可访问的HTTP、HTTPS链接。'."\n" + .'CertNationalUrl和CertNationalFile二选一入参，也可以都不传递。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg'."\n", + ], + ], + [ + 'name' => 'CertNationalFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证国徽面图片地址。'."\n" + .'CertNationalUrl和CertNationalFile二选一，也可以都不传递。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF03****', + ], + 'Code' => [ + 'description' => '返回码：200表示成功，其他均为失败。'."\n" + .'**重要**'."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务核验结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口调用返回信息。'."\n" + .'**重要**'."\n" + .'此参数仅表示接口是否异常。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '结果对象', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '身份核验结果：'."\n" + .'- 1：校验⼀致'."\n" + .'- 2：校验不⼀致'."\n" + .'- 3：查⽆记录', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => '{"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + 'type' => 'string', + 'example' => 'OCR读取的身份证信息。', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"OCR读取的身份证信息。\\"\\n }\\n}","type":"json"}]', + 'title' => ' 身份二要素图片核验', + 'description' => '传入身份证正反面，返回权威数据源对二要素的校验结果。', + ], + 'Id3MetaVerify' => [ + 'summary' => '纯API，入参姓名、身份证号及人脸照片，通过权威源核验其真实性及一致性。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '加密方式：'."\n" + .'- normal：明文不加密'."\n" + .'- md5：MD5加密'."\n" + ."\n" + .'**重要**'."\n" + ."\n" + .'- 所有参数的密文均取32位小写MD5字符串形式。'."\n" + .'- 不同MD5工具得出的密文可能不同，如果加密前接口可以调通但加密后不行，请尝试更换MD5工具。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + .'- paramType 传 normal 时：输入身份证号明文。'."\n" + .'- paramType 传 md5 时：'."\n" + .'身份证号前6位（明文）+出生年月日（密文）+身份证号后4位（明文）。', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：429001********8211'."\n" + .'● 密文：'."\n" + .'42900132fa7bcd874161bea8ec8fd98f39****8211', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名：'."\n" + .'- paramType 传 normal 时：输入姓名明文。'."\n" + .'- paramType 传 md5 时：姓名第一个字密文+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '● 明文：张三'."\n" + .'● 密文：'."\n" + .'6499fc7409049355527ef6a2ba5706b8三', + ], + ], + [ + 'name' => 'FaceUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片。'."\n" + .'公网可访问的HTTP、HTTPS链接。'."\n" + .'CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'FaceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片输入流。'."\n" + .'CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Crop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否允许裁剪人脸图片，默认不允许。'."\n" + .'- T：表示允许剪裁。'."\n" + .'- F：表示不允许剪裁。'."\n" + ."\n" + .'**说明**'."\n" + ."\n" + .'若您请求的图片并非来自标准活体检测SDK采集，建议您允许裁剪人脸图片。'."\n" + .'开启该功能后，将会对请求的图片先进行人脸裁剪与矫正，完成后会发起请求服务。', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF03****', + ], + 'Code' => [ + 'description' => '返回码：200表示成功，其他均为失败。'."\n" + .'重要'."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务核验结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口调用返回信息。'."\n" + ."\n" + .'**重要**'."\n" + ."\n" + .'此参数仅表示接口是否异常。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '身份核验结果：'."\n" + ."\n" + .'- 1：校验⼀致'."\n" + .'- 2：校验不⼀致'."\n" + .'- 3：查⽆记录', + 'type' => 'string', + 'example' => '1', + ], + 'FaceDetail' => [ + 'description' => '图片比对分值。', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '身份三要素核验', + 'description' => '输入姓名、身份证号及人脸照片，通过权威源核验其真实性及一致性。', + ], + 'Id2MetaPeriodVerify' => [ + 'summary' => '二要素有效期核验接口', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '259667', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：MD5加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证号：'."\n" + ."\n" + .'- paramType 传 normal 时：输入身份证号明文。'."\n" + .'- paramType 传 md5 时：'."\n" + .'身份证号前6位（明文）+出生年月日（密文）+身份证号后4位（明文）。', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '姓名。'."\n" + ."\n" + .'- paramType = normal：输入姓名明文。'."\n" + .'- paramType = md5：姓名第一个字MD5加密（32位小写MD5）+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'ValidityStartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证有效期开始日期，格式：YYYYMMDD', + 'type' => 'string', + 'required' => false, + 'example' => '20201001', + ], + ], + [ + 'name' => 'ValidityEndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证有效期到期日期，格式：YYYYMMDD', + 'type' => 'string', + 'required' => false, + 'example' => '20301001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => '二要素有效期核验', + ], + 'InitCardVerify' => [ + 'summary' => '图片核验发起认证请求', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MerchantBizId', + 'in' => 'query', + 'schema' => [ + 'description' => '您自定义的业务唯一标识，用于后续定位排查问题使用。'."\n" + .'支持长度为32位的字母和数字的组合，请确保唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'MetaInfo环境参数，需要通过客户端SDK获取', + 'type' => 'string', + 'required' => true, + 'example' => '{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}', + ], + ], + [ + 'name' => 'CardType', + 'in' => 'query', + 'schema' => [ + 'description' => '证件类型'."\n" + .'- 居民二代身份证：IDENTITY_CARD', + 'type' => 'string', + 'required' => true, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '核验方式，取值：'."\n" + .'- OCR_VERIFY：OCR识别且认证模式。', + 'type' => 'string', + 'required' => true, + 'example' => 'OCR_VERIFY', + ], + ], + [ + 'name' => 'VerifyMeta', + 'in' => 'query', + 'schema' => [ + 'description' => '核验类型，取值：'."\n" + .'- 身份二要素（姓名+身份证号）：ID_2_META', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_2_META', + ], + ], + [ + 'name' => 'CardPageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'SDK采集卡证页数'."\n" + .'- 可以输入1和2， 输入1采集正面，输入2采集正面+反面。'."\n" + ."\n" + .'- 如果核验类型是身份证有效期（VerifyMeta取值ID_PERIOD），必须输入2。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PictureSave', + 'in' => 'query', + 'schema' => [ + 'description' => '是否临时存储app采集图片信息。'."\n" + .'- Y：是'."\n" + .'- N：否'."\n" + .'- 如果此处选择是，在查询接口支持返回卡证图片信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'Y', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '- 认证结果的回调通知地址，必须以https开头。'."\n" + .'- 平台在完成认证后会回调该地址，并自动添加certifyId、passed字段，示例：https://www.aliyun.com?certifyId=xxxx&passed=T'."\n" + .'- 警告'."\n" + .'仅当认证完成时才会触发回调，若认证中放弃、异常中断或未进行认证均不会通知。建议您收到回调通知时，若有需要可通过查询接口获取认证详情资料信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'query', + 'schema' => [ + 'description' => '安全Token，用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'DocScanMode', + 'in' => 'query', + 'schema' => [ + 'description' => '拍照方式枚举(手动/ 自动拍照)'."\n" + .'- 拍照 shoot'."\n" + .'- 扫描 scan '."\n" + .'- 自动切换 auto', + 'type' => 'string', + 'required' => false, + 'example' => 'shoot', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF039795', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。'."\n" + .'重要'."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '核验请求ID，核验服务认证请求的唯一标识。'."\n" + .'- 查询认证结果时，必须传入认证请求ID。'."\n" + ."\n" + .'- CertifyId字段为计费统计字段，为了方便后续核对账单，请您在本地留存该字段信息。初始化接口返回的认证CertifyId在30分钟有效且仅能认证提交一次，请您在有效期内应用，避免重复使用。', + 'type' => 'string', + 'example' => '91707dc296d469ad38e4c5efa6a0****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"CertifyId\\": \\"91707dc296d469ad38e4c5efa6a0****\\"\\n }\\n}","type":"json"}]', + 'title' => '初始化接口', + 'description' => '每次开始认证前通过本接口获取CertifyId，用来串联认证请求中的各个接口。', + ], + 'DescribeCardVerify' => [ + 'summary' => '图片要素核验获取认证结果', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证请求ID。'."\n" + .'必须先调用初始化接口InitCardVerify提交认证请求，才能获得认证请求ID。', + 'type' => 'string', + 'required' => true, + 'example' => '91707dc296d469ad38e4c5efa6a0xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF03****', + ], + 'Code' => [ + 'description' => '返回码：200表示成功，其他均为失败。'."\n" + .'重要'."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务核验结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口调用返回信息。'."\n" + .'重要'."\n" + .'- 此参数仅表示接口是否异常。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '身份核验结果：'."\n" + .'- 1：校验⼀致'."\n" + .'- 2：校验不⼀致'."\n" + .'- 3：查⽆记录', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => '提交核验的身份证信息。', + 'type' => 'string', + 'example' => '{"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + ], + 'PictureInfo' => [ + 'description' => '返回的照片地址。'."\n" + .'- certUrl 正面'."\n" + .'- certNationalUrl 国徽面', + 'type' => 'string', + 'example' => '{'."\n" + .' "certUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxx/xxxxxxxxxx_ocridface_dbf2_normal.jpeg",'."\n" + .' "certNationalUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxxxxx/xxxxxxxxxxx_ocridback_e8a3_normal.jpeg"'."\n" + .'}', + ], + 'OcrCardInfo' => [ + 'description' => 'OCR读取的身份证信息。', + 'type' => 'string', + 'example' => '{"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + ], + 'FaceDetail' => [ + 'description' => '图片比对分值。', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"{\\\\\\"address\\\\\\":\\\\\\"浙江省杭州市余杭区文一西路969号\\\\\\",\\\\\\"birthDate\\\\\\":\\\\\\"19901226\\\\\\",\\\\\\"certName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"certNo\\\\\\":\\\\\\"1234561990122*****\\\\\\",\\\\\\"nationality\\\\\\":\\\\\\"汉\\\\\\",\\\\\\"authority\\\\\\":\\\\\\"xxx公安局\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"20201130\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"20301130\\\\\\"}\\",\\n \\"PictureInfo\\": \\"{\\\\n \\\\\\"certUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxx/xxxxxxxxxx_ocridface_dbf2_normal.jpeg\\\\\\",\\\\n \\\\\\"certNationalUrl\\\\\\": \\\\\\"https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxxxxx/xxxxxxxxxxx_ocridback_e8a3_normal.jpeg\\\\\\"\\\\n}\\",\\n \\"OcrCardInfo\\": \\"{\\\\\\"address\\\\\\":\\\\\\"浙江省杭州市余杭区文一西路969号\\\\\\",\\\\\\"birthDate\\\\\\":\\\\\\"19901226\\\\\\",\\\\\\"certName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"certNo\\\\\\":\\\\\\"1234561990122*****\\\\\\",\\\\\\"nationality\\\\\\":\\\\\\"汉\\\\\\",\\\\\\"authority\\\\\\":\\\\\\"xxx公安局\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"20201130\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"20301130\\\\\\"}\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'API for obtaining verify results', + 'description' => '当您收到回调通知之后，可以在服务端通过该接口获取相应的认证状态和认证资料。', + ], + 'Id3MetaVerifyWithOCR' => [ + 'summary' => 'API服务，入参身份证正反面，OCR提取姓名和身份证号及人脸照片，通过权威源核验其（人脸三要素）真实性及一致性。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CertUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片。 公网可访问的HTTP、HTTPS链接。 CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg'."\n", + ], + ], + [ + 'name' => 'CertFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证人像面图片输入流。 CertUrl和CertFile二选一。', + 'type' => 'string', + 'required' => false, + 'example' => '无'."\n", + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'CertNationalUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证国徽面图片地址。国徽面 公网可访问的HTTP、HTTPS链接。 CertNationalUrl和CertNationalFile二选一入参，也可以都不传递。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/cert.jpeg', + ], + ], + [ + 'name' => 'CertNationalFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '身份证国徽面图片地址。 CertNationalUrl和CertNationalFile二选一，也可以都不传递。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'isFileTransferUrl' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '130A2C10-B9EE-4D84-88E3-5384FF03****'."\n", + ], + 'Code' => [ + 'description' => '返回码：200表示成功，其他均为失败。 **重要**'."\n" + ."\n" + .'- 此参数代表是否正确调用了接口，详细的返回码说明请参见错误码。'."\n" + .'- 业务核验结果请通过ResultObject中的字段查看。', + 'type' => 'string', + 'example' => '200'."\n", + ], + 'Message' => [ + 'description' => '接口调用返回信息。 重要 此参数仅表示接口是否异常。', + 'type' => 'string', + 'example' => 'success'."\n", + ], + 'ResultObject' => [ + 'description' => '结果对象。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '身份核验结果：'."\n" + ."\n" + .'- 1：校验⼀致'."\n" + .'- 2：校验不⼀致'."\n" + .'- 3：查⽆记录', + 'type' => 'string', + 'example' => '1', + ], + 'CardInfo' => [ + 'description' => '{"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}', + 'type' => 'string', + 'example' => 'OCR读取的身份证信息。', + ], + 'FaceDetail' => [ + 'description' => '人脸对比分。', + 'type' => 'string', + 'example' => '{'."\n" + .' "verifyScore": 50.28594166529785'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF03****\\\\n\\",\\n \\"Code\\": \\"200\\\\n\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"CardInfo\\": \\"OCR读取的身份证信息。\\",\\n \\"FaceDetail\\": \\"{\\\\n \\\\\\"verifyScore\\\\\\": 50.28594166529785\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '身份三要素图片核验', + 'description' => '传入身份证正反面，返回权威数据源对人脸三素的校验结果。', + ], + 'VehicleMetaVerifyV2' => [ + 'summary' => '车辆要素核验增强版', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232381', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：Md5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VerifyMetaType', + 'in' => 'query', + 'schema' => [ + 'description' => '核验类型'."\n" + ."\n" + .'> '."\n" + .'> - VEHICLE_2_META：二要素核验，姓名+车牌号核验；'."\n" + .'> - VEHICLE_3_META：三要素核验，姓名+车牌号+身份证号核验；', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VEHICLE_3_META' => '三要素核验', + 'VEHICLE_2_META' => '二要素核验', + ], + 'example' => 'VEHICLE_3_META', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。'."\n" + ."\n" + .'当VerifyMetaType取值VEHICLE_3_META，此项必输。'."\n" + ."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文 。'."\n" + .'> - 当paramType取值md5时，身份证号前6位明文+出生年月日md5加密（32位小写MD5）+身份证号后4位。', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名'."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，姓名第一个字MD5加密（32位小写MD5）+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '张*', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号'."\n" + ."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入车牌号除最后两位的其他部分明文+车牌最后两位字母MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528B******', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：核验一致。'."\n" + .'- **2**：核验不一致。'."\n" + .'- **3**：查无记录。', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => '车辆详细信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "approvedCount": "7",'."\n" + .' "approvedLoad": "0",'."\n" + .' "axleCount": "2",'."\n" + .' "backWheelDistance": "1585",'."\n" + .' "brand": "雷克萨斯",'."\n" + .' "displacement": "4608",'."\n" + .' "engineNum": "1*********",'."\n" + .' "engineType": "1**",'."\n" + .' "frontWheelDistance": "1585",'."\n" + .' "fuelType": "汽油",'."\n" + .' "inspectionDate": "****-**-** **:**:**",'."\n" + .' "modelNum": "UR*****-******",'."\n" + .' "power": "228",'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "retirementDate": "****-**-** **:**:**",'."\n" + .' "totalMass": "2940",'."\n" + .' "unladenMass": "2350",'."\n" + .' "useProperty": "非营运",'."\n" + .' "vehicleState": "正常",'."\n" + .' "vin": "JT***************",'."\n" + .' "wheelBase": "2790"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528B******\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n\\\\t\\\\\\"approvedCount\\\\\\": \\\\\\"7\\\\\\",\\\\n\\\\t\\\\\\"approvedLoad\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"axleCount\\\\\\": \\\\\\"2\\\\\\",\\\\n\\\\t\\\\\\"backWheelDistance\\\\\\": \\\\\\"1585\\\\\\",\\\\n\\\\t\\\\\\"brand\\\\\\": \\\\\\"雷克萨斯\\\\\\",\\\\n\\\\t\\\\\\"displacement\\\\\\": \\\\\\"4608\\\\\\",\\\\n\\\\t\\\\\\"engineNum\\\\\\": \\\\\\"1*********\\\\\\",\\\\n\\\\t\\\\\\"engineType\\\\\\": \\\\\\"1**\\\\\\",\\\\n\\\\t\\\\\\"frontWheelDistance\\\\\\": \\\\\\"1585\\\\\\",\\\\n\\\\t\\\\\\"fuelType\\\\\\": \\\\\\"汽油\\\\\\",\\\\n\\\\t\\\\\\"inspectionDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"modelNum\\\\\\": \\\\\\"UR*****-******\\\\\\",\\\\n\\\\t\\\\\\"power\\\\\\": \\\\\\"228\\\\\\",\\\\n\\\\t\\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"retirementDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"totalMass\\\\\\": \\\\\\"2940\\\\\\",\\\\n\\\\t\\\\\\"unladenMass\\\\\\": \\\\\\"2350\\\\\\",\\\\n\\\\t\\\\\\"useProperty\\\\\\": \\\\\\"非营运\\\\\\",\\\\n\\\\t\\\\\\"vehicleState\\\\\\": \\\\\\"正常\\\\\\",\\\\n\\\\t\\\\\\"vin\\\\\\": \\\\\\"JT***************\\\\\\",\\\\n\\\\t\\\\\\"wheelBase\\\\\\": \\\\\\"2790\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '车辆要素核验增强版', + 'description' => '核验姓名、身份证号、车牌号、车辆类型的一致性，并支持返回车辆详情', + 'requestParamsDescription' => 'ParamType，VerifyMetaType，UserName，VehicleNum为必填参数', + ], + 'VehicleMetaVerify' => [ + 'summary' => '车辆要素核验', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232494', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- normal：不加密。'."\n" + .'- md5：md5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VerifyMetaType', + 'in' => 'query', + 'schema' => [ + 'description' => '核验类型'."\n" + ."\n" + .'> '."\n" + .'> - VEHICLE_2_META：二要素核验，姓名+车牌号核验；'."\n" + .'> - VEHICLE_3_META：三要素核验，姓名+车牌号+身份证号核验；', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VEHICLE_3_META' => '三要素核验', + 'VEHICLE_2_META' => '二要素核验', + ], + 'example' => 'VEHICLE_2_META', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。'."\n" + ."\n" + .'当VerifyMetaType取值VEHICLE_3_META，此项必输。'."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文 。'."\n" + .'> - 当paramType取值md5时，身份证号前6位明文+出生年月日md5加密（32位小写MD5）+身份证号后4位', + 'type' => 'string', + 'required' => false, + 'example' => '4****************1', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名'."\n" + ."\n" + .'> 这是说明的内容'."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，姓名第一个字MD5加密（32位小写MD5）+ 姓名其他部分明文。', + 'type' => 'string', + 'required' => false, + 'example' => '张**', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号'."\n" + ."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入车牌号除最后两位的其他部分明文+车牌最后两位字母MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF4*****', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果。'."\n" + ."\n" + .'- 1：校验⼀致（计费）'."\n" + .'- 2：校验不⼀致（计费）'."\n" + .'- 3：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF4*****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => '车辆要素核验', + 'description' => '核验姓名、身份证号、车牌号、车辆类型的一致性', + 'requestParamsDescription' => 'ParamType、VerifyMetaType、VehicleNum、UserName为必填参数', + ], + 'Vehicle5ItemQuery' => [ + 'summary' => '车五项信息识别', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232619', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆类型'."\n" + ."\n" + .'> '."\n" + .'> - 02-普通小客车'."\n" + .'> - 52-新能源小客车', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号'."\n" + ."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入车牌号除最后两位的其他部分明文+车牌最后两位字母MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- **normal**：不加密。'."\n" + .'- **md5**：md5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0D******', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + .'- **1**：查得（计费）'."\n" + .'- **3**：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => '车辆信息', + 'type' => 'string', + 'example' => '{'."\n" + .' "engineNo": "F0******",'."\n" + .' "useProperty": 0,'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "engineType": "B******",'."\n" + .' "vin": "A********",'."\n" + .' "state": "0",'."\n" + .' "modelNo": "B********",'."\n" + .' "type": "小型轿车",'."\n" + .' "brand": "宝马",'."\n" + .' "usePropertyDesc": "非营运",'."\n" + .' "stateDesc": "正常"'."\n" + .' }', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0D******\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n \\\\\\"engineNo\\\\\\": \\\\\\"F0******\\\\\\",\\\\n \\\\\\"useProperty\\\\\\": 0,\\\\n \\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n \\\\\\"engineType\\\\\\": \\\\\\"B******\\\\\\",\\\\n \\\\\\"vin\\\\\\": \\\\\\"A********\\\\\\",\\\\n \\\\\\"state\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"modelNo\\\\\\": \\\\\\"B********\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"小型轿车\\\\\\",\\\\n \\\\\\"brand\\\\\\": \\\\\\"宝马\\\\\\",\\\\n \\\\\\"usePropertyDesc\\\\\\": \\\\\\"非营运\\\\\\",\\\\n \\\\\\"stateDesc\\\\\\": \\\\\\"正常\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', + 'title' => '车五项信息识别', + 'description' => '通过车牌号、车辆类型，查询车辆基本信息', + 'requestParamsDescription' => 'ParamType，VehicleNum为必填参数', + ], + 'VehicleQuery' => [ + 'summary' => '车辆信息识别', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '232984', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- **normal**：不加密。'."\n" + .'- **md5**：md5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号'."\n" + ."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入车牌号除最后两位的其他部分明文+车牌最后两位字母MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83*******', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '请求结果', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + ."\n" + .'> '."\n" + .'> - 1：查得（计费）'."\n" + .'> - 3：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => '车辆信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "approvedCount": 7,'."\n" + .' "approvedLoad": 0,'."\n" + .' "axleCount": 2,'."\n" + .' "backWheelDistance": 1585,'."\n" + .' "brand": "雷克萨斯",'."\n" + .' "compulsoryScrapTo": "****-**-** **:**:**",'."\n" + .' "displacement": 4608,'."\n" + .' "engineNo": "1UR0******",'."\n" + .' "engineType": "1**",'."\n" + .' "frontWheelDistance": 1585,'."\n" + .' "fuelType": "汽油",'."\n" + .' "high": 1860,'."\n" + .' "inspectionResultEffectiveTo": "****-**-** **:**:**",'."\n" + .' "modelNo": "UR*****-******",'."\n" + .' "power": 228,'."\n" + .' "registrationDate": "****-**-** **:**:**",'."\n" + .' "releaseDate": "",'."\n" + .' "state": "0",'."\n" + .' "stateDesc": "正常",'."\n" + .' "totalMass": 2940,'."\n" + .' "unladenMass": 2350,'."\n" + .' "useProperty": 0,'."\n" + .' "usePropertyDesc": "非营运",'."\n" + .' "long": 4890,'."\n" + .' "vin": "A***********",'."\n" + .' "wheelBase": 2790,'."\n" + .' "wide": 1910'."\n" + .'}'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83*******\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n\\\\t\\\\\\"approvedCount\\\\\\": 7,\\\\n\\\\t\\\\\\"approvedLoad\\\\\\": 0,\\\\n\\\\t\\\\\\"axleCount\\\\\\": 2,\\\\n\\\\t\\\\\\"backWheelDistance\\\\\\": 1585,\\\\n\\\\t\\\\\\"brand\\\\\\": \\\\\\"雷克萨斯\\\\\\",\\\\n\\\\t\\\\\\"compulsoryScrapTo\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"displacement\\\\\\": 4608,\\\\n\\\\t\\\\\\"engineNo\\\\\\": \\\\\\"1UR0******\\\\\\",\\\\n\\\\t\\\\\\"engineType\\\\\\": \\\\\\"1**\\\\\\",\\\\n\\\\t\\\\\\"frontWheelDistance\\\\\\": 1585,\\\\n\\\\t\\\\\\"fuelType\\\\\\": \\\\\\"汽油\\\\\\",\\\\n\\\\t\\\\\\"high\\\\\\": 1860,\\\\n\\\\t\\\\\\"inspectionResultEffectiveTo\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"modelNo\\\\\\": \\\\\\"UR*****-******\\\\\\",\\\\n\\\\t\\\\\\"power\\\\\\": 228,\\\\n\\\\t\\\\\\"registrationDate\\\\\\": \\\\\\"****-**-** **:**:**\\\\\\",\\\\n\\\\t\\\\\\"releaseDate\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"state\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"stateDesc\\\\\\": \\\\\\"正常\\\\\\",\\\\n\\\\t\\\\\\"totalMass\\\\\\": 2940,\\\\n\\\\t\\\\\\"unladenMass\\\\\\": 2350,\\\\n\\\\t\\\\\\"useProperty\\\\\\": 0,\\\\n\\\\t\\\\\\"usePropertyDesc\\\\\\": \\\\\\"非营运\\\\\\",\\\\n\\\\t\\\\\\"long\\\\\\": 4890,\\\\n\\\\t\\\\\\"vin\\\\\\": \\\\\\"A***********\\\\\\",\\\\n\\\\t\\\\\\"wheelBase\\\\\\": 2790,\\\\n\\\\t\\\\\\"wide\\\\\\": 1910\\\\n}\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '车辆信息识别', + 'description' => '通过车牌号、车辆类型，查询车辆详细信息', + 'requestParamsDescription' => 'ParamType、VehicleNum为必填字段', + ], + 'VehicleInsureQuery' => [ + 'summary' => '车辆投保日期查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232986', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthA9Y5H0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => '参数类型：'."\n" + ."\n" + .'- **normal**：不加密。'."\n" + .'- **md5**：md5加密。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'normal' => '不加密', + 'md5' => 'md5加密', + ], + 'example' => 'normal', + ], + ], + [ + 'name' => 'VehicleType', + 'in' => 'query', + 'schema' => [ + 'description' => '驾驶证准驾车型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 52 => '新能源小客车', + '02' => '普通小客车', + ], + 'example' => '02', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号'."\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入车牌号除最后两位的其他部分明文+车牌最后两位字母MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + [ + 'name' => 'Vin', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆识别代码，即车辆VIN码'."\n" + ."\n\n" + .'> '."\n" + .'> - 当paramType取值normal时，输入明文。'."\n" + .'> - 当paramType取值md5时，输入VIN码除后4位的其他部分明文+VIN码后4位MD5加密（32位小写MD5）', + 'type' => 'string', + 'required' => false, + 'example' => 'LB**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F52********', + ], + 'Message' => [ + 'description' => '请求信息的响应消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '核验结果码：'."\n" + ."\n" + .'> '."\n" + .'> - 1：查得（计费）'."\n" + .'> - 3：查⽆记录（不计费）', + 'type' => 'string', + 'example' => '1', + ], + 'VehicleInfo' => [ + 'description' => '投保日期信息', + 'type' => 'string', + 'example' => '{'."\n" + .' "firstInsuranceDate": "****-**-**",'."\n" + .' "lastInsuranceDate": "****-**",'."\n" + .' "latestInsuranceDate": "****-**",'."\n" + .' "latestInsuranceDateStart": "****-**"'."\n" + .' }', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F52********\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"VehicleInfo\\": \\"{\\\\n \\\\\\"firstInsuranceDate\\\\\\": \\\\\\"****-**-**\\\\\\",\\\\n \\\\\\"lastInsuranceDate\\\\\\": \\\\\\"****-**\\\\\\",\\\\n \\\\\\"latestInsuranceDate\\\\\\": \\\\\\"****-**\\\\\\",\\\\n \\\\\\"latestInsuranceDateStart\\\\\\": \\\\\\"****-**\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', + 'title' => '车辆投保日期查询', + 'description' => '通过车牌号、车辆类型、车辆识别码（vin），查询车辆投保日期', + 'requestParamsDescription' => 'ParamType、Vin为必填字段', + 'responseParamsDescription' => '无', + ], + 'VerifyMaterial' => [ + 'summary' => '传入姓名、身份证号、人像照、身份证正反面照片（可选）进行实人认证，并同步返回结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59176', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHOSIED', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdCardBackImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证国徽面图片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + ], + [ + 'name' => 'FaceImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '人像正面照图片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用实人认证服务的业务场景标识。请先参见[业务设置](~~127885~~)在控制台完成创建。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPMinTest', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '标识一次认证任务的唯一ID，不超过64字符。针对一次认证任务，系统支持无限次发起提交，直到最终认证通过，该任务完结。'."\n" + ."\n" + .'> 发起不同的认证任务时需要更换不同的BizId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125b****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdCardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '02343218901123****', + ], + ], + [ + 'name' => 'IdCardFrontImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证人像面图片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端用户的ID，例如终端用户的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '54sdj', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorityComparisionScore' => [ + 'description' => '认证过程中所提交的人脸照片和权威数据的比对分，取值范围：**0**~**100**。'."\n" + ."\n" + .'置信度阈值请参考：'."\n" + .'- 误识率0.001%时，对应阈值95。'."\n" + .'- 误识率0.01%时，对应阈值90。'."\n" + .'- 误识率为0.1%时，对应阈值80。'."\n" + .'- 误识率为1%时，对应阈值为60。'."\n" + ."\n" + .'> 该字段只表示人脸与权威数据的比对结果，是个参考分，通常不建议业务上仅以该分数作为是否通过的标准。认证的综合结果请参考**VerifyStatus**字段。**VerifyStatus**的结果综合了人脸与权威数据的比对和其他多种策略，可以提高安全水位。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'VerifyStatus' => [ + 'description' => '认证状态。取值：'."\n" + ."\n" + .'- **1**：认证通过。'."\n" + .'- **2**~**n**：由于不同原因导致认证不通过。详细描述请参见下文的**认证状态说明**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'VerifyToken' => [ + 'description' => '该次认证的Token，用来串联认证请求中的各个接口，在30分钟内有效。', + 'type' => 'string', + 'example' => 'c302c0797679457685410ee51a5ba375', + ], + 'IdCardFaceComparisonScore' => [ + 'description' => '认证过程中所提交的人脸照片和身份证人像面图片上人脸的比对分，取值范围：**0**~**100**。'."\n" + ."\n" + .'置信度阈值请参考：'."\n" + .'- 误识率0.001%时，对应阈值95。'."\n" + .'- 误识率0.01%时，对应阈值90。'."\n" + .'- 误识率为0.1%时，对应阈值80。'."\n" + .'- 误识率为1%时，对应阈值为60。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Material' => [ + 'description' => '认证材料。', + 'type' => 'object', + 'properties' => [ + 'IdCardNumber' => [ + 'description' => '身份证号，对应于请求参数**IdCardNumber**。', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'FaceGlobalUrl' => [ + 'description' => '实人认证SDK采集到的摄像头全局图。'."\n" + ."\n" + .'> 该参数需要配置后才会生效。如果您需要使用该参数，请提交[工单](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today)联系我们。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg ', + ], + 'FaceImageUrl' => [ + 'description' => '人像正面照图片的HTTP或HTTPS链接，对应于请求参数**FaceImageUrl**。链接地址5分钟内有效，建议业务上进行转存以免影响使用。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + 'FaceMask' => [ + 'description' => '人脸是否佩戴口罩。取值：'."\n" + .'- **true**：佩戴了口罩'."\n" + .'- **false**：未佩戴口罩', + 'type' => 'string', + 'example' => 'false', + ], + 'IdCardName' => [ + 'description' => '姓名，对应于请求参数**Name**。', + 'type' => 'string', + 'example' => '张三', + ], + 'FaceQuality' => [ + 'description' => '人脸正面照图片的质量。取值：'."\n" + .'- **UNQUALIFIED**：照片质量较差'."\n" + .'- **LOW**：低'."\n" + .'- **NORMAL**：一般'."\n" + .'- **HIGH**：高', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'IdCardInfo' => [ + 'description' => '身份证信息的OCR结果。'."\n" + ."\n" + .'> 认证过程中如果没有身份证正面和身份证反面，则不会返回身份证信息的OCR结果。认证过程中如果有身份证正面和身份证反面，也不保证一定会返回身份证上所有的信息，因身份证拍摄问题等引起的OCR无法识别时，OCR信息就会不全，建议接入方业务上不强依赖身份证OCR信息。', + 'type' => 'object', + 'properties' => [ + 'EndDate' => [ + 'description' => '证件有效期结束时间。格式为：yyyymmdd。', + 'type' => 'string', + 'example' => '20201101', + ], + 'Authority' => [ + 'description' => '签发机构。', + 'type' => 'string', + 'example' => '杭州市公安局', + ], + 'Address' => [ + 'description' => '地址。', + 'type' => 'string', + 'example' => '浙江省杭州市余杭区文一西路969号', + ], + 'Number' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'StartDate' => [ + 'description' => '证件有效期开始时间。格式为：yyyymmdd。', + 'type' => 'string', + 'example' => '20201101', + ], + 'BackImageUrl' => [ + 'description' => '身份证国徽面图片的HTTP或HTTPS链接。链接地址5分钟内有效，建议业务上进行转存以免影响使用。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + 'Nationality' => [ + 'description' => '民族。', + 'type' => 'string', + 'example' => '汉', + ], + 'Birth' => [ + 'description' => '出生日期。', + 'type' => 'string', + 'example' => '19900101', + ], + 'Name' => [ + 'description' => '姓名。', + 'type' => 'string', + 'example' => '张三', + ], + 'FrontImageUrl' => [ + 'description' => '身份证人像面图片的HTTP或HTTPS链接。链接地址5分钟内有效，建议业务上进行转存以免影响使用。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.MaterialsNotValid', + 'errorMessage' => 'The param materials is not valid.', + ], + ], + [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorityComparisionScore\\": 97,\\n \\"VerifyStatus\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VerifyToken\\": \\"c302c0797679457685410ee51a5ba375\\",\\n \\"IdCardFaceComparisonScore\\": 97,\\n \\"Material\\": {\\n \\"IdCardNumber\\": \\"02343218901123****\\",\\n \\"FaceGlobalUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg \\",\\n \\"FaceImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg\\",\\n \\"FaceMask\\": \\"false\\",\\n \\"IdCardName\\": \\"张三\\",\\n \\"FaceQuality\\": \\"NORMAL\\",\\n \\"IdCardInfo\\": {\\n \\"EndDate\\": \\"20201101\\",\\n \\"Authority\\": \\"杭州市公安局\\",\\n \\"Address\\": \\"浙江省杭州市余杭区文一西路969号\\",\\n \\"Number\\": \\"02343218901123****\\",\\n \\"StartDate\\": \\"20201101\\",\\n \\"BackImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg\\",\\n \\"Nationality\\": \\"汉\\",\\n \\"Birth\\": \\"19900101\\",\\n \\"Name\\": \\"张三\\",\\n \\"FrontImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n\\t<VerifyMaterialResponse>\\r\\n\\t\\t<VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>\\r\\n\\t\\t<VerifyStatus>1</VerifyStatus>\\r\\n\\t\\t<Material>\\r\\n\\t\\t\\t<FaceImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg</FaceImageUrl>\\r\\n\\t\\t\\t<FaceMask>false</FaceMask>\\r\\n\\t\\t\\t<FaceQuality>NORMAL</FaceQuality>\\r\\n\\t\\t\\t<IdCardName>张三</IdCardName>\\r\\n\\t\\t\\t<IdCardNumber>02343218901123****</IdCardNumber>\\r\\n\\t\\t\\t<IdCardInfo>\\r\\n\\t\\t\\t\\t<FrontImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg</FrontImageUrl>\\r\\n\\t\\t\\t\\t<BackImageUrl>http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg</BackImageUrl>\\r\\n\\t\\t\\t\\t<Name>张三</Name>\\r\\n\\t\\t\\t\\t<Number>02343218901123****</Number>\\r\\n\\t\\t\\t\\t<Birth>19900101</Birth>\\r\\n\\t\\t\\t\\t<Address>浙江省杭州市余杭区文一西路969号</Address>\\r\\n\\t\\t\\t\\t<StartDate>20101101</StartDate>\\r\\n\\t\\t\\t\\t<EndDate>20201101</EndDate>\\r\\n\\t\\t\\t\\t<Authority>杭州市公安局</Authority>\\r\\n\\t\\t\\t</IdCardInfo>\\r\\n\\t\\t</Material>\\r\\n\\t\\t<AuthorityComparisonScore>97</AuthorityComparisonScore>\\r\\n\\t</VerifyMaterialResponse>","errorExample":""}]', + 'title' => '实人认证方案纯服务端API', + 'description' => '接入准备：接入该API时，请确保已经完成相应的准备工作，具体请参见[服务端接入准备](~~127471~~)。'."\n" + ."\n" + .'请求方法：HTTPS POST和GET。'."\n" + ."\n" + .'接口描述：接入方服务端提交认证材料到实人认证服务进行核实比对，结果同步返回。'."\n" + ."\n" + .'适用范围：该接口仅适用于纯服务端接入的认证方案。'."\n" + ."\n" + .'上传图片地址说明：'."\n" + ."\n" + .'- HTTP或HTTPS地址：支持公网可访问的HTTP或HTTPS地址。例如，`http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`。'."\n" + .'- OSS地址：接入方的图片如果是本地文件，阿里云也提供相应的上传SDK，支持业务方将图片上传到实人认证服务指定的OSS bucket中，并获取相应的OSS地址后，作为接口的图片地址入参。如果您的业务需要使用上传SDK，请提交[工单](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today)联系我们获取。'."\n" + ."\n" + .'图片限制说明：'."\n" + ."\n" + .'- 不支持本地图片的相对路径或绝对路径。'."\n" + .'- 单张图片大小请控制在2 M内，避免算法拉取超时。'."\n" + .'- 图片中人脸区域的大小至少64*64像素。'."\n" + .'- 单个请求的Body有8 M的大小限制，请计算好请求中所有图片和其他信息的大小，不要超限。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**认证状态说明**'."\n" + ."\n" + .'|VerifyStatus|原因说明 |'."\n" + .'|--------------|--------------------------------------------------------------------------------------------------------------------------------------|'."\n" + .'| 1 | 认证通过。 |'."\n" + .'| 2 | 认证不通过，原因：实名校验不通过。 |'."\n" + .'| 3 | 认证不通过，可能原因：身份证照片模糊、光线问题造成字体无法识别、身份证照片信息与需认证的身份证姓名不一致、提交的照片为非身份证照片。 |'."\n" + .'| 4 | 认证不通过，可能原因：身份证照片模糊、光线问题造成字体无法识别、身份证照片信息与需认证的身份证号码不一致、提交的照片为非身份证照片。 |'."\n" + .'| 5 | 认证不通过，可能原因：身份证照片上的有效期已过期（或即将过期）。 |'."\n" + .'| 6 | 认证不通过，可能原因：人脸与身份证头像不一致。 |'."\n" + .'| 7 | 认证不通过，可能原因：人脸与公安网照片不一致。 |'."\n" + .'| 8 | 认证不通过，可能原因：提交的身份证照片非身份证原照片、未提交有效身份证照片。 |'."\n" + .'| 9 | 认证不通过，可能原因：非账户本人操作。 |'."\n" + .'| 11| 认证不通过，可能原因：公安网照片缺失、公安网照片格式错误、公安网照片未找到人脸。 |'."\n" + .'| 12 | 认证不通过，可能原因：公安网系统异常，无法进行照片比对等可能。 |', + 'extraInfo' => ' ', + ], + 'DescribeVerifyToken' => [ + 'summary' => '发起认证请求，获取认证Token。该接口适用于使用SDK+服务端接入的认证方案。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59156', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdCardBackImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证国徽面图片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用实人认证服务的业务场景标识。请先参见[业务设置](~~127885~~)在控制台完成创建。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPBasicTest', + ], + ], + [ + 'name' => 'FailedRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '验证失败跳转链接。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'FaceRetainedImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '人像留底照片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'CallbackSeed', + 'in' => 'query', + 'schema' => [ + 'description' => '回调种子。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'IdCardFrontImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证人像面图片的HTTP或HTTPS链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '终端用户的ID，如终端用户的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'user111', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证ID。标识一次认证任务的唯一ID，不超过64字符。针对一次认证任务，系统支持无限次发起提交，直到最终认证通过，该任务完结。'."\n" + ."\n" + .'> 发起不同的认证任务时需要更换不同的BizId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125be683', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'IdCardNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'required' => false, + 'example' => '330100xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'PassedRedirectUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '验证通过跳转链接。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调Url。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'UserIp', + 'in' => 'query', + 'schema' => [ + 'description' => '用户IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.***.***', + ], + ], + [ + 'name' => 'UserPhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '用户电话号码。', + 'type' => 'string', + 'required' => false, + 'example' => '187********', + ], + ], + [ + 'name' => 'UserRegistTime', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的注册时间。使用时间戳格式表达，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1577808000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'VerifyPageUrl' => [ + 'description' => '原H5认证方案入口链接，目前该方案已经下线，不支持新增接入。如果您有H5认证方案接入需求，建议您使用金融级实人认证的[PC或移动端H5网页接入方案](~~173779~~)。', + 'type' => 'string', + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'VerifyToken' => [ + 'description' => '该次认证的Token，用来串联认证请求中的各个接口，在30分钟内有效。', + 'type' => 'string', + 'example' => 'c302c0797679457685410ee51a5ba375', + ], + 'OssUploadToken' => [ + 'description' => 'OSS上传Token信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '文件上传所需的Key。', + 'type' => 'string', + 'example' => 'STS.NU8rUBj****', + ], + 'Token' => [ + 'description' => '文件上传所需的Token。', + 'type' => 'string', + 'example' => 'uWia500nTS5knZaDzq4/KqpvhcLnO****', + ], + 'Secret' => [ + 'description' => '文件上传所需的Secret。', + 'type' => 'string', + 'example' => 'FwmnyoqT8dHj7nJLuM67T****', + ], + 'Expired' => [ + 'description' => '过期时间。使用时间戳格式表达，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582636610000', + ], + 'Path' => [ + 'description' => '文件存放路径。', + 'type' => 'string', + 'example' => 'prod/RdNLC@Ox2n-1s7NMt', + ], + 'EndPoint' => [ + 'description' => '接入端点。', + 'type' => 'string', + 'example' => 'https://oss-cn-zhangjiakou.aliyuncs.com', + ], + 'Bucket' => [ + 'description' => 'OSS文件存储的空间。', + 'type' => 'string', + 'example' => 'cloudauth-zhangjiakou-external', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.ImageValuePatternError', + 'errorMessage' => 'The pattern of value of given image is not acceptable.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"VerifyPageUrl\\": \\"http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VerifyToken\\": \\"c302c0797679457685410ee51a5ba375\\",\\n \\"OssUploadToken\\": {\\n \\"Key\\": \\"STS.NU8rUBj****\\",\\n \\"Token\\": \\"uWia500nTS5knZaDzq4/KqpvhcLnO****\\",\\n \\"Secret\\": \\"FwmnyoqT8dHj7nJLuM67T****\\",\\n \\"Expired\\": 1582636610000,\\n \\"Path\\": \\"prod/RdNLC@Ox2n-1s7NMt\\",\\n \\"EndPoint\\": \\"https://oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"Bucket\\": \\"cloudauth-zhangjiakou-external\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeVerifyTokenResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>\\r\\n</DescribeVerifyTokenResponse>","errorExample":""}]', + 'title' => '获取认证Token', + 'description' => '接入准备：接入该API时，请确保已经完成相应的准备工作，具体请参见[实人认证方案接入流程概述](~~127536~~)、[活体人脸验证方案（活体检测方案）接入流程概述](~~127687~~)。'."\n" + ."\n" + .'请求方法：HTTPS POST和GET'."\n" + ."\n" + .'接口说明：每次开始认证前通过本接口获取认证Token（VerifyToken），用来串联认证请求中的各个接口。'."\n" + ."\n" + .'适用范围：该接口适用于无线SDK接入。'."\n" + ."\n" + .'图片地址：需使用HTTP或HTTPS地址，公网可访问的HTTP或HTTPS地址。例如，`http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`。'."\n" + ."\n" + .'图片限制：'."\n" + ."\n" + .'- 不支持本地图片的相对路径或绝对路径。'."\n" + .'- 单张图片大小请控制在2 MB内，避免算法拉取超时。'."\n" + .'- 图片中人脸区域的大小至少64*64像素（px）。'."\n" + .'- 单个请求的Body有8 MB的大小限制，请计算好请求中所有图片和其他信息的大小，不要超限。', + 'requestParamsDescription' => ' 根据选择的认证方案不同，所需传入的字段不太一样，具体可以参考下述表格中的说明。'."\n" + ."\n" + .'| 认证方案 | Name字段 | IdCardNumber字段 | IdCardFrontImageUrl字段 | IdCardBackImageUrl字段 | FaceRetainedImageUrl字段 |'."\n" + .'|-----------|----------|------------------|-------------------------|------------------------|--------------------------|'."\n" + .'| RPBasic | 否 | 否 | 否 | 否 | 否 |'."\n" + .'| RPManual | 否 | 否 | 否 | 否 | 否 |'."\n" + .'| RPBioID | 是 | 是 | 否 | 否 | 否 |'."\n" + .'| RPBioOnly | 是 | 是 | 可选传入 | 可选传入 | 否 |'."\n" + .'| FVBioOnly | 否 | 否 | 否 | 否 | 是 |'."\n" + .'| FDBioOnly| 否 | 否 | 否 | 否 | 否 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVerifyResult' => [ + 'summary' => '查询实人认证结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59150', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证ID。标识一次认证任务的唯一ID，不超过64个字符。针对一次认证任务，系统支持无限次发起提交，直到最终认证通过，该任务完结。'."\n" + .'> 您发起不同的认证任务时需要更换不同的BizId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '39ecf51e-2f81-4dc5-90ee-ff86125b****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证服务的业务场景标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FVBioOnlyTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorityComparisionScore' => [ + 'description' => '认证过程中所提交的人脸照片和权威数据的比对分，取值范围：**0**~**100**。'."\n" + ."\n" + .'置信度阈值参考：'."\n" + ."\n" + .'- 误识率为0.001%时，对应阈值为95。'."\n" + .'- 误识率为0.01%时，对应阈值为90。'."\n" + .'- 误识率为0.1%时，对应阈值为80。'."\n" + .'- 误识率为1%时，对应阈值为60。'."\n" + ."\n" + .'> 该字段只表示人脸与权威数据的比对结果，仅供您参考，通常不建议业务上仅以该值作为认证是否通过的标准。认证的综合结果请参考**VerifyStatus**字段。**VerifyStatus**的结果综合了人脸与权威数据的比对和其他多种策略，可以提高安全水平。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'VerifyStatus' => [ + 'description' => '认证状态，取值：'."\n" + ."\n" + .'- **-1**：未认证'."\n" + .'- **1**：认证通过'."\n" + .'- **2**~**n**：各种不同原因导致的认证不通过。详细描述参见认证状态说明。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'FaceComparisonScore' => [ + 'description' => '认证过程中所提交的人脸照片和人脸留底图片上人脸的比对分，取值范围：**0**~**100**。'."\n" + ."\n\n" + .'置信度阈值参考：'."\n" + ."\n" + .'- 误识率为0.001%时，对应阈值为95。'."\n" + .'- 误识率为0.01%时，对应阈值为90。'."\n" + .'- 误识率为0.1%时，对应阈值为80。'."\n" + .'- 误识率为1%时，对应阈值为60。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'IdCardFaceComparisonScore' => [ + 'description' => '认证过程中所提交的人脸照片和身份证人脸面图片上人脸的比对分，取值范围：**0**~**100**。'."\n" + ."\n\n" + .'置信度阈值参考：'."\n" + ."\n" + .'- 误识率为0.001%时，对应阈值为95。'."\n" + .'- 误识率为0.01%时，对应阈值为90。'."\n" + .'- 误识率为0.1%时，对应阈值为80。'."\n" + .'- 误识率为1%时，对应阈值为60。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Material' => [ + 'description' => '认证材料。', + 'type' => 'object', + 'properties' => [ + 'IdCardNumber' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'FaceGlobalUrl' => [ + 'description' => '实人认证SDK采集到的摄像头全局图。'."\n" + ."\n" + .'> 该参数需要配置后才会生效。如果您需要使用该参数，请提交[工单](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today)联系我们。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg ', + ], + 'FaceImageUrl' => [ + 'description' => '人脸正面照图片的HTTP或HTTPS链接。链接地址5分钟内有效，建议您进行转存以免影响使用。'."\n" + .'> 如果人脸正面照图片的HTTP或HTTPS链接过期，可重新调用[DescribeVerifyResult](~~154606~~)获取链接。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg', + ], + 'FaceMask' => [ + 'description' => '人脸是否佩戴口罩。取值：'."\n" + .'- **true**：佩戴了口罩'."\n" + .'- **false**：未佩戴口罩', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IdCardName' => [ + 'description' => '姓名。', + 'type' => 'string', + 'example' => '张三', + ], + 'FaceQuality' => [ + 'description' => '人脸正面照图片的质量。取值：'."\n" + .'- **UNQUALIFIED**：照片质量较差'."\n" + .'- **LOW**：低'."\n" + .'- **NORMAL**：一般'."\n" + .'- **HIGH**：高', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'VideoUrls' => [ + 'description' => '历史RPH5BioOnly方案返回的录制视频的URL地址。', + 'type' => 'array', + 'items' => [ + 'description' => '历史RPH5BioOnly方案返回的录制视频的URL地址。', + 'type' => 'string', + 'example' => '-', + ], + ], + 'IdCardInfo' => [ + 'description' => '身份证信息的OCR结果。'."\n" + .'> 认证过程中如果没有身份证正面和反面信息，实人认证服务则不会返回身份证的OCR结果。认证过程中如果有身份证正面和反面信息，实人认证服务也不一定保证会返回身份证上所有的信息，因身份证拍摄问题引起的OCR无法识别时，OCR信息就会不全，建议您的接入方业务上不强依赖身份证OCR信息。', + 'type' => 'object', + 'properties' => [ + 'EndDate' => [ + 'description' => '证件有效期结束时间。格式为：yyyymmdd。', + 'type' => 'string', + 'example' => '20201101', + ], + 'Authority' => [ + 'description' => '签发机构。', + 'type' => 'string', + 'example' => '杭州市公安局', + ], + 'Address' => [ + 'description' => '地址。', + 'type' => 'string', + 'example' => '浙江省杭州市余杭区文一西路969号', + ], + 'Number' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'example' => '02343218901123****', + ], + 'StartDate' => [ + 'description' => '证件有效期开始时间。格式为：yyyymmdd。', + 'type' => 'string', + 'example' => '20201101', + ], + 'BackImageUrl' => [ + 'description' => '身份证国徽面图片的HTTP/HTTPS链接。链接地址5分钟内有效，建议业务上进行转存以免影响使用。'."\n" + .'> 如果人像正面照图片的HTTP/HTTPS链接过期，可重新调用DescribeVerifyResult获取链接。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg', + ], + 'Nationality' => [ + 'description' => '民族。', + 'type' => 'string', + 'example' => '汉', + ], + 'Birth' => [ + 'description' => '出生日期。', + 'type' => 'string', + 'example' => '19900101', + ], + 'Name' => [ + 'description' => '姓名。', + 'type' => 'string', + 'example' => '张三', + ], + 'FrontImageUrl' => [ + 'description' => '身份证人像面图片的HTTP/HTTPS链接。链接地址5分钟内有效，建议业务上进行转存以免影响使用。'."\n" + .'> 如果人像正面照图片的HTTP/HTTPS链接过期，可重新调用DescribeVerifyResult获取链接。', + 'type' => 'string', + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 410 => [ + [ + 'errorCode' => 'DataExpired', + 'errorMessage' => 'The data has expired and the records have been deleted.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthorityComparisionScore\\": 97,\\n \\"VerifyStatus\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"FaceComparisonScore\\": 97,\\n \\"IdCardFaceComparisonScore\\": 97,\\n \\"Material\\": {\\n \\"IdCardNumber\\": \\"02343218901123****\\",\\n \\"FaceGlobalUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg \\",\\n \\"FaceImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg\\",\\n \\"FaceMask\\": false,\\n \\"IdCardName\\": \\"张三\\",\\n \\"FaceQuality\\": \\"NORMAL\\",\\n \\"VideoUrls\\": [\\n \\"-\\"\\n ],\\n \\"IdCardInfo\\": {\\n \\"EndDate\\": \\"20201101\\",\\n \\"Authority\\": \\"杭州市公安局\\",\\n \\"Address\\": \\"浙江省杭州市余杭区文一西路969号\\",\\n \\"Number\\": \\"02343218901123****\\",\\n \\"StartDate\\": \\"20201101\\",\\n \\"BackImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg\\",\\n \\"Nationality\\": \\"汉\\",\\n \\"Birth\\": \\"19900101\\",\\n \\"Name\\": \\"张三\\",\\n \\"FrontImageUrl\\": \\"http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询认证结果', + 'description' => '接入准备：接入该API时，请确保已经完成相应的准备工作，具体请参见[实人认证服务端接入准备](~~127471~~)、[活体人脸验证服务端接入准备](~~127717~~)。'."\n" + ."\n" + .'> 阿里云实人认证仅存储最近180天的认证数据，后续业务上要使用的认证数据，请您及时调用该接口获取并自行转存，以免影响使用。'."\n" + ."\n" + .'请求方法：HTTPS POST和GET。'."\n" + ."\n" + .'接口描述：当接入方移动端收到回调之后，其服务端可以调用此接口，来获取相应的认证状态和认证资料。'."\n" + ."\n" + .'适用范围：该接口适用于SDK+服务端接入的认证方案。', + 'responseParamsDescription' => '** 认证状态说明**'."\n" + ."\n" + .'| VerifyStatus | 原因说明 | 备注 |'."\n" + .'|--------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|'."\n" + .'| -1 | 未认证 | 出现该状态一般是因为客户端上的认证请求没有提交成功。例如用户中途主动退出认证流程，或者用户的姓名、身份证号实名校验不匹配等。 |'."\n" + .'| 1 | 认证通过 | 该认证状态在实人认证方案和活体人脸验证方案均会出现。 |'."\n" + .'| 2 | 认证不通过，可能原因：实名校验不通过。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 3 | 认证不通过，可能原因：身份证照片模糊、光线问题造成字体无法识别；身份证照片信息与需认证的身份证姓名不一致；提交的照片为非身份证照片。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 4 | 认证不通过，可能原因：身份证照片模糊、光线问题造成字体无法识别；身份证照片信息与需认证的身份证号码不一致、提交的照片为非身份证照片。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 5| 认证不通过，可能原因：身份证照片有效期已过期（或即将过期）。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 6 | 认证不通过，可能原因：人脸与身份证头像不一致。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 7 | 认证不通过，可能原因：人脸与公安网照片不一致。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 8| 认证不通过，可能原因：提交的身份证照片非身份证原照片或未提交有效的身份证照片。 | 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 9 | 认证不通过，可能原因：非账户本人操作。 | 该认证状态在实人认证方案和活体人脸验证方案均会出现。 |'."\n" + .'| 10 | 认证不通过，可能原因：非同一个人操作。 | 该认证状态仅在活体人脸验证方案中出现。 |'."\n" + .'| 11 | 认证不通过，可能原因：公安网照片缺失、公安网照片格式错误、公安网照片未找到人脸。| 该认证状态仅在实人认证方案中出现。 |'."\n" + .'| 12 | 认证不通过，可能原因：公安网系统异常、无法进行照片比对。 | 该认证状态仅在实人认证方案中出现。', + ], + 'CompareFaces' => [ + 'summary' => '进行人脸比对。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '59094', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TargetImageType', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片2的类型，取值：'."\n" + ."\n" + .'- **FacePic**： 用户人脸照'."\n" + .'- **IDPic**： 用户二代身份证芯片中的头像照（通常由二代身份证阅读仪设备读取并解码获得）', + 'type' => 'string', + 'required' => false, + 'example' => 'FacePic', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceImageType', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片1的类型，取值：'."\n" + ."\n" + .'- **FacePic**： 用户人脸照'."\n" + .'- **IDPic**： 用户二代身份证芯片中的头像照（通常由二代身份证阅读仪设备读取并解码获得）', + 'type' => 'string', + 'required' => false, + 'example' => 'FacePic', + 'docRequired' => true, + ], + ], + [ + 'name' => 'SourceImageValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片1的地址。具体请参见关于上传图片地址的说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + 'docRequired' => true, + ], + ], + [ + 'name' => 'TargetImageValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '图片2的地址。具体请参见关于上传图片地址的说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误代码。', + 'type' => 'string', + 'example' => 'Error.InternalError', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '人脸比对结果。', + 'type' => 'object', + 'properties' => [ + 'SimilarityScore' => [ + 'description' => '两个图片中人脸的相似程度。取值范围为\\[0, 100]，值越大相似度越高。', + 'type' => 'number', + 'format' => 'float', + 'example' => '98.7913', + ], + 'ConfidenceThresholds' => [ + 'description' => '人脸比对置信度阈值。返回内容是JSON Object，具体结构为`"key":"value"`。'."\n" + ."\n" + .'- `key`是误识率，即将其他人误识别为指定人员的概率。'."\n" + .'- `value`是对应的阈值。'."\n" + ."\n\n" + .'> 关于示例中的人脸比对置信度阈值（confidenceThresholds）：'."\n" + .'- `"0.0001": "90.07"`表示误识率为0.01%时的对应阈值为90.07。'."\n" + .'- `"0.001": "80.01"`表示误识率为0.1%时的对应阈值为80.01。'."\n" + .'- `"0.01": "70.02"`表示误识率为1%时的对应阈值为70.02。'."\n" + ."\n" + .'置信度阈值会根据不同图像和算法动态给出，请不要将置信度阈值持久化。', + 'type' => 'string', + 'example' => '{"0.0001":"90.07","0.001":"80.01","0.01":"70.02"}', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + [ + 'errorCode' => 'InvalidParam.ParamsMissing', + 'errorMessage' => 'Please check if there is param empty in your imput', + ], + [ + 'errorCode' => 'InvalidParam.ImageTypeEmpty', + 'errorMessage' => 'The image type is empty', + ], + [ + 'errorCode' => 'InvalidParam.FacePicNotGiven', + 'errorMessage' => 'At least one of the two given images should have a type of FacePic', + ], + [ + 'errorCode' => 'InvalidParam.ImageValuePatternError', + 'errorMessage' => 'The pattern of value of given image is not acceptable', + ], + [ + 'errorCode' => 'InvalidParam.ImageTypeInvalid', + 'errorMessage' => 'The image type is not valid', + ], + [ + 'errorCode' => 'Error.NoFaceDetected', + 'errorMessage' => 'No face detected from given images', + ], + [ + 'errorCode' => 'InvalidParam.ImageNotFound', + 'errorMessage' => 'No images founded with given image address', + ], + ], + 403 => [ + [ + 'errorCode' => 'Error.NoPermissionAccess', + 'errorMessage' => 'No permission to access our service', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Error.InternalError\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SimilarityScore\\": 98.7913,\\n \\"ConfidenceThresholds\\": \\"{\\\\\\"0.0001\\\\\\":\\\\\\"90.07\\\\\\",\\\\\\"0.001\\\\\\":\\\\\\"80.01\\\\\\",\\\\\\"0.01\\\\\\":\\\\\\"70.02\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<CompareFacesResponse>\\r\\n <Data>\\r\\n <ConfidenceThresholds>{\\"0.0001\\":\\"90.07\\",\\"0.001\\":\\"80.01\\",\\"0.01\\":\\"70.02\\"}</ConfidenceThresholds>\\r\\n <SimilarityScore>98.7913</SimilarityScore>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</CompareFacesResponse>\\r\\n\\t\\t\\t\\t\\t\\t","errorExample":""}]', + 'title' => '人脸比对纯服务端API', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。'."\n" + ."\n" + .'接口描述：指定两张人脸图片进行比对，输出两张图片中人脸的相似度分值作为结果。'."\n" + ."\n" + .'- 指定的比对图片中至少应含有一个图片类型是人脸照（FacePic）。'."\n" + .'- 一张图片中含有多个人脸时，算法会自动选取图片中占幅最大的人脸。'."\n" + .'- 两张比对的图片中，如果其中一张检测不到人脸，系统会返回“未检测到人脸”的错误提示。'."\n" + ."\n" + .'在传入图片时，您需要上传图片对应的HTTP地址或base64编码。'."\n" + ."\n" + .'- HTTP地址：可访问的公网HTTP地址。例如，`http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`。'."\n" + .'- base64编码：通过base64编码的图片，格式为`base64://<图片 base64 字符串>`。'."\n" + ."\n" + .'图片限制'."\n" + ."\n" + .'- 不支持本地图片的相对路径或绝对路径。'."\n" + .'- 单张图片大小请控制在2M内，避免算法拉取超时。'."\n" + .'- 单个请求的Body有8M的大小限制，请计算好请求中所有图片和其他信息的大小，不要超限。'."\n" + .'- 使用base64传递图片时，接口的请求方法需要改成 POST；图片base64字符串需要去掉头部描述，如`data:image/png;base64`,。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DetectFaceAttributes' => [ + 'summary' => '检测人脸照片中的有效性属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59162', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaterialValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '待检测照片，格式描述见上传图片地址的说明。同一张图片最多检测其中的5张人脸。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => [ + 'description' => '使用实人认证服务的业务场景标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'RPBasicTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误代码。', + 'type' => 'string', + 'example' => 'Error.InternalError', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ImgHeight' => [ + 'description' => '原图高度，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'ImgWidth' => [ + 'description' => '原图宽度，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'FaceInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FaceAttributesDetectInfo' => [ + 'description' => '人脸检测结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceRect' => [ + 'description' => '人脸在原图中的位置。', + 'type' => 'object', + 'properties' => [ + 'Left' => [ + 'description' => '人脸矩形左上角距原图左边的距离，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '354', + ], + 'Top' => [ + 'description' => '人脸矩形左上角距原图上边的距离，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '453', + ], + 'Width' => [ + 'description' => '人脸矩形的宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '473', + ], + 'Height' => [ + 'description' => '人脸矩形的高度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '473', + ], + ], + ], + 'FaceAttributes' => [ + 'description' => '人脸属性。', + 'type' => 'object', + 'properties' => [ + 'Glasses' => [ + 'description' => '是否戴眼镜。取值：'."\n" + ."\n" + .'- **None**：未戴眼镜'."\n" + .'- **Wear**：戴普通眼镜'."\n" + .'- **Sunglass**：戴墨镜', + 'type' => 'string', + 'example' => 'None', + ], + 'Facequal' => [ + 'description' => '表示分数，取值范围：0~100。分数越高，质量越好，建议您使用大于或者等于50分认为质量合格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '60', + ], + 'Integrity' => [ + 'description' => '表示分数，取值范围：0~100。分数越高，人脸越完整，建议您使用大于等于70分为完整度合格。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + 'Facetype' => [ + 'description' => '是否人脸。取值：'."\n" + ."\n" + .'- **None**：不是人脸'."\n" + .'- **Face**：人脸'."\n" + .'- **Profile**：侧脸（左右转头超过30°）'."\n" + ."\n" + .'> 若没有检测到人脸，接口返回的faceInfos即为空；这里的None代表检测到人脸，但认为是卡通或宠物等。', + 'type' => 'string', + 'example' => 'Face', + ], + 'Respirator' => [ + 'description' => '是否戴口罩。取值：'."\n" + ."\n" + .'- Wear：表示戴口罩。'."\n" + ."\n" + .'- None：表示没有戴口罩。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'example' => 'Wear', + ], + 'Blur' => [ + 'description' => '人脸模糊度，分值越大越模糊。通常≥2.0已较模糊，建议根据实际业务数据测试调整。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1419367790222168', + ], + 'Smiling' => [ + 'description' => '是否笑脸。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '笑脸分值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '97', + ], + 'Threshold' => [ + 'description' => '笑脸阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '95', + ], + ], + ], + 'Headpose' => [ + 'description' => '人脸姿态。', + 'type' => 'object', + 'properties' => [ + 'PitchAngle' => [ + 'description' => '抬头角度，单位为度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '-1.5683923959732056', + ], + 'RollAngle' => [ + 'description' => '左右歪头角度，单位为度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '7.163370132446289', + ], + 'YawAngle' => [ + 'description' => '左右转头角度，单位为度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '-6.925303936004639', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Error.InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error', + ], + [ + 'errorCode' => 'InvalidParam.ParamsMissing', + 'errorMessage' => 'Please check if there is param empty in your imput', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesParamError', + 'errorMessage' => 'detectFaceAttributes param error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesHttpError', + 'errorMessage' => 'detectFaceAttributes fail to get image from http', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesOssError', + 'errorMessage' => 'detectFaceAttributes fail to get image from oss', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesAlgServiceError', + 'errorMessage' => 'detectFaceAttributes algService error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesAlgServieReturnError', + 'errorMessage' => 'detectFaceAttributes algService return error', + ], + [ + 'errorCode' => 'Error.DetectFaceAttributesBase64Error', + 'errorMessage' => 'detectFaceAttributes fail to get image from base64', + ], + ], + 403 => [ + [ + 'errorCode' => 'Error.NoPermissionAccess', + 'errorMessage' => 'No permission to access our service', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'RAM caller has no permission', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Error.InternalError\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ImgHeight\\": 1920,\\n \\"ImgWidth\\": 1080,\\n \\"FaceInfos\\": {\\n \\"FaceAttributesDetectInfo\\": [\\n {\\n \\"FaceRect\\": {\\n \\"Left\\": 354,\\n \\"Top\\": 453,\\n \\"Width\\": 473,\\n \\"Height\\": 473\\n },\\n \\"FaceAttributes\\": {\\n \\"Glasses\\": \\"None\\",\\n \\"Facequal\\": 60,\\n \\"Integrity\\": 70,\\n \\"Facetype\\": \\"Face\\",\\n \\"Respirator\\": \\"Wear\\",\\n \\"Blur\\": 0.1419367790222168,\\n \\"Smiling\\": {\\n \\"Value\\": 97,\\n \\"Threshold\\": 95\\n },\\n \\"Headpose\\": {\\n \\"PitchAngle\\": -1.5683923959732056,\\n \\"RollAngle\\": 7.163370132446289,\\n \\"YawAngle\\": -6.925303936004639\\n }\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DetectFaceAttributesResponse>\\n\\t<Code>200</Code>\\n\\t<Data>\\n\\t\\t<FaceInfos>\\n\\t\\t\\t<FaceAttributesDetectInfo>\\n\\t\\t\\t\\t<element>\\n\\t\\t\\t\\t\\t<FaceAttributes>\\n\\t\\t\\t\\t\\t\\t<Blur>0.14193678</Blur>\\n\\t\\t\\t\\t\\t\\t<Facetype>Face</Facetype>\\n\\t\\t\\t\\t\\t\\t<Glasses>None</Glasses>\\n\\t\\t\\t\\t\\t\\t<Headpose>\\n\\t\\t\\t\\t\\t\\t\\t<PitchAngle>-1.5683924</PitchAngle>\\n\\t\\t\\t\\t\\t\\t\\t<RollAngle>7.16337</RollAngle>\\n\\t\\t\\t\\t\\t\\t\\t<YawAngle>-6.925304</YawAngle>\\n\\t\\t\\t\\t\\t\\t</Headpose>\\n\\t\\t\\t\\t\\t\\t<Smiling></Smiling>\\n\\t\\t\\t\\t\\t</FaceAttributes>\\n\\t\\t\\t\\t\\t<FaceRect>\\n\\t\\t\\t\\t\\t\\t<Height>473</Height>\\n\\t\\t\\t\\t\\t\\t<Left>354</Left>\\n\\t\\t\\t\\t\\t\\t<Top>453</Top>\\n\\t\\t\\t\\t\\t\\t<Width>473</Width>\\n\\t\\t\\t\\t\\t</FaceRect>\\n\\t\\t\\t\\t</element>\\n\\t\\t\\t</FaceAttributesDetectInfo>\\n\\t\\t</FaceInfos>\\n\\t\\t<ImgHeight>1920</ImgHeight>\\n\\t\\t<ImgWidth>1080</ImgWidth>\\n\\t</Data>\\n\\t<Success>true</Success>\\n </DetectFaceAttributesResponse>","errorExample":""}]', + 'title' => '人脸属性纯服务端API', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。'."\n" + ."\n" + .'接口描述：对输入照片中人脸的有效性相关属性进行检测，便于业务方判定该照片是否满足自身业务留存或比对的要求。目前支持的人脸有效性相关属性有：是否人脸、是否模糊、是否戴眼镜、脸部姿态、是否笑脸等。'."\n" + ."\n" + .'上传图片地址的说明：在传入图片时，您需要上传其对应的HTTP、OSS地址或Base64编码。'."\n" + ."\n" + .'- HTTP地址：可访问的公网HTTP地址。例如，`http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`。'."\n" + .'- Base64编码：通过base64编码的图片，格式为`base64://<图片 base64 字符串>`。'."\n" + ."\n" + .'图片限制：'."\n" + ."\n" + .'- 不支持本地图片的相对路径或绝对路径。'."\n" + .'- 单张图片大小请控制在2 MB内，避免算法拉取超时。'."\n" + .'- 单个请求的Body有8 MB的大小限制，请计算好请求中所有图片和其他信息的大小，不要超限。'."\n" + .'- 使用Base64传递图片时，接口的请求方法需要改成 POST；图片Base64字符串需要去掉头部描述，如`data:image/png;base64`。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => "\n" + ."\n", + 'extraInfo' => ' ', + ], + 'DescribePageFaceVerifyData' => [ + 'summary' => '金融级实人认证调用统计分页查询接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '216157', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthLNAN1F', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '必填，开始时间，格式为yyyy-MM-dd，默认为yyyy-MM-dd 00:00:00，查询间隔最多为90天。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-10', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '必填，结束时间，格式为yyyy-MM-dd，默认为yyyy-MM-dd 00:00:00，查询间隔最多为90天。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-30', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '36**01'."\n", + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PLUS'."\n", + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数据条数，默认为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-A***B-A3DC0DE3C83E', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'string', + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页显示数量。', + 'type' => 'string', + 'example' => '10', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '5', + ], + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '2024-03-24T00:00:00.000Z', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '19', + ], + 'SuccessCount' => [ + 'description' => '调用成功数。', + 'type' => 'string', + 'example' => '1', + ], + 'SceneId' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'example' => '****实名认证', + ], + 'ProductCode' => [ + 'description' => '产品方案Code，请参考金融级实人帮助文档。', + 'type' => 'string', + 'example' => 'ID_PLUS', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-A***B-A3DC0DE3C83E\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalPage\\": \\"5\\",\\n \\"CurrentPage\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"2024-03-24T00:00:00.000Z\\",\\n \\"TotalCount\\": \\"19\\",\\n \\"SuccessCount\\": \\"1\\",\\n \\"SceneId\\": \\"20**40\\",\\n \\"SceneName\\": \\"****实名认证\\",\\n \\"ProductCode\\": \\"ID_PLUS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '金融级数据统计', + 'requestParamsDescription' => 'StartDate和EndDate为必填参数', + ], + 'CreateCloudauthstScene' => [ + 'summary' => '增强版实际认证创建认证场景', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59099', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SMART_VERIFY' => 'SMART_VERIFY', + 'SMART_CARD' => 'SMART_CARD', + 'SMART_COMPARE' => 'SMART_COMPARE', + 'SMART_FLASH' => 'SMART_FLASH', + 'SMART_DETECT' => 'SMART_DETECT', + ], + 'example' => 'SMART_COMPARE', + ], + ], + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => '认证产生的文件是否投递到客户的OSS：'."\n" + .'- **Y**：开启'."\n" + .'- **N**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => '返回结果，是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\"\\n}","type":"json"}]', + 'title' => '创建云场景', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DeleteCloudauthstScene' => [ + 'summary' => '增强版实人认证删除指定认证场景', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59107', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的场景id。', + 'type' => 'string', + 'required' => true, + 'example' => '4275001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => '返回结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\"\\n}","type":"json"}]', + 'title' => '删除云场景', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DescribeSmartStatisticsPageList' => [ + 'summary' => '增强版实人认证调用统计分页查询接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59134', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-11-01 00:00:00 +0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-11-16 23:59:59 +0800', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景ID。', + 'type' => 'string', + 'required' => true, + 'example' => '36**01', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数据条数。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode，仅取值：**cloudauthst**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloudauthst', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '96943***4E39F805', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Items' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '日期。格式为：<i>月/日</i>', + 'type' => 'string', + 'example' => '11/8', + ], + 'SceneId' => [ + 'description' => '场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'example' => '****实名认证', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => '调用成功数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassRate' => [ + 'description' => '通过率。', + 'type' => 'string', + 'example' => '25', + ], + 'ProductCode' => [ + 'description' => '产品方案Code，请参考增强版实人帮助文档。', + 'type' => 'string', + 'example' => 'SMART_VERIFY', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"96943***4E39F805\\",\\n \\"TotalCount\\": 29,\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"11/8\\",\\n \\"SceneId\\": 0,\\n \\"SceneName\\": \\"****实名认证\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"PassRate\\": \\"25\\",\\n \\"ProductCode\\": \\"SMART_VERIFY\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '增强版实人认证调用统计分页查询接口', + ], + 'CreateAntCloudAuthScene' => [ + 'summary' => '创建一个入网凭证', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59097', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'required' => true, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => '认证产生的文件是否投递到客户OSS：'."\n" + .'- **Y**：是'."\n" + .'- **N**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'BindMiniProgram', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启绑定小程序：'."\n" + .'- **Y**：开启'."\n" + .'- **N（默认）**：不开启', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MiniProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '小程序名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试APP', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定小程序平台：'."\n" + .'- **WECHAT**：微信'."\n" + .'- **ALIPAY**：支付宝'."\n" + .'- **TIKTOK**：抖音', + 'type' => 'string', + 'required' => false, + 'example' => 'WECHAT', + ], + ], + [ + 'name' => 'CheckFileName', + 'in' => 'query', + 'schema' => [ + 'description' => '上传的校验文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试.txt', + ], + ], + [ + 'name' => 'CheckFileBody', + 'in' => 'query', + 'schema' => [ + 'description' => '上传校验文件内容。', + 'type' => 'string', + 'required' => false, + 'example' => '774c4aab45981ff4a86cde9255a11xxx', + ], + ], + [ + 'name' => 'ReturnPicCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'ReturnVideoLength', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceRiskPlus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SceneId' => [ + 'description' => '实例id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000015112', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '01D3BDC6-64C0-58E2-8760-3F1B56AAE299', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SceneId\\": 1000015112,\\n \\"RequestId\\": \\"01D3BDC6-64C0-58E2-8760-3F1B56AAE299\\"\\n}","type":"json"}]', + 'title' => '创建云场景', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'UpdateAntCloudAuthScene' => [ + 'summary' => '更新金融级认证场景', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59169', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000013372', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '暂无意义，可不上传。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StoreImage', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启投递认证过程产生的认证文件到用户的OSS：'."\n" + .'- **Y**：开启'."\n" + .'- **N（默认）**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'BindMiniProgram', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启绑定小程序：'."\n" + .'- **Y**：开启'."\n" + .'- **N（默认）**：不开启'."\n" + .'><notice>如果开启绑定小程序，请确认传递绑定小程序的所有参数。></notice>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MiniProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '小程序名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试APP', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定小程序平台：'."\n" + .'- **WECHAT**：微信'."\n" + .'- **ALIPAY**：支付宝'."\n" + .'- **TIKTOK**：抖音', + 'type' => 'string', + 'required' => false, + 'example' => 'IOS', + ], + ], + [ + 'name' => 'CheckFileName', + 'in' => 'query', + 'schema' => [ + 'description' => '上传的校验文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试.txt', + ], + ], + [ + 'name' => 'CheckFileBody', + 'in' => 'query', + 'schema' => [ + 'description' => '上传校验文件内容。', + 'type' => 'string', + 'required' => false, + 'example' => '774c4aab45981ff4a86cde9255a11xxx', + ], + ], + [ + 'name' => 'ReturnPicCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'ReturnVideoLength', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceRiskPlus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'A07D5838-2BE0-5D2E-B864-D05ADAA5EDE3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07D5838-2BE0-5D2E-B864-D05ADAA5EDE3\\"\\n}","type":"json"}]', + 'title' => '更新金融级认证场景', + 'description' => '根据场景Id更新金融级认证场景的信息。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST。', + ], + 'DeleteAntCloudAuthScene' => [ + 'summary' => '删除金融级认证场景', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59106', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000011589', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '80D1ACD4-1C7D-53CB-8C54-3758FF03C762', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"80D1ACD4-1C7D-53CB-8C54-3758FF03C762\\"\\n}","type":"json"}]', + 'title' => '删除金融级认证场景', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'RemoveWhiteListSetting' => [ + 'summary' => '删除实人白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '243505', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode，仅取值：**antcloudauth**。', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '批量删除的白名单ID。', + 'type' => 'array', + 'items' => [ + 'description' => '自动响应规则ID列表，json数组。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2653', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ResultObject\\": true\\n}","type":"json"}]', + 'title' => '删除实人白名单', + ], + 'InsertWhiteListSetting' => [ + 'summary' => '新增实人白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '243504', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode，取值：**antcloudauth**。', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景，请参见添加认证场景。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ValidDay', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单有效天数， （仅支持 3，7，30）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注，长度小于32。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResultObject' => [ + 'description' => '返回的结果', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"ResultObject\\": true\\n}","type":"json"}]', + 'title' => '新增实人白名单', + ], + 'PageQueryWhiteListSetting' => [ + 'summary' => '分页查询实人白名单配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '243501', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode，取值：**antcloudauth**。', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景，请参见添加认证场景。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000xxx', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'sha75b4e19a1ddda059b920757b0e12b', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'required' => false, + 'example' => '330103xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'ValidStartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '有效期开始日期(时间戳 毫秒)', + 'type' => 'string', + 'required' => false, + 'example' => '1725120000000', + ], + ], + [ + 'name' => 'ValidEndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '有效期截止日期(时间戳 毫秒)', + 'type' => 'string', + 'required' => false, + 'example' => '1725379200000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态：'."\n" + ."\n" + .'- DELETE：已删除'."\n" + .'- VALID：未删除在有效期内 有效'."\n" + .'- INVALID：未删除不在有效期内 无效', + 'type' => 'string', + 'required' => false, + 'example' => 'VALID', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示数量 默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalItem' => [ + 'description' => '明细的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ResultObject' => [ + 'description' => '请求结果', + 'type' => 'array', + 'items' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '白名单id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-08-30 14:00:00', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2024-08-30 14:00:00', + ], + 'ServiceCode' => [ + 'description' => '实人云产品的ServiceCode', + 'type' => 'string', + 'example' => 'antcloudauth', + ], + 'CertifyId' => [ + 'description' => '实人认证唯一标识。', + 'type' => 'string', + 'example' => 'sha43d9cabd52d370d9f4cca9468f71e', + ], + 'CertNo' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'example' => '330103xxxxxxxxxxxx'."\n", + ], + 'SceneId' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000332', + ], + 'ValidStartDate' => [ + 'description' => '有效期开始日期', + 'type' => 'string', + 'example' => '2024-08-30 13:57:51', + ], + 'ValidEndDate' => [ + 'description' => '有效期截止日期', + 'type' => 'string', + 'example' => '2024-09-02 13:57:51', + ], + 'Status' => [ + 'description' => '状态：'."\n" + ."\n" + .'- DELETE：已删除'."\n" + .'- VALID：未删除在有效期内 有效'."\n" + .'- INVALID：未删除不在有效期内 无效', + 'type' => 'string', + 'example' => 'VALID', + ], + 'Remark' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"TotalItem\\": 28,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"GmtCreate\\": \\"2024-08-30 14:00:00\\",\\n \\"GmtModified\\": \\"2024-08-30 14:00:00\\",\\n \\"ServiceCode\\": \\"antcloudauth\\",\\n \\"CertifyId\\": \\"sha43d9cabd52d370d9f4cca9468f71e\\",\\n \\"CertNo\\": \\"330103xxxxxxxxxxxx\\\\n\\",\\n \\"SceneId\\": 1000000332,\\n \\"ValidStartDate\\": \\"2024-08-30 13:57:51\\",\\n \\"ValidEndDate\\": \\"2024-09-02 13:57:51\\",\\n \\"Status\\": \\"VALID\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询实人白名单配置', + ], + 'CreateAuthKey' => [ + 'summary' => '获取授权key，用于离线人脸识别SDK激活。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59098', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型。不超过64字符。可用于对具体业务进行备注，例如可以取接入方不同的人脸使用场景，或者待交付的客户标识等。建议传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户设备ID。不超过64字符。可用于标识具体设备，建议可以使用设备物理编号。建议传入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'Test', + 'in' => 'query', + 'schema' => [ + 'description' => '测试标识。为true表示使用测试授权，授权时长默认为30天；为false，则授权时长根据AuthYears进行授权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AuthYears', + 'in' => 'query', + 'schema' => [ + 'description' => '当Test标识为false或空时，AuthYears必填，单位为年，范围为\\[1,100]，取值100表示永久授权。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthKey' => [ + 'description' => '可用于授权激活的key。授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + 'type' => 'string', + 'example' => 'auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthKey\\": \\"auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<CreateAuthKeyResponse>\\r\\n <Data>\\r\\n <AuthKey>auth.1KQMcnLd4m37LN2D0F0WCD-1qtQI$</AuthKey>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>1</Code>\\r\\n</CreateAuthKeyResponse>","errorExample":""}]', + 'title' => '获取授权key', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeOssUploadToken' => [ + 'summary' => '获取照片上传OSS所需要的Token。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59122', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '2FA2C773-47DB-4156-B1EE-5B047321A939', + ], + 'OssUploadToken' => [ + 'description' => 'OSS上传Token信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '文件上传所需的Key。', + 'type' => 'string', + 'example' => 'STS.NU8rUBj****', + ], + 'Token' => [ + 'description' => '文件上传所需的Token。', + 'type' => 'string', + 'example' => 'uWia500nTS5knZaDzq4/KqpvhcLnO****', + ], + 'Secret' => [ + 'description' => '文件上传所需的Secret。', + 'type' => 'string', + 'example' => 'FwmnyoqT8dHj7nJLuM67T****', + ], + 'Expired' => [ + 'description' => '过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582636610000', + ], + 'Path' => [ + 'description' => '文件存放路径。', + 'type' => 'string', + 'example' => 'prod/RdNLC@Ox2n-1s7NMt', + ], + 'EndPoint' => [ + 'description' => '接入端点。', + 'type' => 'string', + 'example' => 'https://oss-cn-zhangjiakou.aliyuncs.com', + ], + 'Bucket' => [ + 'description' => 'OSS文件存储的空间。', + 'type' => 'string', + 'example' => 'cloudauth-zhangjiakou-external', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FA2C773-47DB-4156-B1EE-5B047321A939\\",\\n \\"OssUploadToken\\": {\\n \\"Key\\": \\"STS.NU8rUBj****\\",\\n \\"Token\\": \\"uWia500nTS5knZaDzq4/KqpvhcLnO****\\",\\n \\"Secret\\": \\"FwmnyoqT8dHj7nJLuM67T****\\",\\n \\"Expired\\": 1582636610000,\\n \\"Path\\": \\"prod/RdNLC@Ox2n-1s7NMt\\",\\n \\"EndPoint\\": \\"https://oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"Bucket\\": \\"cloudauth-zhangjiakou-external\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>\\n<DescribeOssUploadTokenResponse>\\n <OssUploadToken class=\\"object\\">\\n <Bucket type=\\"string\\">cloudauth-zhangjiakou-external</Bucket>\\n <EndPoint type=\\"string\\">https://oss-cn-zhangjiakou.aliyuncs.com</EndPoint>\\n <Expired type=\\"number\\">1582636610000</Expired>\\n <Key type=\\"string\\">STS.NU8rUBj****</Key>\\n <Path type=\\"string\\">prod/RdNLC@Ox2n-1s7NMt</Path>\\n <Secret type=\\"string\\">FwmnyoqT8dHj7nJLuM67T****</Secret>\\n <Token type=\\"string\\">uWia500nTS5knZaDzq4/KqpvhcLnO****</Token>\\n </OssUploadToken>\\n <RequestId type=\\"string\\">46FF6F40-59F9-4108-BA2C-E6BA7E816F1F</RequestId>\\n</DescribeOssUploadTokenResponse>\\n","errorExample":""}]', + 'title' => '获取照片上传OSS所需要的Token', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateVerifySetting' => [ + 'summary' => '等同于在控制台上新建认证场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59103', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'UserRegister', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'schema' => [ + 'description' => '认证场景名称。', + 'type' => 'string', + 'required' => true, + 'example' => '用户注册', + ], + ], + [ + 'name' => 'Solution', + 'in' => 'query', + 'schema' => [ + 'description' => '认证方案名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'RPBasic', + ], + ], + [ + 'name' => 'GuideStep', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用系统默认的引导页。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PrivacyStep', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用系统默认的授权页。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResultStep', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用系统默认的结果页。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BizName' => [ + 'description' => '认证场景名称。', + 'type' => 'string', + 'example' => '用户注册', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'Solution' => [ + 'description' => '认证方案名称。', + 'type' => 'string', + 'example' => 'RPBasic', + ], + 'BizType' => [ + 'description' => '认证场景标识。', + 'type' => 'string', + 'example' => 'UserRegister', + ], + 'StepList' => [ + 'description' => '认证步骤，guide代表引擎，privacy代表步骤法。', + 'type' => 'array', + 'items' => [ + 'description' => '认证步骤，guide代表引擎，privacy代表步骤法。', + 'type' => 'string', + 'example' => '["GUIDE","PRIVACY","FACE_LIVENESS","TAKE_ID_PHOTO","RESULT"]', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BizName\\": \\"用户注册\\",\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"Solution\\": \\"RPBasic\\",\\n \\"BizType\\": \\"UserRegister\\",\\n \\"StepList\\": [\\n \\"[\\\\\\"GUIDE\\\\\\",\\\\\\"PRIVACY\\\\\\",\\\\\\"FACE_LIVENESS\\\\\\",\\\\\\"TAKE_ID_PHOTO\\\\\\",\\\\\\"RESULT\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => '创建认证场景配置', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'DescribeVerifySDK' => [ + 'summary' => '获取离线SDK下载地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59152', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthK16DVB', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '生成SDK的任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1KQMcnLd4m37LN2D0F0WCD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SdkUrl' => [ + 'description' => 'SDK下载地址。不为空时，表示生成完成。', + 'type' => 'string', + 'example' => 'https://www.xxx.com', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SdkUrl\\": \\"https://www.xxx.com\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeVerifySDKResponse>\\r\\n <Data>\\r\\n <Url>https://www.xxx.com</Url>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n</DescribeVerifySDKResponse>\\r\\n\\t\\t\\t\\t\\t\\t\\t\\t","errorExample":""}]', + 'title' => '获取离线SDK下载地址', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'接口描述：根据生成离线人脸识别SDK的任务ID获取SDK生成结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDeviceInfo' => [ + 'summary' => '比如设备授权有效期延长、更新业务方自定义的业务标识和设备ID等。适用于设备有效期续期等场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59166', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证服务端为接入方设备生成的唯一ID，只有在设备成功激活后才会生成，该ID可通过离线人脸识别SDK里的getLicenseExtraInfo函数获得。', + 'type' => 'string', + 'required' => true, + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '更新的用户设备ID。不超过64字符，由接入方自定义，可用于标识具体设备，建议可以使用设备物理编号。', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '更新的业务类型。不超过64字符。由接入方自定义，可用于对具体业务进行备注，例如可以取接入方不同的人脸使用场景，或者待交付的客户标识等。', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '延长设备到期的时间。单位：年，范围为\\[1,100]，取值100表示永久使用。一年按365天计算。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ExpiredDay', + 'in' => 'query', + 'schema' => [ + 'description' => '当前设备的失效时间。失效日期不正确（和实人认证服务端记录的失效时间相差超过一周），则报错。'."\n" + .'> 该失效时间可以通过DescribeDeviceInfo接口查询获得，失效日期不正确则报错，这个校验是为了确保业务方不因为一些误操作导致重复激活一台设备，误消耗授权。', + 'type' => 'string', + 'required' => false, + 'example' => '20190401', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'UserDeviceId' => [ + 'description' => '对应于请求参数中的UserDeviceId。', + 'type' => 'string', + 'example' => '3iJ1AY$oHcu7mC69', + ], + 'DeviceId' => [ + 'description' => '对应于请求参数中的DeviceId。', + 'type' => 'string', + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + 'ExpiredDay' => [ + 'description' => '若请求参数中Duration不为空，则该字段表示延长设备有效期后，授权到期时间。Duration的1年按365天计算。示例：20180101。', + 'type' => 'string', + 'example' => '20200330', + ], + 'BeginDay' => [ + 'description' => '若请求参数中Duration不为空，则该字段表示延长设备有效期后，授权开始时间。Duration的1年按365天计算。示例：20180101。', + 'type' => 'string', + 'example' => '20190401', + ], + 'BizType' => [ + 'description' => '对应于请求参数中的BizType。', + 'type' => 'string', + 'example' => 'FACE_TEST', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"UserDeviceId\\": \\"3iJ1AY$oHcu7mC69\\",\\n \\"DeviceId\\": \\"wd.6ziUffspAeW5FVYbaqmexR-1qwNjM\\",\\n \\"ExpiredDay\\": \\"20200330\\",\\n \\"BeginDay\\": \\"20190401\\",\\n \\"BizType\\": \\"FACE_TEST\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifyDeviceInfoResponse>\\r\\n <Data>\\r\\n <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>\\r\\n <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>\\r\\n <BizType>FACE_TEST</BizType>\\r\\n <BeginDay>20190401</BeginDay>\\r\\n <ExpiredDay>20200330</ExpiredDay>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n <Code>1</Code>\\r\\n</ModifyDeviceInfoResponse>\\t\\t\\t\\t","errorExample":""}]', + 'title' => '更新设备相关信息', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDeviceInfo' => [ + 'summary' => '比如授权有效期、接入方自定义的业务标识和设备ID等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59114', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询每页数目。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前查询页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实人认证服务端为接入方设备生成的唯一ID，只有在设备成功激活后才会生成，该ID可通过离线人脸识别SDK里的getLicenseExtraInfo函数获得。', + 'type' => 'string', + 'required' => false, + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '业务类型。不超过64字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'FACE_TEST', + ], + ], + [ + 'name' => 'UserDeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '不超过64字符，由接入方自定义，可用于标识具体设备。', + 'type' => 'string', + 'required' => false, + 'example' => '3iJ1AY$oHcu7mC69', + ], + ], + [ + 'name' => 'ExpiredStartDay', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间，即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。', + 'type' => 'string', + 'required' => false, + 'example' => '20190401', + ], + ], + [ + 'name' => 'ExpiredEndDay', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间。即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。', + 'type' => 'string', + 'required' => false, + 'example' => '20200330', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前查询页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'PageSize' => [ + 'description' => '每页数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DeviceInfoList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeviceInfo' => [ + 'description' => '设备信息数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiredDay' => [ + 'description' => '授权到期时间。', + 'type' => 'string', + 'example' => '20180101', + ], + 'UserDeviceId' => [ + 'description' => '对应于请求中的UserDeviceId。', + 'type' => 'string', + 'example' => '3iJ1AY$oHcu7mC69', + ], + 'DeviceId' => [ + 'description' => '对应于请求中的DeviceId。', + 'type' => 'string', + 'example' => 'wd.6ziUffspAeW5FVYbaqmexR-1qwNjM', + ], + 'BeginDay' => [ + 'description' => '授权开始时间。', + 'type' => 'string', + 'example' => '20180101', + ], + 'BizType' => [ + 'description' => '对应于请求中的BizType。', + 'type' => 'string', + 'example' => 'FACE_TEST', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"DeviceInfoList\\": {\\n \\"DeviceInfo\\": [\\n {\\n \\"ExpiredDay\\": \\"20180101\\",\\n \\"UserDeviceId\\": \\"3iJ1AY$oHcu7mC69\\",\\n \\"DeviceId\\": \\"wd.6ziUffspAeW5FVYbaqmexR-1qwNjM\\",\\n \\"BeginDay\\": \\"20180101\\",\\n \\"BizType\\": \\"FACE_TEST\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DescribeDeviceInfoResponse>\\r\\n <Data>\\r\\n <PageSize>20</PageSize>\\r\\n <CurrentPage>1</CurrentPage>\\r\\n <TotalCount>1</TotalCount>\\r\\n <Devices>\\r\\n <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>\\r\\n <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>\\r\\n <BizType>FACE_TEST</BizType>\\r\\n <BeginDay>20190101</BeginDay>\\r\\n <ExpiredDay>20200101</ExpiredDay>\\r\\n </Devices>\\r\\n </Data>\\r\\n <Success>true</Success>\\r\\n</DescribeDeviceInfoResponse>","errorExample":""}]', + 'title' => '查询设备相关信息', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteWhitelistSetting' => [ + 'summary' => '删除指定集群的版本', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59109', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置访问者源ip地址。支持cidr格式和ipv4格式的ip地址。示例：10.0.3.0/24。', + 'type' => 'string', + 'required' => false, + 'example' => '120.25.41.25', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要删除的用户信息的语言。取值：-**zh**：中文。-**en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode，仅取值：**antcloudauth**。', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的规则ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '[6222001]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => '返回结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\"\\n}","type":"json"}]', + 'title' => '删除白名单配置', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'CreateWhitelistSetting' => [ + 'summary' => '创建认证白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59105', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者源ip地址。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '27.115.63.58', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '用户语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000014526', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书id，对该笔认证用户进行加白。', + 'type' => 'string', + 'required' => false, + 'example' => 'sha6d0405f42926084e396e76a037d00', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '加白的身份证号。', + 'type' => 'string', + 'required' => false, + 'example' => '44018219950810XXXX', + ], + ], + [ + 'name' => 'ValidDay', + 'in' => 'query', + 'schema' => [ + 'description' => '创建白名单后的有效天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '白名单备注。', + 'type' => 'string', + 'required' => false, + 'example' => '测试白名单。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => '返回结果，是否创建成功：'."\n" + .'- true：成功'."\n" + .'- false： 失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'CF4979D3-060F-5336-BD9F-0D46ECB66B22', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": true,\\n \\"RequestId\\": \\"CF4979D3-060F-5336-BD9F-0D46ECB66B22\\"\\n}","type":"json"}]', + 'title' => '创建白名单', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'DescribeWhitelistSetting' => [ + 'summary' => '查询场景白名单列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59159', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.140.85.74', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的语言。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务Code：'."\n" + .'- **增强版金融级**：cloudauthst'."\n" + .'- **金融级**：antcloudauth', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000004530', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证ID', + 'type' => 'string', + 'required' => false, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号', + 'type' => 'string', + 'required' => false, + 'example' => '320321XXXXXXXX701X', + ], + ], + [ + 'name' => 'ValidStartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '有效开始时间（秒级时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1759939200000', + ], + ], + [ + 'name' => 'ValidEndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '有效期截止时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1730304000000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单状态：'."\n" + .'- **VALID**：有效'."\n" + .'- **INVALID**: 无效'."\n" + .'- **DELETED**：被删除', + 'type' => 'string', + 'required' => false, + 'example' => 'VALID', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数：当前页码，默认值1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页参数：当前页码，默认值1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '0B8ACFD2-C5F0-5F9F-8DD4-E44F93E360E8', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Items' => [ + 'description' => '认证详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '白名单状态：'."\n" + .'- **VALID**：有效。'."\n" + .'- **INVALID**：无效。'."\n" + .'- **DELETED**：已删除。', + 'type' => 'string', + 'example' => 'VALID', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'CertifyId' => [ + 'description' => '证书id。', + 'type' => 'string', + 'example' => 'shad861465f2aaeeb805b519e1a93ab2', + ], + 'CertNo' => [ + 'description' => '证书编号。', + 'type' => 'string', + 'example' => '320321XXXXXXXX701X', + ], + 'ValidStartDate' => [ + 'description' => '生效时间。', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000332', + ], + 'GmtModified' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'ValidEndDate' => [ + 'description' => '生效日期。', + 'type' => 'string', + 'example' => '2025-10-16 17:28:03', + ], + 'Id' => [ + 'description' => '白名单id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6372003', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '测试白名单', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0B8ACFD2-C5F0-5F9F-8DD4-E44F93E360E8\\",\\n \\"TotalCount\\": 4,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"VALID\\",\\n \\"GmtCreate\\": \\"2025-10-16 17:28:03\\",\\n \\"CertifyId\\": \\"shad861465f2aaeeb805b519e1a93ab2\\",\\n \\"CertNo\\": \\"320321XXXXXXXX701X\\",\\n \\"ValidStartDate\\": \\"2025-10-16 17:28:03\\",\\n \\"SceneId\\": 1000000332,\\n \\"GmtModified\\": \\"2025-10-16 17:28:03\\",\\n \\"ValidEndDate\\": \\"2025-10-16 17:28:03\\",\\n \\"Id\\": 6372003,\\n \\"Remark\\": \\"测试白名单\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取白名单集合', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'DescribeAntAndCloudAuthUserStatus' => [ + 'summary' => '查询实人认证不同产品方案的开通情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59110', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AntcloudauthEnabled' => [ + 'description' => '是否开通金融级实人，取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CloudauthstEnabled' => [ + 'description' => '是否开通了增强版实人认证。取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '3FE07CCE-DF47-51C2-9D32-CD70ED62C91B', + ], + 'CloudauthEnabled' => [ + 'description' => '是否开通了实人认证。取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InforverifyEnabled' => [ + 'description' => '是否开通了是否开通信息核验。取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AntcloudauthEnabled\\": true,\\n \\"CloudauthstEnabled\\": true,\\n \\"RequestId\\": \\"3FE07CCE-DF47-51C2-9D32-CD70ED62C91B\\",\\n \\"CloudauthEnabled\\": false,\\n \\"InforverifyEnabled\\": false\\n}","type":"json"}]', + 'title' => '查询实人认证不同产品方案的开通情况', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DescribeCloudauthstSceneList' => [ + 'summary' => '查询增强版实人认证认证场景', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59113', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code', + 'type' => 'string', + 'required' => false, + 'example' => 'SMART_CARD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'CEC88747-2F3E-539E-91A6-84E321CAA12B', + ], + 'Items' => [ + 'description' => '场景列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => '-', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-01-04 19:56:04', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'string', + 'example' => '20**40', + ], + 'SceneName' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'example' => '测试场景', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2023-01-04 19:56:04', + ], + 'ProductCode' => [ + 'description' => '云市场商品code。', + 'type' => 'string', + 'example' => 'SMART_VERIFY', + ], + 'StoreImage' => [ + 'description' => '是否将认证产生的文件投递到客户OSS：'."\n" + .'- **Y**：开启'."\n" + .'- **N**：关闭', + 'type' => 'string', + 'example' => 'N', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEC88747-2F3E-539E-91A6-84E321CAA12B\\",\\n \\"Items\\": [\\n {\\n \\"ProductName\\": \\"-\\",\\n \\"GmtCreate\\": \\"2023-01-04 19:56:04\\",\\n \\"SceneId\\": \\"20**40\\",\\n \\"SceneName\\": \\"测试场景\\",\\n \\"GmtModified\\": \\"2023-01-04 19:56:04\\",\\n \\"ProductCode\\": \\"SMART_VERIFY\\",\\n \\"StoreImage\\": \\"N\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询增强版实人认证认证场景列表', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DescribeListAntCloudAuthScenes' => [ + 'summary' => '查询某个', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59118', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'CC1AB3F5-22A2-589F-ABDD-B766694AA671', + ], + 'Scenes' => [ + 'description' => '场景列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授权的场景列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '是否启用，为1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Modifier' => [ + 'description' => '修改者。', + 'type' => 'string', + 'example' => '189884094677xxxx', + ], + 'UpdateTime' => [ + 'description' => '实例最后更新时间。', + 'type' => 'string', + 'example' => '1260051251634779', + ], + 'AppId' => [ + 'description' => '应用id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2a3a13b6-ee85-457e-bd15-b48115cb396e', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1260051251634779', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001xxxx', + ], + 'SceneName' => [ + 'description' => '场景名称。', + 'type' => 'string', + 'example' => '测试场景', + ], + 'Creator' => [ + 'description' => '创建者。', + 'type' => 'string', + 'example' => '189884094677xxxx', + ], + 'StoreImage' => [ + 'description' => '是否将认证产生的文件投递到客户OSS：'."\n" + .'- **Y**： 开启'."\n" + .'- **N**： 关闭', + 'type' => 'string', + 'example' => 'Y', + ], + 'BindMiniProgram' => [ + 'description' => '是否开启绑定小程序：'."\n" + .'- **Y**：开启'."\n" + .'- **N（默认）**：不开启', + 'type' => 'string', + 'example' => 'Y', + ], + 'Platform' => [ + 'description' => '绑定小程序平台：'."\n" + .'- **WECHAT**：微信'."\n" + .'- **ALIPAY**：支付宝'."\n" + .'- **TIKTOK**：抖音', + 'type' => 'string', + 'example' => 'WECHAT', + ], + 'MiniProgramName' => [ + 'description' => '小程序名称。', + 'type' => 'string', + 'example' => '测试APP', + ], + 'Domain' => [ + 'description' => '绑定域名。', + 'type' => 'string', + 'example' => 'www.ddos.com', + ], + 'ReturnPicCount' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ReturnVideoLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DeviceRiskPlus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC1AB3F5-22A2-589F-ABDD-B766694AA671\\",\\n \\"Scenes\\": [\\n {\\n \\"Status\\": 1,\\n \\"Modifier\\": \\"189884094677xxxx\\",\\n \\"UpdateTime\\": \\"1260051251634779\\",\\n \\"AppId\\": 0,\\n \\"CreateTime\\": \\"1260051251634779\\",\\n \\"SceneId\\": 0,\\n \\"SceneName\\": \\"测试场景\\",\\n \\"Creator\\": \\"189884094677xxxx\\",\\n \\"StoreImage\\": \\"Y\\",\\n \\"BindMiniProgram\\": \\"Y\\",\\n \\"Platform\\": \\"WECHAT\\",\\n \\"MiniProgramName\\": \\"测试APP\\",\\n \\"Domain\\": \\"www.ddos.com\\",\\n \\"ReturnPicCount\\": 0,\\n \\"ReturnVideoLength\\": 0,\\n \\"DeviceRiskPlus\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询金融级认证场景列表', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DescribeListFaceVerifyData' => [ + 'summary' => '查询人脸认证数据列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59119', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000339', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code，暂弃用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Liveness', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'EBD373EA-07FC-50BC-906F-B8950B6ED462', + ], + 'MonitorData' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'FaceVerifyData' => [ + 'description' => '人脸认证数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCnt' => [ + 'description' => '总人认证量。', + 'type' => 'string', + 'example' => '18', + ], + 'FailCnt' => [ + 'description' => '认证不通过量。', + 'type' => 'string', + 'example' => '6', + ], + 'SuccCnt' => [ + 'description' => '认证通过数量。', + 'type' => 'string', + 'example' => '12', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'string', + 'example' => '1000011644', + ], + 'Name' => [ + 'description' => '认证方案。', + 'type' => 'string', + 'example' => 'Liveness', + ], + 'ConDate' => [ + 'description' => '认证统计时间。', + 'type' => 'string', + 'example' => '2025-10-16T00:00:00.000Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBD373EA-07FC-50BC-906F-B8950B6ED462\\",\\n \\"MonitorData\\": {\\n \\"FaceVerifyData\\": [\\n {\\n \\"TotalCnt\\": \\"18\\",\\n \\"FailCnt\\": \\"6\\",\\n \\"SuccCnt\\": \\"12\\",\\n \\"SceneId\\": \\"1000011644\\",\\n \\"Name\\": \\"Liveness\\",\\n \\"ConDate\\": \\"2025-10-16T00:00:00.000Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询人脸认证数据', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeListFaceVerifyInfos' => [ + 'summary' => '获取人脸认证记录（旧版）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59120', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => '查询认证起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '查询认证结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1760716800000', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'shs414a8b392a3a338abe0504c75c056', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。最大值：100默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数：当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '认证状态：'."\n" + .'- **1**: 认证通过。'."\n" + .'- **2**: 认证不通过。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000009699', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalPages' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ItemsPerPage' => [ + 'description' => '返回指定的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '分页参数：当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '1CC27D8E-24BF-5056-B14E-9F26719C9A8D', + ], + 'TotalCount' => [ + 'description' => '认证总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FaceVerifyInfos' => [ + 'description' => '人脸认证记录信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '认证状态：'."\n" + .'- **1**: 认证通过。'."\n" + .'- **2**: 认证不通过。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BizCode' => [ + 'description' => '业务Code。', + 'type' => 'string', + 'example' => 'CLOUD_FACE', + ], + 'CreateTime' => [ + 'description' => '人脸识别的记录创建时间。', + 'type' => 'string', + 'example' => '2022-10-02T11:16:06Z', + ], + 'CertName' => [ + 'description' => '姓名。', + 'type' => 'string', + 'example' => '赵四', + ], + 'CertNo' => [ + 'description' => '证件号码。', + 'type' => 'string', + 'example' => '500382199805086199', + ], + 'CertifyId' => [ + 'description' => '证件id。', + 'type' => 'string', + 'example' => 'sha8ff58e964152c4c4d21005fb98ecb', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000010145', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPages\\": 3,\\n \\"ItemsPerPage\\": 20,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1CC27D8E-24BF-5056-B14E-9F26719C9A8D\\",\\n \\"TotalCount\\": 0,\\n \\"FaceVerifyInfos\\": [\\n {\\n \\"Status\\": 2,\\n \\"BizCode\\": \\"CLOUD_FACE\\",\\n \\"CreateTime\\": \\"2022-10-02T11:16:06Z\\",\\n \\"CertName\\": \\"赵四\\",\\n \\"CertNo\\": \\"500382199805086199\\",\\n \\"CertifyId\\": \\"sha8ff58e964152c4c4d21005fb98ecb\\",\\n \\"SceneId\\": 1000010145\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取人脸认证信息', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeOssStatus' => [ + 'summary' => '查询OSS的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '59121', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务码：'."\n" + .'- antcloudauth：金融级实人'."\n" + .'- cloudauthst（已退市）：实人认证增强版', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'F2DB870B-EEB7-51BD-9F0A-B5D8D3C79308', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'description' => '用户开通状态，SUCCESS表示开通。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BucketName' => [ + 'description' => '认证信息投递的OSS bucket名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou-aliyun-cloudauth-20250516xxxxxx', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2DB870B-EEB7-51BD-9F0A-B5D8D3C79308\\",\\n \\"Data\\": {\\n \\"UserStatus\\": \\"SUCCESS\\",\\n \\"BucketName\\": \\"cn-hangzhou-aliyun-cloudauth-20250516xxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => '查询用户OSS状态', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'DescribePageSetting' => [ + 'summary' => '查询页面设置，主要返回认证不通过原因。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59123', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FailReasons' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => '{'."\n" + .' "11": "认证不通过，可能原因：1、公安网照片缺失；2、公安网照片格式错误；3、公安网照片找不到人脸等可能",'."\n" + .' "1": "认证通过",'."\n" + .' "12": "认证不通过，可能原因：公安网系统异常，无法比对等可能",'."\n" + .' "2": "认证不通过，原因：实名校验不通过",'."\n" + .' "3": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证姓名不一致；3、提交的照片为非身份证照片等可能",'."\n" + .' "4": "认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证号码不一致；3、提交的照片为非身份证照片等可能",'."\n" + .' "5": "认证不通过，可能原因：身份证照片有效期已过期（或即将过期）等可能",'."\n" + .' "6": "认证不通过，可能原因：人脸与身份证头像不一致等可能",'."\n" + .' "7": "认证不通过，可能原因：人脸与公安网照片不一致等可能",'."\n" + .' "8": "认证不通过，可能原因：1、提交的身份证照片非身份证原照片；2、未提交有效身份证照片等可能",'."\n" + .' "9": "认证不通过，可能原因：非账号本人操作等可能",'."\n" + .' "10": "认证不通过，可能原因：非同人操作等可能"'."\n" + .' }', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'C58A8581-6A5B-55F1-B2EF-1CEAC97DA181', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FailReasons\\": \\"{\\\\n \\\\\\"11\\\\\\": \\\\\\"认证不通过，可能原因：1、公安网照片缺失；2、公安网照片格式错误；3、公安网照片找不到人脸等可能\\\\\\",\\\\n \\\\\\"1\\\\\\": \\\\\\"认证通过\\\\\\",\\\\n \\\\\\"12\\\\\\": \\\\\\"认证不通过，可能原因：公安网系统异常，无法比对等可能\\\\\\",\\\\n \\\\\\"2\\\\\\": \\\\\\"认证不通过，原因：实名校验不通过\\\\\\",\\\\n \\\\\\"3\\\\\\": \\\\\\"认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证姓名不一致；3、提交的照片为非身份证照片等可能\\\\\\",\\\\n \\\\\\"4\\\\\\": \\\\\\"认证不通过，可能原因：1、身份证照片模糊、光线问题造成字体无法识别；2、身份证照片信息与需认证的身份证号码不一致；3、提交的照片为非身份证照片等可能\\\\\\",\\\\n \\\\\\"5\\\\\\": \\\\\\"认证不通过，可能原因：身份证照片有效期已过期（或即将过期）等可能\\\\\\",\\\\n \\\\\\"6\\\\\\": \\\\\\"认证不通过，可能原因：人脸与身份证头像不一致等可能\\\\\\",\\\\n \\\\\\"7\\\\\\": \\\\\\"认证不通过，可能原因：人脸与公安网照片不一致等可能\\\\\\",\\\\n \\\\\\"8\\\\\\": \\\\\\"认证不通过，可能原因：1、提交的身份证照片非身份证原照片；2、未提交有效身份证照片等可能\\\\\\",\\\\n \\\\\\"9\\\\\\": \\\\\\"认证不通过，可能原因：非账号本人操作等可能\\\\\\",\\\\n \\\\\\"10\\\\\\": \\\\\\"认证不通过，可能原因：非同人操作等可能\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"C58A8581-6A5B-55F1-B2EF-1CEAC97DA181\\"\\n}","type":"json"}]', + 'title' => '查询页面设置', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'DescribeProductCode' => [ + 'summary' => '获取金融级实人产品Code', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59124', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => '每页显示的产品数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '7FBBADA3-9A66-5759-8AF8-2F99F5BE13F7', + ], + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '产品Code信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => [ + 'description' => '产品Code对应的名称', + 'type' => 'string', + 'example' => 'APP认证', + ], + 'ProductCode' => [ + 'description' => '产品code。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 3,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"7FBBADA3-9A66-5759-8AF8-2F99F5BE13F7\\",\\n \\"TotalCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"ProductName\\": \\"APP认证\\",\\n \\"ProductCode\\": \\"ID_PRO\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取金融级实人产品Code', + 'description' => '请求方法：支持以HTTPS GET/POST方法发送请求。', + ], + 'DescribeVerifyDeviceRiskStatistics' => [ + 'summary' => '获取验证设备的统计数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59141', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间，格式为unix时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1746720000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1748624399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n" + .'- **cloudauth**（已退市）：实人认证。', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'string', + 'required' => false, + 'example' => '100000xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'B3193814-AE54-50C5-9070-68B69C07287D', + ], + 'ResultObject' => [ + 'description' => '认证结果。', + 'type' => 'object', + 'properties' => [ + 'RootRate' => [ + 'description' => 'root百分比：root总数 / 风险总数', + 'type' => 'string', + 'example' => '0', + ], + 'VirtualVideoRate' => [ + 'description' => '虚拟视频百分比：虚拟视频总数 / 风险总数。', + 'type' => 'string', + 'example' => '23.2', + ], + 'RiskCount' => [ + 'description' => '风险数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'IdFakeRate' => [ + 'description' => '疑似虚假身份总数。', + 'type' => 'string', + 'example' => '0', + ], + 'FaceAttackRate' => [ + 'description' => '疑似虚假人脸百分比：疑似虚假人脸总数 / 风险总数。', + 'type' => 'string', + 'example' => '0', + ], + 'SimulatorRate' => [ + 'description' => '模拟器百分比：模拟器总数 / 风险总数。', + 'type' => 'string', + 'example' => '0', + ], + 'Items' => [ + 'description' => '返回结果的数据项。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果的数据项。', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '2025-10-10', + ], + 'DailyCallCount' => [ + 'description' => '日常调用笔数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'DeviceRiskRate' => [ + 'description' => '异常设备风险比率。', + 'type' => 'string', + 'example' => '0', + ], + 'IdentityRiskRate' => [ + 'description' => '异常身份风险比率。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3193814-AE54-50C5-9070-68B69C07287D\\",\\n \\"ResultObject\\": {\\n \\"RootRate\\": \\"0\\",\\n \\"VirtualVideoRate\\": \\"23.2\\",\\n \\"RiskCount\\": 2,\\n \\"IdFakeRate\\": \\"0\\",\\n \\"FaceAttackRate\\": \\"0\\",\\n \\"SimulatorRate\\": \\"0\\",\\n \\"Items\\": [\\n {\\n \\"Date\\": \\"2025-10-10\\",\\n \\"DailyCallCount\\": 11,\\n \\"DeviceRiskRate\\": \\"0\\",\\n \\"IdentityRiskRate\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取验证设备的统计数据', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyFailStatistics' => [ + 'summary' => '查询总认证统计失败量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59142', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n" + .'- **cloudauth**（已退市）：实人认证。', + 'type' => 'string', + 'required' => true, + 'example' => 'cloudauthst', + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'description' => '设备类型。'."\n" + .'- ios'."\n" + .'- android'."\n" + .'- websdk', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'android' => 'android', + 'websdk' => 'websdk', + 'ios' => 'ios', + ], + 'example' => 'ios', + ], + ], + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => 'API编码：'."\n" + .'- **INIT_SERVICE**： 服务端初始化失败'."\n" + .'- **INIT_DEVICE**：客户端失败'."\n" + .'- **VERIFY_DEVICE**：认证不通过', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'VERIFY_DEVICE' => 'VERIFY_DEVICE', + 'INIT_SERVICE' => 'INIT_SERVICE', + 'INIT_DEVICE' => 'INIT_DEVICE', + ], + 'example' => 'INIT_SERVICE', + ], + ], + [ + 'name' => 'AgeGt', + 'in' => 'query', + 'schema' => [ + 'description' => '年龄大于14岁：'."\n" + .'- **T**：大于'."\n" + .'- **F**：小于', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'C2C596D1-B14B-5D79-9672-61D7686912B2', + ], + 'ResultObject' => [ + 'description' => '认证结果。', + 'type' => 'object', + 'properties' => [ + 'Column' => [ + 'description' => '失败原因折线图。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Items' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '404', + ], + 'Rate' => [ + 'description' => 'Date：日期', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Count' => [ + 'description' => '失败数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Line' => [ + 'description' => '失败原因柱状图。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Items' => [ + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '404', + ], + 'Data' => [ + 'description' => '返回数量数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '404', + ], + 'Count' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2C596D1-B14B-5D79-9672-61D7686912B2\\",\\n \\"ResultObject\\": {\\n \\"Column\\": {\\n \\"TotalCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"Code\\": \\"404\\",\\n \\"Rate\\": \\"2025-10-16\\",\\n \\"Count\\": 1\\n }\\n ]\\n },\\n \\"Line\\": {\\n \\"TotalCount\\": 0,\\n \\"Items\\": [\\n {\\n \\"Code\\": \\"404\\",\\n \\"Data\\": [\\n {\\n \\"Date\\": \\"2025-10-16\\",\\n \\"Code\\": \\"404\\",\\n \\"Count\\": 9\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询认证请求失败量统计', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyPersonasDeviceModelStatistics' => [ + 'summary' => '查询认证用户手机型号分布数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59145', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000015316', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间段范围，表示前多少天。', + 'type' => 'string', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '026828A3-CC7E-5D85-85B6-08DF245C5A53', + ], + 'ResultObject' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'AllDeviceCnt' => [ + 'description' => '所有设备数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31', + ], + 'Items' => [ + 'description' => '不同型号手机的数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModel' => [ + 'description' => '设备型号', + 'type' => 'string', + 'example' => 'iPhone15,2', + ], + 'DeviceCnt' => [ + 'description' => '设备数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'DeviceRate' => [ + 'description' => '该型号设备占总设备的比率。', + 'type' => 'string', + 'example' => '16.13', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"026828A3-CC7E-5D85-85B6-08DF245C5A53\\",\\n \\"ResultObject\\": {\\n \\"AllDeviceCnt\\": 31,\\n \\"Items\\": [\\n {\\n \\"DeviceModel\\": \\"iPhone15,2\\",\\n \\"DeviceCnt\\": 5,\\n \\"DeviceRate\\": \\"16.13\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询认证用户手机型号分布数据', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyPersonasOsStatistics' => [ + 'summary' => '查询认证设备分布数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59146', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000002995', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间段范围，表示前多少天', + 'type' => 'string', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '123906BE-752B-51E3-A8FF-52F53B659CE6', + ], + 'ResultObject' => [ + 'description' => '处理结果。', + 'type' => 'object', + 'properties' => [ + 'DeviceIosCnt' => [ + 'description' => '认证ios设备数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AllDeviceCnt' => [ + 'description' => '总认证设备数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'DeviceAndroidRate' => [ + 'description' => '安卓设备占比。', + 'type' => 'string', + 'example' => '58.33', + ], + 'DeviceIosRate' => [ + 'description' => 'ios设备占比。', + 'type' => 'string', + 'example' => '41.67', + ], + 'DeviceAndroidCnt' => [ + 'description' => '安卓认证设备数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123906BE-752B-51E3-A8FF-52F53B659CE6\\",\\n \\"ResultObject\\": {\\n \\"DeviceIosCnt\\": 10,\\n \\"AllDeviceCnt\\": 24,\\n \\"DeviceAndroidRate\\": \\"58.33\\",\\n \\"DeviceIosRate\\": \\"41.67\\",\\n \\"DeviceAndroidCnt\\": 14\\n }\\n}","type":"json"}]', + 'title' => '查询认证设备分布数据', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyPersonasProvinceStatistics' => [ + 'summary' => '按照个体所在省份统计认证信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59147', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000004071', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '时间段范围，搜索范围为前N天，TimeRange为1表示前1天。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'D9821F95-CC18-5439-BB1C-21A0FF0C2003', + ], + 'ResultObject' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'AllUserCnt' => [ + 'description' => '总设备数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Items' => [ + 'description' => '数据项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => '省份名称。', + 'type' => 'string', + 'example' => '浙江', + ], + 'ProvinceCnt' => [ + 'description' => '设备总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'ProvinceRate' => [ + 'description' => '该省份占总百分比。', + 'type' => 'string', + 'example' => '35.71', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9821F95-CC18-5439-BB1C-21A0FF0C2003\\",\\n \\"ResultObject\\": {\\n \\"AllUserCnt\\": 30,\\n \\"Items\\": [\\n {\\n \\"ProvinceName\\": \\"浙江\\",\\n \\"ProvinceCnt\\": 5,\\n \\"ProvinceRate\\": \\"35.71\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '按照个体所在省份统计认证信息', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyPersonasSexStatistics' => [ + 'summary' => '按照个体性别统计认证信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000002996', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '时间段范围，搜索范围为前N天，TimeRange为1表示前1天。', + 'type' => 'string', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '013DA6E1-3F37-5579-B979-2F12B7E92450', + ], + 'ResultObject' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Age0To14Rate' => [ + 'description' => '年龄14以下的占比。', + 'type' => 'string', + 'example' => '0', + ], + 'Age14To18Cnt' => [ + 'description' => '年龄14-18岁之间的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FemaleCnt' => [ + 'description' => '女性用户数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'AllUserCnt' => [ + 'description' => '总认证用户数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'Age14To18Rate' => [ + 'description' => '年龄14-18岁的占比。', + 'type' => 'string', + 'example' => '0', + ], + 'Age0To14Cnt' => [ + 'description' => '年龄14周岁以下的人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaleCnt' => [ + 'description' => '男性数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Age50To999Rate' => [ + 'description' => '年龄50周岁以上的认证用户数量。', + 'type' => 'string', + 'example' => '0', + ], + 'Age35To50Rate' => [ + 'description' => '年龄35-50周岁的占比。', + 'type' => 'string', + 'example' => '35.71', + ], + 'FemaleRate' => [ + 'description' => '女性认证用户占比。', + 'type' => 'string', + 'example' => '28.57', + ], + 'Age18To35Rate' => [ + 'description' => '年龄18-35岁认证用户人数占比。', + 'type' => 'string', + 'example' => '64.29', + ], + 'Age18To35Cnt' => [ + 'description' => '年龄18-35岁认证用户人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Age35To50Cnt' => [ + 'description' => '年龄35-50的认证用户数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Age50To999Cnt' => [ + 'description' => '年龄50周岁以上的认证用户数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MaleRate' => [ + 'description' => '男性用户占比。', + 'type' => 'string', + 'example' => '71.43', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"013DA6E1-3F37-5579-B979-2F12B7E92450\\",\\n \\"ResultObject\\": {\\n \\"Age0To14Rate\\": \\"0\\",\\n \\"Age14To18Cnt\\": 0,\\n \\"FemaleCnt\\": 4,\\n \\"AllUserCnt\\": 14,\\n \\"Age14To18Rate\\": \\"0\\",\\n \\"Age0To14Cnt\\": 0,\\n \\"MaleCnt\\": 10,\\n \\"Age50To999Rate\\": \\"0\\",\\n \\"Age35To50Rate\\": \\"35.71\\",\\n \\"FemaleRate\\": \\"28.57\\",\\n \\"Age18To35Rate\\": \\"64.29\\",\\n \\"Age18To35Cnt\\": 9,\\n \\"Age35To50Cnt\\": 5,\\n \\"Age50To999Cnt\\": 0,\\n \\"MaleRate\\": \\"71.43\\"\\n }\\n}","type":"json"}]', + 'title' => '按照个体性别统计认证信息', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifySearchPageList' => [ + 'summary' => '分页条件查询认证的明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59153', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'CertifyId', + 'in' => 'query', + 'schema' => [ + 'description' => '认证Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'shadbdd3dbacd001cfa892a5e2b98dxx', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'string', + 'required' => false, + 'example' => '10000072xx', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'query', + 'schema' => [ + 'description' => '客户请求唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'CertNo', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'required' => false, + 'example' => '3203212000XXXX701X', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-10 00:00:00 +0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。格式为unix时间戳，单位为毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-16 23:59:59 +0800', + ], + ], + [ + 'name' => 'SubCode', + 'in' => 'query', + 'schema' => [ + 'description' => '结果Code，详情值请参考：[SubCode说明](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '201', + ], + ], + [ + 'name' => 'SubCodes', + 'in' => 'query', + 'schema' => [ + 'description' => '逗号分隔的结果Code，详情值请参考：[SubCode说明](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '201,202', + ], + ], + [ + 'name' => 'HasDeviceRisk', + 'in' => 'query', + 'schema' => [ + 'description' => '是否有设备风险（传true，代表root = 1 or simulator = 1 or virtual_video = 1）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Passed', + 'in' => 'query', + 'schema' => [ + 'description' => '认证是否通过：'."\n" + .'- **T**：通过'."\n" + .'- **F**：不通过', + 'type' => 'string', + 'required' => false, + 'example' => 'F', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => '活体检测的模型。', + 'type' => 'string', + 'required' => false, + 'example' => 'LIVENESS', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。', + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Root', + 'in' => 'query', + 'schema' => [ + 'description' => '是否root（选中传1 否则不传；对应身份标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Simulator', + 'in' => 'query', + 'schema' => [ + 'description' => '是否模拟器（选中传1 否则不传；对应设备标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VirtualVideo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否虚拟适配 （选中传1 否则不传；对应行为标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskDevice', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'RiskDeviceToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'RiskGeneric', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'RiskBizScenario', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'RiskModelMining', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PageSize' => [ + 'description' => '每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '47D87BC1-D956-573A-8A15-A9007A76F56C', + ], + 'TotalCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '53', + ], + 'Items' => [ + 'description' => '分页列表数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtVerify' => [ + 'description' => '该笔认证的验证时间。', + 'type' => 'string', + 'example' => '2025-10-14 15:40:13', + ], + 'Simulator' => [ + 'description' => '是否模拟器（选中传1 否则不传；对应设备标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UserId' => [ + 'description' => '用户id', + 'type' => 'string', + 'example' => '198123xxxxxx', + ], + 'CertifyId' => [ + 'description' => '认证Id。', + 'type' => 'string', + 'example' => 'shad861465f2aaeeb805b519e1a93ab2', + ], + 'Model' => [ + 'description' => '活体检测方案。', + 'type' => 'string', + 'example' => 'MULTI_ACTION', + ], + 'OuterOrderNo' => [ + 'description' => '客户请求唯一标识。', + 'type' => 'string', + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', + ], + 'CertNo' => [ + 'description' => '脱敏后的身份证号。', + 'type' => 'string', + 'example' => '3****************2', + ], + 'SubCode' => [ + 'description' => '系统返回的错误码。', + 'type' => 'string', + 'example' => '207', + ], + 'SceneId' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000015352', + ], + 'Root' => [ + 'description' => '是否root（选中传1 否则不传；对应身份标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Passed' => [ + 'description' => '认证是否通过。取值：'."\n" + .'- **T**：通过。'."\n" + .'- **F**：不通过。', + 'type' => 'string', + 'example' => 'T', + ], + 'VirtualVideo' => [ + 'description' => '是否虚拟适配 （选中传1 否则不传；对应行为标签风险类型）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProductCode' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'ExtInfo' => [ + 'description' => '扩展信息。', + 'type' => 'object', + 'properties' => [ + 'OssIdNationalEmblemObjectName' => [ + 'description' => 'OCR身份证国徽文件名', + 'type' => 'string', + 'example' => '-', + ], + 'QualityScore' => [ + 'description' => '活体人脸质量分。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.0', + ], + 'FaceAttackScore' => [ + 'description' => '人脸攻击分数，取值范围为0~1，趋于1表明越趋近于攻击。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0000445161', + ], + 'CertName' => [ + 'description' => '脱敏后的姓名。', + 'type' => 'string', + 'example' => '何*', + ], + 'FaceAttack' => [ + 'description' => '是否是人脸攻击：'."\n" + .'- **T**：是'."\n" + .'- **F**：否', + 'type' => 'string', + 'example' => 'T', + ], + 'IdCardVerifyScore' => [ + 'description' => '人脸身份证比对分。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.9', + ], + 'OssIdFaceObjectName' => [ + 'description' => 'OCR身份证人脸文件名。', + 'type' => 'string', + 'example' => '-', + ], + 'FaceOcclusion' => [ + 'description' => '脸部是否有遮挡，有为T，否则F。', + 'type' => 'string', + 'example' => 'T', + ], + 'VerifyScore' => [ + 'description' => '人脸比对分数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.0', + ], + 'OssBucketName' => [ + 'description' => '照片oss的bucket。', + 'type' => 'string', + 'example' => 'cn-shanghai-aliyun-cloudauth-XXX', + ], + 'OssObjectName' => [ + 'description' => '存储对象名称。', + 'type' => 'string', + 'example' => 'verify/XXXXX1251634779/sha6a0a0cab01288c7aa8ac3f45220eb_0_normal.jpeg', + ], + 'asrTexts' => [ + 'description' => 'ASR文本列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ASR文本', + 'type' => 'string', + 'example' => '请朗读：3 5 8 1', + ], + ], + 'voiceObjectNames' => [ + 'description' => '音频文件OSS文件名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音频文件OSS文件名。', + 'type' => 'string', + 'example' => 'XXXXXc3f45220eb_0.mp4'."\n", + ], + 'example' => '-', + ], + 'screenVideoObjectNames' => [ + 'description' => '录屏文件OSS文件名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录屏文件OSS文件名。', + 'type' => 'string', + 'example' => 'XXXXXc3f45220eb_0.mp4', + ], + 'example' => '-', + ], + 'DeviceRisk' => [ + 'description' => '人脸保镖标签。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + 'RiskDevice' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskDeviceToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskGeneric' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskBizScenario' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RiskModelMining' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 4,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"47D87BC1-D956-573A-8A15-A9007A76F56C\\",\\n \\"TotalCount\\": 53,\\n \\"Items\\": [\\n {\\n \\"GmtVerify\\": \\"2025-10-14 15:40:13\\",\\n \\"Simulator\\": 1,\\n \\"UserId\\": \\"198123xxxxxx\\",\\n \\"CertifyId\\": \\"shad861465f2aaeeb805b519e1a93ab2\\",\\n \\"Model\\": \\"MULTI_ACTION\\",\\n \\"OuterOrderNo\\": \\"e0c34a77f5ac40a5aa5e6ed20c353888\\",\\n \\"CertNo\\": \\"3****************2\\",\\n \\"SubCode\\": \\"207\\",\\n \\"SceneId\\": 1000015352,\\n \\"Root\\": 1,\\n \\"Passed\\": \\"T\\",\\n \\"VirtualVideo\\": 1,\\n \\"ProductCode\\": \\"ID_PRO\\",\\n \\"ExtInfo\\": {\\n \\"OssIdNationalEmblemObjectName\\": \\"-\\",\\n \\"QualityScore\\": 1,\\n \\"FaceAttackScore\\": 0.0000445161,\\n \\"CertName\\": \\"何*\\",\\n \\"FaceAttack\\": \\"T\\",\\n \\"IdCardVerifyScore\\": 0.9,\\n \\"OssIdFaceObjectName\\": \\"-\\",\\n \\"FaceOcclusion\\": \\"T\\",\\n \\"VerifyScore\\": 0,\\n \\"OssBucketName\\": \\"cn-shanghai-aliyun-cloudauth-XXX\\",\\n \\"OssObjectName\\": \\"verify/XXXXX1251634779/sha6a0a0cab01288c7aa8ac3f45220eb_0_normal.jpeg\\",\\n \\"asrTexts\\": [\\n \\"请朗读：3 5 8 1\\"\\n ],\\n \\"voiceObjectNames\\": [\\n \\"XXXXXc3f45220eb_0.mp4\\\\n\\"\\n ],\\n \\"screenVideoObjectNames\\": [\\n \\"XXXXXc3f45220eb_0.mp4\\"\\n ],\\n \\"DeviceRisk\\": \\"-\\"\\n },\\n \\"RiskDevice\\": 0,\\n \\"RiskDeviceToken\\": 0,\\n \\"RiskGeneric\\": 0,\\n \\"RiskBizScenario\\": 0,\\n \\"RiskModelMining\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询认证列表', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeVerifyStatistics' => [ + 'summary' => '查询认证请求的统计信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '59155', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth0KJCLK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760025600000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760630399999', + ], + ], + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + .'- **antcloudauth**：金融级实人认证。'."\n" + .'- **cloudauthst**（已退市）：实人认证增强版。'."\n" + .'- **cloudauth**（已退市）：实人认证。', + 'type' => 'string', + 'required' => true, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'AgeGt', + 'in' => 'query', + 'schema' => [ + 'description' => '年龄是否高于14岁：'."\n" + .'- **T**：高于'."\n" + .'- **F**：低于', + 'type' => 'string', + 'required' => false, + 'example' => 'T', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '4E27D502-1287-526A-910C-881A3F023914', + ], + 'ResultObject' => [ + 'description' => '统计结果', + 'type' => 'object', + 'properties' => [ + 'InitServiceId' => [ + 'description' => '身份去重服务端初始化请求总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitServiceIdSuccess' => [ + 'description' => '身份去重服务端初始化成功数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceIdSuccess' => [ + 'description' => '身份去重客户端初始化成功数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceId' => [ + 'description' => '身份去重客户端初始化数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'InitDeviceSuccess' => [ + 'description' => '客户端初始化调用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDeviceIdSuccessPassed' => [ + 'description' => '身份去重客户端认证成功次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'VerifyDeviceSuccessPassed' => [ + 'description' => '客户端认证成功次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'VerifyDeviceId' => [ + 'description' => '身份去重客户端认证次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'VerifyDeviceSuccess' => [ + 'description' => '客户端认证成功次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'InitDevice' => [ + 'description' => '客户端初始化次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDeviceIdSuccess' => [ + 'description' => '身份去重客户端验证成功次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'InitServiceSuccess' => [ + 'description' => '服务端初始化认证成功次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '134', + ], + 'InitService' => [ + 'description' => '服务端初始化次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73', + ], + 'VerifyDevice' => [ + 'description' => '客户端验证次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Items' => [ + 'description' => '按天统计的通过/转化率（PV）。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InitDevicePassRate' => [ + 'description' => '客户端初始化通过率。', + 'type' => 'string', + 'example' => '60', + ], + 'InitServicePassRate' => [ + 'description' => '服务端初始化通过率。', + 'type' => 'string', + 'example' => '20', + ], + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '2025-10-11', + ], + 'InitServiceConversionRate' => [ + 'description' => '服务端初始化转换率。', + 'type' => 'string', + 'example' => '26.67', + ], + 'PassRate' => [ + 'description' => '通过率。', + 'type' => 'string', + 'example' => '75', + ], + 'InitService' => [ + 'description' => '服务端初始化数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E27D502-1287-526A-910C-881A3F023914\\",\\n \\"ResultObject\\": {\\n \\"InitServiceId\\": 9,\\n \\"InitServiceIdSuccess\\": 9,\\n \\"InitDeviceIdSuccess\\": 9,\\n \\"InitDeviceId\\": 9,\\n \\"InitDeviceSuccess\\": 73,\\n \\"VerifyDeviceIdSuccessPassed\\": 3,\\n \\"VerifyDeviceSuccessPassed\\": 6,\\n \\"VerifyDeviceId\\": 9,\\n \\"VerifyDeviceSuccess\\": 15,\\n \\"InitDevice\\": 73,\\n \\"VerifyDeviceIdSuccess\\": 6,\\n \\"InitServiceSuccess\\": 134,\\n \\"InitService\\": 73,\\n \\"VerifyDevice\\": 15,\\n \\"Items\\": [\\n {\\n \\"InitDevicePassRate\\": \\"60\\",\\n \\"InitServicePassRate\\": \\"20\\",\\n \\"Date\\": \\"2025-10-11\\",\\n \\"InitServiceConversionRate\\": \\"26.67\\",\\n \\"PassRate\\": \\"75\\",\\n \\"InitService\\": 15\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询认证统计信息', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'DescribeMetaSearchPageList' => [ + 'summary' => '分页查询信息核验明细。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103364', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Api：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测 '."\n" + .'- **VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ID_CARD_2_META', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，unix时间戳类型（毫秒级）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760198400000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，unix时间戳类型（毫秒级）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1739926800000', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '认证状态：'."\n" + .'- **1**：认证通过'."\n" + .'- **2**：认证不通过'."\n" + .'- **3**: 查无记录', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SubCode', + 'in' => 'query', + 'schema' => [ + 'description' => '结果Code，具体可参考[官方文档](https://help.aliyun.com/zh/id-verification/information-verification/?spm=a2c4g.11186623.help-menu-sub-2401581.d_3.1a9d566esFDKFy&scm=20140722.H_2557734._.OR_help-T_cn~zh-V_1)。', + 'type' => 'string', + 'required' => false, + 'example' => '205', + ], + ], + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'B012DB99-6C10-5740-81E0-B3A8C1C1B9C1', + ], + ], + [ + 'name' => 'IdentifyNum', + 'in' => 'query', + 'schema' => [ + 'description' => '身份证号。', + 'type' => 'string', + 'required' => false, + 'example' => '522132197411184XXX', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '姓名。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数：每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'VehicleNum', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号。', + 'type' => 'string', + 'required' => false, + 'example' => '陕A9****', + ], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号。', + 'type' => 'string', + 'required' => false, + 'example' => '19127612221', + ], + ], + [ + 'name' => 'BankCard', + 'in' => 'query', + 'schema' => [ + 'description' => '银行卡。', + 'type' => 'string', + 'required' => false, + 'example' => '610*************1181', + ], + ], + [ + 'name' => 'IspName', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商名称：'."\n" + .'- **CMCC**：中国移动'."\n" + .'- **CUCC**：中国联通'."\n" + .'- **CTCC**：中国电信'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CTCC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PageSize' => [ + 'description' => '分页参数：每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '5176EB42-6EE7-510B-9388-35018DF3175B', + ], + 'TotalCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Items' => [ + 'description' => '分页列表数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IdentifyNum' => [ + 'description' => '身份证号'."\n", + 'type' => 'string', + 'example' => '4****************X', + ], + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'B0102BEF-4411-57C3-860D-CFE7DE0A64C0', + ], + 'Api' => [ + 'description' => '产品Api：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测 '."\n" + .'- **VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验'."\n", + 'type' => 'string', + 'example' => 'ID_CARD_2_META', + ], + 'BizCode' => [ + 'description' => '认证状态：'."\n" + .'- **1**：认证通过'."\n" + .'- **2**：认证不通过'."\n" + .'- **3**: 查无记录', + 'type' => 'string', + 'example' => '1', + ], + 'Date' => [ + 'description' => '认证日期。', + 'type' => 'string', + 'example' => '2025-10-17 10:00:11', + ], + 'SubCode' => [ + 'description' => '结果Code，具体可参考[官方文档](https://help.aliyun.com/zh/id-verification/information-verification/?spm=a2c4g.11186623.help-menu-sub-2401581.d_3.1a9d566esFDKFy&scm=20140722.H_2557734._.OR_help-T_cn~zh-V_1)。', + 'type' => 'string', + 'example' => '207', + ], + 'UserName' => [ + 'description' => '姓名', + 'type' => 'string', + 'example' => '**豪', + ], + 'ApiName' => [ + 'description' => 'Api对应的名称：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测 '."\n" + .'- **VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验'."\n", + 'type' => 'string', + 'example' => '身份证二要素', + ], + 'Request' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'VehicleNum' => [ + 'description' => '车辆编号。', + 'type' => 'string', + 'example' => '浙J3H91H', + ], + 'VehicleType' => [ + 'description' => '车辆类型：'."\n" + .'- **01**：大型汽车 '."\n" + .'- **02**：小型汽车 '."\n" + .'- **03**：使馆汽车 '."\n" + .'- **04**：领馆汽车 '."\n" + .'- **05**：境外汽车 '."\n" + .'- **06**：外籍汽车 '."\n" + .'- **07**：普通摩托车 '."\n" + .'- **08**：轻便摩托车 '."\n" + .'- **09**：使馆摩托车 '."\n" + .'- **10**：领馆摩托车 '."\n" + .'- **11**：境外摩托车 '."\n" + .'- **12**：外籍摩托车 '."\n" + .'- **13**：低速车 '."\n" + .'- **14**：拖拉机 '."\n" + .'- **15**：挂车 '."\n" + .'- **16**：教练汽车 '."\n" + .'- **17**：教练摩托车 '."\n" + .'- **20**：临时入境汽车 '."\n" + .'- **21**：临时入境摩托车 '."\n" + .'- **22**：临时行驶车 '."\n" + .'- **23**：警用汽车 '."\n" + .'- **24**：警用摩托 '."\n" + .'- **51**：新能源大型车 '."\n" + .'- **52**：新能源小型车', + 'type' => 'string', + 'example' => '52', + ], + 'VehicleTypeName' => [ + 'description' => '车辆类型名称。', + 'type' => 'string', + 'example' => '新能源小型车', + ], + ], + ], + 'Response' => [ + 'description' => '响应内容。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'BizCode' => [ + 'description' => '认证状态：'."\n" + .'- **1**：认证通过'."\n" + .'- **2**：认证不通过'."\n" + .'- **3**: 查无记录', + 'type' => 'string', + 'example' => '2', + ], + 'Vin' => [ + 'description' => '车辆识别代号。', + 'type' => 'string', + 'example' => 'LDC643T44G3667219', + ], + 'ModelNum' => [ + 'description' => '车辆型号。', + 'type' => 'string', + 'example' => 'HQ7002BEV67', + ], + 'EngineNum' => [ + 'description' => '发动机号。', + 'type' => 'string', + 'example' => 'N7YJ113PA', + ], + 'Type' => [ + 'description' => '车辆类型。', + 'type' => 'string', + 'example' => '小型轿车', + ], + 'Color' => [ + 'description' => '车身颜色。', + 'type' => 'string', + 'example' => '白', + ], + 'UseProperty' => [ + 'description' => '使用性质。', + 'type' => 'string', + 'example' => '0', + ], + 'RegistrationDate' => [ + 'description' => '初次登记日期。', + 'type' => 'string', + 'example' => '2015-08-24 00:00:00', + ], + 'InspectionDate' => [ + 'description' => '检验有效期止。', + 'type' => 'string', + 'example' => '2026-07-31 00:00:00', + ], + 'RetirementDate' => [ + 'description' => '强制报废日期。', + 'type' => 'string', + 'example' => '2099-12-31 00:00:00', + ], + 'VehicleState' => [ + 'description' => '机动车状态。', + 'type' => 'string', + 'example' => '正常', + ], + 'EngineType' => [ + 'description' => '发动机型号。', + 'type' => 'string', + 'example' => 'CA6GV30TD', + ], + 'FuelType' => [ + 'description' => '燃料种类。', + 'type' => 'string', + 'example' => '电', + ], + 'Displacement' => [ + 'description' => '排量。', + 'type' => 'string', + 'example' => '0', + ], + 'Power' => [ + 'description' => '功率。', + 'type' => 'string', + 'example' => '120', + ], + 'AxleCount' => [ + 'description' => '轴数。', + 'type' => 'string', + 'example' => '2', + ], + 'WheelBase' => [ + 'description' => '轴距。', + 'type' => 'string', + 'example' => '2750', + ], + 'FrontWheelDistance' => [ + 'description' => '前轮距。', + 'type' => 'string', + 'example' => '1630', + ], + 'BackWheelDistance' => [ + 'description' => '后轮距。', + 'type' => 'string', + 'example' => '1630', + ], + 'TotalMass' => [ + 'description' => '总质量。', + 'type' => 'string', + 'example' => '2350', + ], + 'UnladenMass' => [ + 'description' => '整备质量。', + 'type' => 'string', + 'example' => '1900', + ], + 'ApprovedLoad' => [ + 'description' => '核定载客量。', + 'type' => 'string', + 'example' => '0', + ], + 'ApprovedCount' => [ + 'description' => '核定载客。', + 'type' => 'string', + 'example' => '5', + ], + 'ReleaseDate' => [ + 'description' => '出厂日期。', + 'type' => 'string', + 'example' => '2022-08-13 00:00:00', + ], + 'Brand' => [ + 'description' => '品牌名称。', + 'type' => 'string', + 'example' => '奔驰', + ], + 'BankCard' => [ + 'description' => '银行卡号。', + 'type' => 'string', + 'example' => '622848001714440xxxx', + ], + ], + ], + 'Code' => [ + 'description' => 'http返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '消息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + 'VehicleNum' => [ + 'description' => '车辆编号。', + 'type' => 'string', + 'example' => '浙J3H91H', + ], + 'RequestJson' => [ + 'description' => 'http请求参数。', + 'type' => 'string', + 'example' => '{\\"productCode\\":\\"cloudauth_infoverify_public_cn\\",\\"identifyNum\\":\\"4****************X\\",\\"userName\\":\\"**豪\\",\\"userId\\":\\"12600512516xxxxx\\"}', + ], + 'ResponseJson' => [ + 'description' => '响应内容。', + 'type' => 'string', + 'example' => '{\\"code\\":\\"200\\",\\"data\\":{\\"bizCode\\":\\"1\\",\\"ispName\\":\\"CMCC\\",\\"subCode\\":\\"101\\"},\\"message\\":\\"调用成功\\"}', + ], + 'Mobile' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '1500000xxxx', + ], + 'BankCard' => [ + 'description' => '银行卡id。', + 'type' => 'string', + 'example' => '6214837145546986', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + .'- **CMCC**：中国移动'."\n" + .'- **CUCC**：中国联通'."\n" + .'- **CTCC**：中国电信'."\n", + 'type' => 'string', + 'example' => 'CUCC', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 0,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"5176EB42-6EE7-510B-9388-35018DF3175B\\",\\n \\"TotalCount\\": 0,\\n \\"Items\\": [\\n {\\n \\"IdentifyNum\\": \\"4****************X\\",\\n \\"RequestId\\": \\"B0102BEF-4411-57C3-860D-CFE7DE0A64C0\\",\\n \\"Api\\": \\"ID_CARD_2_META\\",\\n \\"BizCode\\": \\"1\\",\\n \\"Date\\": \\"2025-10-17 10:00:11\\",\\n \\"SubCode\\": \\"207\\",\\n \\"UserName\\": \\"**豪\\",\\n \\"ApiName\\": \\"身份证二要素\\",\\n \\"Request\\": {\\n \\"VehicleNum\\": \\"浙J3H91H\\",\\n \\"VehicleType\\": \\"52\\",\\n \\"VehicleTypeName\\": \\"新能源小型车\\"\\n },\\n \\"Response\\": {\\n \\"Data\\": {\\n \\"BizCode\\": \\"2\\",\\n \\"Vin\\": \\"LDC643T44G3667219\\",\\n \\"ModelNum\\": \\"HQ7002BEV67\\",\\n \\"EngineNum\\": \\"N7YJ113PA\\",\\n \\"Type\\": \\"小型轿车\\",\\n \\"Color\\": \\"白\\",\\n \\"UseProperty\\": \\"0\\",\\n \\"RegistrationDate\\": \\"2015-08-24 00:00:00\\",\\n \\"InspectionDate\\": \\"2026-07-31 00:00:00\\",\\n \\"RetirementDate\\": \\"2099-12-31 00:00:00\\",\\n \\"VehicleState\\": \\"正常\\",\\n \\"EngineType\\": \\"CA6GV30TD\\",\\n \\"FuelType\\": \\"电\\",\\n \\"Displacement\\": \\"0\\",\\n \\"Power\\": \\"120\\",\\n \\"AxleCount\\": \\"2\\",\\n \\"WheelBase\\": \\"2750\\",\\n \\"FrontWheelDistance\\": \\"1630\\",\\n \\"BackWheelDistance\\": \\"1630\\",\\n \\"TotalMass\\": \\"2350\\",\\n \\"UnladenMass\\": \\"1900\\",\\n \\"ApprovedLoad\\": \\"0\\",\\n \\"ApprovedCount\\": \\"5\\",\\n \\"ReleaseDate\\": \\"2022-08-13 00:00:00\\",\\n \\"Brand\\": \\"奔驰\\",\\n \\"BankCard\\": \\"622848001714440xxxx\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\"\\n },\\n \\"VehicleNum\\": \\"浙J3H91H\\",\\n \\"RequestJson\\": \\"{\\\\\\\\\\\\\\"productCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloudauth_infoverify_public_cn\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"identifyNum\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4****************X\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"**豪\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12600512516xxxxx\\\\\\\\\\\\\\"}\\",\\n \\"ResponseJson\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"200\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"bizCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CMCC\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"101\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"调用成功\\\\\\\\\\\\\\"}\\",\\n \\"Mobile\\": \\"1500000xxxx\\",\\n \\"BankCard\\": \\"6214837145546986\\",\\n \\"IspName\\": \\"CUCC\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询信息核验明细。', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'DescribeMetaStatisticsList' => [ + 'summary' => '查询信息核验认证统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103365', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Code：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测'."\n" + .'-**VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'required' => true, + 'example' => 'MOBILE_ONLINE_LENGTH', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间，使用unix时间戳表示，单位：豪秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间，使用unix时间戳表示，单位：豪秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1750694399999', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '3F860B3F-76B7-5555-A907-2F4433BF8868', + ], + 'Items' => [ + 'description' => '统计信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessRate' => [ + 'description' => '调用成功率(%)。', + 'type' => 'string', + 'example' => '100', + ], + 'Api' => [ + 'description' => '商品（产品）Code。'."\n", + 'type' => 'string', + 'example' => 'MOBILE_ONLINE_LENGTH', + ], + 'BillRate' => [ + 'description' => '查得率(%)。', + 'type' => 'string', + 'example' => '0', + ], + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '11/8', + ], + 'TotalCount' => [ + 'description' => '总调用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => '调用成功量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NoRecordCount' => [ + 'description' => '无学历信息调用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BillCount' => [ + 'description' => '查得量(计费)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'UnpassedCount' => [ + 'description' => '认证不通过量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PassedRate' => [ + 'description' => '认证通过率(%)。', + 'type' => 'string', + 'example' => '20', + ], + 'ApiName' => [ + 'description' => 'Api对应的名称：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测'."\n" + .'-**VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'example' => '身份证二要素', + ], + 'PassedCount' => [ + 'description' => '认证通过量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + .'- **CMCC**：中国移动'."\n" + .'- **CUCC**：中国联通'."\n" + .'- **CTCC**：中国电信', + 'type' => 'string', + 'example' => 'CUCC', + ], + 'ChargeCount' => [ + 'description' => '查询手机号成功量(号码检测独有)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F860B3F-76B7-5555-A907-2F4433BF8868\\",\\n \\"Items\\": [\\n {\\n \\"SuccessRate\\": \\"100\\",\\n \\"Api\\": \\"MOBILE_ONLINE_LENGTH\\",\\n \\"BillRate\\": \\"0\\",\\n \\"Date\\": \\"11/8\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"NoRecordCount\\": 0,\\n \\"BillCount\\": 0,\\n \\"UnpassedCount\\": 2,\\n \\"PassedRate\\": \\"20\\",\\n \\"ApiName\\": \\"身份证二要素\\",\\n \\"PassedCount\\": 9,\\n \\"IspName\\": \\"CUCC\\",\\n \\"ChargeCount\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询信息核验认证统计信息', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'DescribeMetaStatisticsPageList' => [ + 'summary' => '分页查询信息核验认真数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '103367', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Api：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测 '."\n" + .'- **VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PERIOD', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，时间戳为毫秒格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1760112000000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1737561599999', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'C379C9E4-4DA0-5D0B-821B-25E2B8693D48', + ], + 'TotalCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Items' => [ + 'description' => '分页列表数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SuccessRate' => [ + 'description' => '调用成功率（%）。', + 'type' => 'string', + 'example' => '100', + ], + 'Api' => [ + 'description' => 'Api。', + 'type' => 'string', + 'example' => 'ID_PERIOD', + ], + 'BillRate' => [ + 'description' => '查得率（%）', + 'type' => 'string', + 'example' => '80', + ], + 'Date' => [ + 'description' => '日期。', + 'type' => 'string', + 'example' => '11/8', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'SuccessCount' => [ + 'description' => '请求成功量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NoRecordCount' => [ + 'description' => '无学历信息调用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'BillCount' => [ + 'description' => '查得量(计费)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UnpassedCount' => [ + 'description' => '调用未通过量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PassedRate' => [ + 'description' => '认证通过率(%)。', + 'type' => 'string', + 'example' => '80', + ], + 'ApiName' => [ + 'description' => 'Api对应的名称：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测'."\n" + .' -**VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'example' => '车辆要素核验增强版', + ], + 'PassedCount' => [ + 'description' => '认证通过量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'IspName' => [ + 'description' => '运营商名称：'."\n" + .'- **CMCC**：中国移动'."\n" + .'- **CUCC**：中国联通'."\n" + .'- **CTCC**：中国电信'."\n", + 'type' => 'string', + 'example' => 'CMCC', + ], + 'ChargeCount' => [ + 'description' => '查询手机号成功量(号码检测独有)。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 3,\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"C379C9E4-4DA0-5D0B-821B-25E2B8693D48\\",\\n \\"TotalCount\\": 7,\\n \\"Items\\": [\\n {\\n \\"SuccessRate\\": \\"100\\",\\n \\"Api\\": \\"ID_PERIOD\\",\\n \\"BillRate\\": \\"80\\",\\n \\"Date\\": \\"11/8\\",\\n \\"TotalCount\\": 4,\\n \\"SuccessCount\\": 1,\\n \\"NoRecordCount\\": 12,\\n \\"BillCount\\": 10,\\n \\"UnpassedCount\\": 2,\\n \\"PassedRate\\": \\"80\\",\\n \\"ApiName\\": \\"车辆要素核验增强版\\",\\n \\"PassedCount\\": 21,\\n \\"IspName\\": \\"CMCC\\",\\n \\"ChargeCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询信息核验认真数据', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'QuerySceneConfigs' => [ + 'summary' => '查询意愿认证设置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138609', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '场景类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VOLUNTARY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListRespDTO<SceneConfigDTO>', + 'description' => 'ListRespDTO<SceneConfigDTO>', + 'type' => 'object', + 'properties' => [ + 'sceneConfigs' => [ + 'description' => '意愿配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '配置id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '607', + ], + 'gmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1760782820000', + ], + 'gmtModified' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1760782820000', + ], + 'type' => [ + 'description' => '配置类型。', + 'type' => 'string', + 'example' => 'VOLUNTARY', + ], + 'sceneId' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000009045', + ], + 'version' => [ + 'description' => '场景配置版本号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'config' => [ + 'description' => '具体的配置内容，为JSON字符串。', + 'type' => 'string', + 'example' => '{\\"faceCompareMode\\":\\"CUSTOM\\",\\"certConfigs\\":[{\\"index\\":0,\\"openVoiceCompare\\":false,\\"openCustomizedContent\\":true,\\"model\\":\\"QA\\"}],\\"screenEvidence\\":true}', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sceneConfigs\\": [\\n {\\n \\"id\\": 607,\\n \\"gmtCreate\\": \\"1760782820000\\",\\n \\"gmtModified\\": \\"1760782820000\\",\\n \\"type\\": \\"VOLUNTARY\\",\\n \\"sceneId\\": 1000009045,\\n \\"version\\": 1,\\n \\"config\\": \\"{\\\\\\\\\\\\\\"faceCompareMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CUSTOM\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"certConfigs\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"index\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"openVoiceCompare\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"openCustomizedContent\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"model\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"QA\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"screenEvidence\\\\\\\\\\\\\\":true}\\"\\n }\\n ],\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => '查询意愿认证设置', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。', + ], + 'CreateSceneConfig' => [ + 'summary' => '创建意愿认证配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138594', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'formData', + 'schema' => [ + 'description' => '配置类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VOLUNTARY', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '场景id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000014084', + ], + ], + [ + 'name' => 'config', + 'in' => 'formData', + 'schema' => [ + 'description' => '意愿认证配置，为JSON字符串。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{\\"faceCompareMode\\":\\"AUTHORITY\\",\\"certConfigs\\":[{\\"index\\":0,\\"openVoiceCompare\\":true,\\"openCustomizedContent\\":true,\\"model\\":\\"FOLLOW\\"}],\\"screenEvidence\\":false}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<SceneConfigDTO>', + 'description' => 'RespDTO<SceneConfigDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\"\\n}","type":"json"}]', + 'title' => '创建场景配置意愿认证配置。', + 'description' => '请求方法：支持以HTTPS POST方法发送请求。'."\n" + .'请求地址：cloudauth.aliyuncs.com。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'UpdateSceneConfig' => [ + 'summary' => '更新意愿场景配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138608', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'id', + 'in' => 'formData', + 'schema' => [ + 'description' => '意愿配置id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '607', + ], + ], + [ + 'name' => 'sceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '选择的认证场景。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000012918', + ], + ], + [ + 'name' => 'config', + 'in' => 'formData', + 'schema' => [ + 'description' => '场景配置信息，json格式。具体结构定义，请参见关于配置的更多信息。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"faceCompareMode\\":\\"AUTHORITY\\",\\"certConfigs\\":[{\\"index\\":0,\\"model\\":\\"ENROLL\\"}],\\"screenEvidence\\":false}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<Boolean>', + 'description' => 'RespDTO<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => '更新意愿场景配置', + 'description' => '- 请求方法：支持以HTTPS POST发送请求。'."\n" + .'- 请求地址：cloudauth.aliyuncs.com。', + ], + 'DeleteSceneConfig' => [ + 'summary' => '删除场景配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '138610', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'sceneConfigId', + 'in' => 'formData', + 'schema' => [ + 'description' => '意愿认证配置id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '559', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RespDTO<Boolean>', + 'description' => 'RespDTO<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '删除场景配置', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 请求地址：cloudauth.aliyuncs.com。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'QueryVerifyDownloadTask' => [ + 'summary' => '查询实人下载任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165842', + 'abilityTreeNodes' => [ + 'FEATUREcloudauth6RJHVQ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DownloadTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '下载任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '202411194002618', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + 'Finish' => [ + 'description' => '下载任务是否完成：'."\n" + .'- **true**：完成'."\n" + .'- **false**：未完成', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Url' => [ + 'description' => '下载地址。', + 'type' => 'string', + 'example' => 'http://xxx/xxx.csv', + ], + 'Status' => [ + 'description' => '任务状态：'."\n" + .'- **1**：文件生成中'."\n" + .'- **2**: 文件生成完成'."\n" + .'- **3**: 文件生成失败'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\",\\n \\"Finish\\": true,\\n \\"Url\\": \\"http://xxx/xxx.csv\\",\\n \\"Status\\": 2,\\n \\"ErrorCode\\": \\"-\\"\\n}","type":"json"}]', + 'title' => '查询下载认证数据任务详情信息', + 'description' => '根据查询条件获取产品方案下的统计调用数据文件的下载链接。'."\n" + .'- 方法：HTTPS POST'."\n" + .'- 服务地址：cloudauth.aliyuncs.com'."\n" + ."\n" + .'> 实人认证产品以CertifyId统计调用量，为了方便对账请在您的系统留存CertifyId字段。'."\n", + ], + 'DownloadVerifyRecords' => [ + 'summary' => '获取统计调用量数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '165265', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthHJ4WQV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型：'."\n" + .'- **FINANCE_VERIFY**：金融级实人'."\n" + .'- **SMART_VERIFY**：增强版实人认证（已退市）'."\n" + .'- **FACE_VERIFY**：实人认证（已退市）'."\n" + .'- **INFO_CHECK_STATISTICS**：信息核验', + 'type' => 'string', + 'required' => false, + 'example' => 'FINANCE_VERIFY', + ], + ], + [ + 'name' => 'BizParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'JSON字符串类型的查询条件，具体包含字段：'."\n" + .'- **DownloadMode（String）**：下载模式，'."\n" + .' - 示例值：sync'."\n" + .'- **InvokeType（String）**：产品方案，对应**ProductType**'."\n" + .'- **SceneIdList（List<Long>）**: 场景Id列表'."\n" + .'- **StatisticsType**（String）：统计类型'."\n" + .' - day'."\n" + .' - month'."\n" + .'- **StartDate（String）**：查询开始时间'."\n" + .' - 示例值：2025-09-17 00:00:00 +0800'."\n" + .'- **EndDate（String）**：查询结束时间'."\n" + .' - 示例值：2025-10-16 23:59:59 +0800'."\n" + .'- **ProductProgramList**：要查询的产品方案下对应的产品Code列表'."\n" + .' - 示例值：["FINANCE_FACE_VERIFY","MFVC"]'."\n" + .'- **Code（信息核验API）**：'."\n" + .' - **ID_CARD_2_META**：身份证二要素'."\n" + .' - **ID_PERIOD**：身份证有效核验期'."\n" + .' - **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .' - **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .' - **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .' - **MOBILE_3_META**：手机号三要素详版'."\n" + .' - **MOBILE_2_META**：手机号二要素'."\n" + .' - **BANK_CARD_N_META**：银行卡验证详版'."\n" + .' - **MOBILE_DETECT**：号码检测 '."\n" + .' - **VEHICLE_N_META**：车辆要素核验增强版'."\n" + .' - **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .' - **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .' - **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .' - **VEHICLE_CHECK**：车辆要素核验'."\n" + .'- **ProductCode**（信息核验）：同Code', + 'type' => 'string', + 'required' => false, + 'example' => '{"ProductType":"INVOKE_STATISTICS","BizParam":{"DownloadMode":"sync","InvokeType":"FINANCE_VERIFY","SceneIdList":"[]","ProductProgramList":"[\\"FINANCE_FACE_VERIFY\\",\\"MFVC\\",\\"PV_FV\\",\\"CLOUD_FACE_CAPTURE\\",\\"FACE_GUARD\\",\\"PV_FC\\"]","StatisticsType":"day","StartDate":"2025-09-17 00:00:00 +0800","EndDate":"2025-10-16 23:59:59 +0800"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D6163397-15C5-419C-9ACC-B7C83E0B4C10', + ], + 'ResultObject' => [ + 'description' => '文件下载的OSS链接。', + 'type' => 'string', + 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/invoke_download/0E30CD55-DCD4-5363-AA98-XXXXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6163397-15C5-419C-9ACC-B7C83E0B4C10\\",\\n \\"ResultObject\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/invoke_download/0E30CD55-DCD4-5363-AA98-XXXXXXX\\"\\n}","type":"json"}]', + 'title' => '获取要下载的认证调用量数据', + 'description' => '根据查询条件获取产品方案下的统计调用数据文件的下载链接。'."\n" + .'- 方法：HTTPS POST'."\n" + .'- 服务地址：cloudauth.aliyuncs.com'."\n" + ."\n" + .'> 实人认证产品以CertifyId统计调用量，为了方便对账请在您的系统留存CertifyId字段。'."\n", + ], + 'QueryVerifyFlowPackage' => [ + 'summary' => '流量包查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '168774', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型：'."\n" + .'- **FINANCE_VERIFY**：金融级实人'."\n" + .'- **SMART_VERIFY**：增强版实人认证（已退市）'."\n" + .'- **FACE_VERIFY**：实人认证（已退市）', + 'type' => 'string', + 'required' => true, + 'example' => 'FINANCE_VERIFY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '969434DF-926B-4997-9881-4DE94E39F805', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码', + 'type' => 'string', + 'example' => '200', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'string', + 'example' => '1', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Items' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'CommodityName' => [ + 'description' => '资源包的名称。', + 'type' => 'string', + 'example' => '实人认证流量包', + ], + 'CurrCapacity' => [ + 'description' => '当前剩余可用的容量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CurrProportion' => [ + 'description' => '当前剩余容量占总容量的比例。', + 'type' => 'string', + 'example' => '0%', + ], + 'TotalCapacity' => [ + 'description' => '总额度。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'UsedCapacity' => [ + 'description' => '已使用容量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'FlowDetails' => [ + 'description' => '流量包详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => '总量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0', + ], + 'CommodityName' => [ + 'description' => '流量包名称。', + 'type' => 'string', + 'example' => '实人认证流量包', + ], + 'CurrCapacity' => [ + 'description' => '余量。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'CurrProportion' => [ + 'description' => '余量占比。', + 'type' => 'string', + 'example' => '100%', + ], + 'ExpireDate' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '-', + ], + 'InstanceName' => [ + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'tf-testacccn-hangzhouapigate84369', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '-', + ], + 'TakeEffectDate' => [ + 'description' => '生效时间。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"969434DF-926B-4997-9881-4DE94E39F805\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Items\\": [\\n {\\n \\"CommodityName\\": \\"实人认证流量包\\",\\n \\"CurrCapacity\\": 0,\\n \\"CurrProportion\\": \\"0%\\",\\n \\"TotalCapacity\\": 0,\\n \\"UsedCapacity\\": 0,\\n \\"FlowDetails\\": [\\n {\\n \\"Capacity\\": 0,\\n \\"CommodityName\\": \\"实人认证流量包\\",\\n \\"CurrCapacity\\": 0,\\n \\"CurrProportion\\": \\"100%\\",\\n \\"ExpireDate\\": \\"-\\",\\n \\"InstanceName\\": \\"tf-testacccn-hangzhouapigate84369\\",\\n \\"Status\\": \\"-\\",\\n \\"TakeEffectDate\\": \\"-\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '流量包查询', + 'description' => '- 服务地址：cloudauth.aliyuncs.com'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 该接口针对不同的产品方案采用不同的参数，详情请参考[官方文档](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1)。', + ], + 'QueryVerifyInvokeSatistic' => [ + 'summary' => '根据不同的产品方案查询对应产品Code的调用量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '170459', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthV1ZO7W', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StatisticsType', + 'in' => 'query', + 'schema' => [ + 'description' => '统计维度 ：'."\n" + .'- **day**：每天'."\n" + .'- **month**：每月'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1743436800000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1761926399999', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型：'."\n" + .'- **FINANCE_VERIFY**：金融级实人'."\n" + .'- **SMART_VERIFY**：增强版实人认证（已退市）'."\n" + .'- **FACE_VERIFY**：实人认证（已退市）', + 'type' => 'string', + 'required' => false, + 'example' => 'FINANCE_VERIFY', + ], + ], + [ + 'name' => 'SceneIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '应用场景列表', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'ProductProgramList', + 'in' => 'query', + 'schema' => [ + 'description' => '查询产品Code列表，具体请参考对应ProductType下的productCode', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FA2C773-47DB-4156-B1EE-5B047321A939', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Items' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据列表。', + 'type' => 'object', + 'properties' => [ + 'StatisticsDate' => [ + 'description' => '统计日期。', + 'type' => 'string', + 'example' => '2025-10-16', + ], + 'Data' => [ + 'description' => '统计数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StatisticsCount' => [ + 'description' => '统计值的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'StatisticsType' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FA2C773-47DB-4156-B1EE-5B047321A939\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"Items\\": [\\n {\\n \\"StatisticsDate\\": \\"2025-10-16\\",\\n \\"Data\\": [\\n {\\n \\"StatisticsCount\\": \\"3\\",\\n \\"StatisticsType\\": \\"ID_PRO\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '认证调用量统计', + 'description' => '- 请求地址：cloudauth.aliyuncs.com'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + ."\n" + .'> 实人认证产品以CertifyId统计调用量，为了方便对账请在您的系统留存CertifyId字段。', + ], + 'QueryCustomizeFlowStrategy' => [ + 'summary' => '查询安全规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207520', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + 'FEATUREcloudauthDSU9LB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'regionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持**ANT_CLOUD_AUTH**（金融级实人），其他均退市。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<CustomizeFlowStrategyDTO>', + 'description' => 'SingleDataResponse<CustomizeFlowStrategyDTO>', + 'type' => 'object', + 'properties' => [ + 'ResultObject' => [ + 'description' => '处理结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id。', + 'type' => 'string', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => '用户Id。', + 'type' => 'string', + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API名称，同**ProductCode**。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'AccumulateWindow' => [ + 'description' => '流控统计窗口，单位**分钟**。', + 'type' => 'string', + 'example' => '60', + ], + 'AccumulateKey' => [ + 'description' => 'AccumulateKey', + 'type' => 'string', + 'example' => '-', + ], + 'Threshold' => [ + 'description' => '阈值。', + 'type' => 'string', + 'example' => '10', + ], + 'Operation' => [ + 'description' => '操作。', + 'type' => 'string', + 'example' => 'match', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- **disabled**：禁用'."\n" + .'- **normal**：启用', + 'type' => 'string', + 'example' => 'disabled', + ], + 'FlowType' => [ + 'description' => '流程类型：'."\n" + .'- **ACCUMULATE**： 身份证重复出现'."\n" + .'- **PASSED_RATE**： 通过率小于'."\n" + .'- **SUB_CODE_205**：认证不通过且活体攻击205比例大于'."\n" + .'- **SUB_CODE_206**：认证不通过且活体攻击206比例大于', + 'type' => 'string', + 'example' => 'ACCUMULATE', + ], + ], + ], + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": \\"234822\\",\\n \\"UserId\\": \\"126005125163xxxx\\",\\n \\"ApiName\\": \\"ID_PRO\\",\\n \\"AccumulateWindow\\": \\"60\\",\\n \\"AccumulateKey\\": \\"-\\",\\n \\"Threshold\\": \\"10\\",\\n \\"Operation\\": \\"match\\",\\n \\"Status\\": \\"disabled\\",\\n \\"FlowType\\": \\"ACCUMULATE\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '查询安全性规则', + 'description' => '- 服务地址：cloudauth.aliyuncs.com'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 安全规则：保障系统安全性监控规则，例如接口被刷、账号异常盗用等，触发阈值，系统支持进行告警。', + ], + 'DeleteCustomizeFlowStrategy' => [ + 'summary' => '删除自定义流控策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '207420', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthNOQ41U', + 'FEATUREcloudauthGEV2SZ', + 'FEATUREcloudauthKKY1LP', + 'FEATUREcloudauthFO5MJB', + 'FEATUREcloudauthIT1PW0', + 'FEATUREcloudauth434P23', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => '策略id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '38', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'title' => '接口编号', + 'description' => '接口名称，同**ProductCode**。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'regionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持**ANT_CLOUD_AUTH**（金融级实人），其他均退市。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<Integer>', + 'description' => 'SingleDataResponse<Integer>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success'."\n", + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '5A6229C0-E156-48E4-B6EC-0F528BDF60D2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 0,\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"5A6229C0-E156-48E4-B6EC-0F528BDF60D2\\"\\n}","type":"json"}]', + 'title' => '删除自定义流控策略', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'DeleteAllCustomizeFlowStrategy' => [ + 'summary' => '删除所有自定义流控策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '207521', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '126005125163xxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'regionId', + 'description' => 'regionId', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SingleDataResponse<Integer>', + 'description' => 'SingleDataResponse<Integer>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次请求的id。', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\"\\n}","type":"json"}]', + 'title' => '删除所有自定义流控策略', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + ."\n" + .'> 授权key在30分钟内有效，且不可重复使用，建议在每次激活前重新获取。', + ], + 'ModifyCustomizeFlowStrategyList' => [ + 'summary' => '调整自定义流控策略列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209313', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthXA9M4C', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyObject', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'UserId' => [ + 'description' => '用户id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API名称，同**ProductCode**。', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_PRO', + ], + 'AccumulateWindow' => [ + 'description' => '流控统计窗口大小，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + 'Threshold' => [ + 'description' => '流控阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'Operation' => [ + 'description' => '操作。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- **disabled**：禁用'."\n" + .'- **normal**：启用', + 'type' => 'string', + 'required' => true, + 'example' => 'disabled', + ], + 'AccumulateKey' => [ + 'description' => 'AccumulateKey', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'FlowType' => [ + 'description' => '流程类型：'."\n" + .'- **ACCUMULATE**： 身份证重复出现'."\n" + .'- **PASSED_RATE**： 通过率小于'."\n" + .'- **SUB_CODE_205**：认证不通过且活体攻击205比例大于'."\n" + .'- **SUB_CODE_206**：认证不通过且活体攻击206比例大于'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ACCUMULATE', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持**ANT_CLOUD_AUTH**（金融级实人），其他均退市。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Data' => [ + 'description' => '结果数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '调整自定义流控策略列表', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'ModifyControlStrategy' => [ + 'summary' => '调整稳定性告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215262', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ControlStrategyList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '安全告警规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'ApiName' => [ + 'description' => 'API名称，同**ProductCode**。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + 'BizType' => [ + 'description' => '规则配置类型：'."\n" + .'- **QPS**：QPS大于'."\n" + .'- **SUCCESS_RATE_5_MIN**：近5分钟成功率小于'."\n" + .'- **RESP_TIME_5_MIN**：近5分钟平均响应时间大于'."\n" + .'- **AMOUNT_RISE**：调用量环比增长大于'."\n" + .'- **AMOUNT_FALL**：调用量环比降低小于'."\n" + .'- **PASSED_RATE_1_HOUR**：近1小时核验一致率小于'."\n" + .'- **PARAM_ERROR_RATE_1_HOUR**：近1小时参数错误率大于', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS_RATE_5_MIN', + ], + 'Threshold' => [ + 'description' => '规则告警阈值。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.9', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- **disabled**：禁用'."\n" + .'- **normal**：启用'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能接入网关实例的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持**ANT_CLOUD_AUTH**（金融级实人），其他均退市。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Message' => [ + 'description' => '接口调用返回信息。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '调整稳定性告警规则', + 'description' => '- 请求方法：支持以HTTPS POST方法发送请求。'."\n" + .'- 请求地址：cloudauth.aliyuncs.com。', + ], + 'QueryControlStrategy' => [ + 'summary' => '查询稳定性规则列表：通过对服务端初始化InitFaceVerify接口和API集成接口稳定性的监控规则，如果触发阈值，系统支持进行告警。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215261', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '所在地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持ANT_CLOUD_AUTH（金融级实人），其他均退市。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ResultObject' => [ + 'description' => '处理结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => '用户id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126005125163xxxx', + ], + 'ApiName' => [ + 'description' => 'API名称，同认证接口的**ProductCode**。', + 'type' => 'string', + 'example' => 'ID_PRO', + ], + 'BizType' => [ + 'description' => '规则配置类型：'."\n" + .'- **QPS**：QPS大于'."\n" + .'- **SUCCESS_RATE_5_MIN**：近5分钟成功率小于'."\n" + .'- **RESP_TIME_5_MIN**：近5分钟平均响应时间大于'."\n" + .'- **AMOUNT_RISE**：调用量环比增长大于'."\n" + .'- **AMOUNT_FALL**：调用量环比降低小于'."\n" + .'- **PASSED_RATE_1_HOUR**：近1小时核验一致率小于'."\n" + .'- **PARAM_ERROR_RATE_1_HOUR**：近1小时参数错误率大于', + 'type' => 'string', + 'example' => 'SUCCESS_RATE_5_MIN', + ], + 'Threshold' => [ + 'description' => '规则配置告警阈值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.9', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- **disabled**：禁用'."\n" + .'- **normal**：启用', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"Success\\",\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"UserId\\": 0,\\n \\"ApiName\\": \\"ID_PRO\\",\\n \\"BizType\\": \\"SUCCESS_RATE_5_MIN\\",\\n \\"Threshold\\": 0.9,\\n \\"Status\\": \\"normal\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询稳定性告警规则', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 请求地址：cloudauth.aliyuncs.com。'."\n", + ], + 'DeleteControlStrategy' => [ + 'summary' => '删除稳定性告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215260', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + 'FEATUREcloudauthA9Y5H0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '区域Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '安全规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'API名称，同**ProductCode**。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_PRO', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，目前仅支持**ANT_CLOUD_AUTH**（金融级实人），其他均退市。', + 'type' => 'string', + 'required' => false, + 'example' => 'ANT_CLOUD_AUTH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D6C1237B-D34B-5126-93AC-36A4B9E819C6', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6C1237B-D34B-5126-93AC-36A4B9E819C6\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => '删除稳定性告警规则', + 'description' => '请求方法：支持以HTTPS POST方法发送请求。'."\n" + .'请求地址：cloudauth.aliyuncs.com。', + ], + 'ModifyBlackListStrategy' => [ + 'summary' => '新增或修改黑名单规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214006', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '所在地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'BlackListStrategy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '黑名单规则。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id：'."\n" + .'- **为空**：新增规则'."\n" + .'- **不为空**：修改规则', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + 'ProductName' => [ + 'description' => '产品名称：'."\n" + .'- **id2meta**：身份证二要素核验'."\n" + .'- **mobile3Meta**：手机号要素核验'."\n" + .'- **bankcardMeta**：银行卡要素核验'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id2meta', + ], + 'BizKey' => [ + 'description' => '名单类型：'."\n" + .'- **mobile**：手机号黑名单'."\n" + .'- **ip**：IP黑名单'."\n" + .'- **identifyNum**：身份证黑名单'."\n" + .'- **bankCard**：银行卡黑名单'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + 'BizContent' => [ + 'description' => '黑名单列表字符串，各黑名单之间用逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1,127.0.0.2', + ], + 'Status' => [ + 'description' => '认证状态：'."\n" + .'- **1**: 认证通过。'."\n" + .'- **2**: 认证不通过。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '{\'StatusCode\': -1}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Data\\": 0\\n}","type":"json"}]', + 'title' => '新增或修改黑名单规则', + 'description' => '- 服务地址：cloudauth.aliyuncs.com。'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + .'- 接口说明：新增或修改黑名单规则。'."\n", + ], + 'QueryBlackListStrategy' => [ + 'summary' => '查询黑名单配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214008', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '所在地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260', + ], + 'Code' => [ + 'description' => '返回码，**200**表示接口响应成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234822', + ], + 'UserId' => [ + 'description' => '用户id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12600512xxxxxxxx', + ], + 'ProductName' => [ + 'description' => '产品名称：'."\n" + .'- id2meta：身份证二要素核验'."\n" + .'- mobile3Meta：手机号要素核验'."\n" + .'- bankcardMeta：银行卡要素核验', + 'type' => 'string', + 'example' => 'id2meta', + ], + 'BizKey' => [ + 'description' => '名单类型：'."\n" + .'- mobile：手机号黑名单'."\n" + .'- ip：IP黑名单'."\n" + .'- identifyNum：身份证黑名单'."\n" + .'- bankCard：银行卡黑名单'."\n", + 'type' => 'string', + 'example' => 'identifyNum', + ], + 'BizContent' => [ + 'description' => '黑名单列表字符串，各黑名单之间用**逗号**分隔。', + 'type' => 'string', + 'example' => '127.0.0.1,127.0.0.2', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- **disabled**：禁用'."\n" + .'- **normal**：启用', + 'type' => 'string', + 'example' => 'disabled', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711533786000', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8FC3D6AC-9FED-4311-8DA7-C4BF47D9F260\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": [\\n {\\n \\"Id\\": 234822,\\n \\"UserId\\": 0,\\n \\"ProductName\\": \\"id2meta\\",\\n \\"BizKey\\": \\"identifyNum\\",\\n \\"BizContent\\": \\"127.0.0.1,127.0.0.2\\",\\n \\"Status\\": \\"disabled\\",\\n \\"GmtModified\\": 1711533786000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询黑名单规则', + 'description' => '- 请求地址：cloudauth.aliyuncs.com'."\n" + .'- 请求方法：HTTPS POST和GET。'."\n" + ."\n" + .'> 支持对于IP、身份证号、手机号、银行卡号等设置黑名单，当命中黑名单时，系统拒绝请求，返回固定错误码'."\n" + .'支持对于IP、身份证号、手机号、银行卡号等设置黑名单，当命中黑名单时，系统拒绝请求，返回固定错误码'."\n", + ], + 'DeleteBlackListStrategy' => [ + 'summary' => '删除黑名单规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '214004', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthZN5W38', + 'FEATUREcloudauth883TGF', + 'FEATUREcloudauthPZCZ2I', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '所在地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '38', + ], + ], + [ + 'name' => 'ProductName', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称：'."\n" + .'- **id2meta**：身份证二要素核验'."\n" + .'- **mobile3Meta**：手机号要素核验'."\n" + .'- **bankcardMeta**：银行卡要素核验'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'id2meta', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": 1\\n}","type":"json"}]', + 'title' => '删除黑名单规则', + 'description' => '请求方法：仅支持以HTTPS POST方法发送请求。', + ], + 'DescribeInfoCheckExportRecord' => [ + 'summary' => '分页查新信息核验导出任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '205575', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthGDLZVA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测'."\n" + .' -**VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'required' => false, + 'example' => 'ID_CARD_2_META', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-11 21:24:48', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-10-11 21:24:48', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '当前查询页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数目。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码：200为成功，其他为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误代码。', + 'type' => 'string', + 'example' => 'success', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CurrentPage' => [ + 'description' => '当前查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadTaskId' => [ + 'description' => '下载任务的id。', + 'type' => 'string', + 'example' => '202510189017278', + ], + 'Status' => [ + 'description' => '任务状态：'."\n" + .'- **1**：文件生成中'."\n" + .'- **2**: 文件生成完成'."\n" + .'- **3**: 文件生成失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Url' => [ + 'description' => '任务URL。', + 'type' => 'string', + 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxxxx.xlsx', + ], + 'DownloadDate' => [ + 'description' => '下载日期。', + 'type' => 'string', + 'example' => '1758250979000', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '-', + ], + 'ProductType' => [ + 'description' => '产品类型名称：'."\n" + .'- **ID_CARD_2_META**：身份证二要素'."\n" + .'- **ID_PERIOD**：身份证有效核验期'."\n" + .'- **MOBILE_ONLINE_LENGTH**：手机在网时长'."\n" + .'- **MOBILE_ONLINE_STATUS**：手机在网状态'."\n" + .'- **MOBILE_3_META_SIMPLE**：手机号三要素简版'."\n" + .'- **MOBILE_3_META**：手机号三要素详版'."\n" + .'- **MOBILE_2_META**：手机号二要素'."\n" + .'- **BANK_CARD_N_META**：银行卡验证详版'."\n" + .'- **MOBILE_DETECT**：号码检测'."\n" + .' -**VEHICLE_N_META**：车辆要素核验增强版'."\n" + .'- **VEHICLE_PENTA_INFO**：车五项信息识别'."\n" + .'- **VEHICLE_LICENSE_INFO**：车辆信息识别'."\n" + .'- **VEHICLE_INSURE_DATE**：车辆投保日期查询'."\n" + .'- **VEHICLE_CHECK**：车辆要素核验', + 'type' => 'string', + 'example' => '身份证二要素', + ], + 'FileType' => [ + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'CSV', + ], + 'FileName' => [ + 'description' => '文件名。', + 'type' => 'string', + 'example' => '手机号二要素统计202509013975081.csv', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 3,\\n \\"CurrentPage\\": 1,\\n \\"Items\\": [\\n {\\n \\"DownloadTaskId\\": \\"202510189017278\\",\\n \\"Status\\": 1,\\n \\"Url\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxxxx.xlsx\\",\\n \\"DownloadDate\\": \\"1758250979000\\",\\n \\"ErrorCode\\": \\"-\\",\\n \\"ProductType\\": \\"身份证二要素\\",\\n \\"FileType\\": \\"CSV\\",\\n \\"FileName\\": \\"手机号二要素统计202509013975081.csv\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查新信息核验导出任务', + 'description' => '请求方法：支持以HTTPS POST和GET方法发送请求。', + ], + 'DescribeOssStatusV2' => [ + 'summary' => '查询用户OSS状态V2版。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCPTLY3', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ServiceCode', + 'in' => 'query', + 'schema' => [ + 'description' => '实人云产品的ServiceCode：'."\n" + .'- **antcloudauth**：金融级实人认证'."\n" + .'- **cloudauthst（已退市）**：实人认证增强版', + 'type' => 'string', + 'required' => false, + 'example' => 'antcloudauth', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者源ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '120.25.41.25', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'ResultObject' => [ + 'description' => '返回的结果信息。', + 'type' => 'object', + 'properties' => [ + 'UserStatus' => [ + 'description' => '用户开通状态，**SUCCESS**为已开通。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou-aliyun-cloudauth-20250516xxxxxx', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'Code' => [ + 'description' => '返回码', + 'type' => 'string', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功响应。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"ResultObject\\": {\\n \\"UserStatus\\": \\"SUCCESS\\",\\n \\"BucketName\\": \\"cn-hangzhou-aliyun-cloudauth-20250516xxxxxx\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询用户OSS状态V2版', + 'description' => '- 请求方法：支持以HTTPS POST和GET方法发送请求。'."\n" + .'- 服务地址：cloudauth.aliyuncs.com。'."\n", + ], + 'DescribeAuthVerify' => [ + 'summary' => '获取OCR结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => ' '."\n" + .'100000****', + ], + ], + [ + 'name' => 'CertifyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实人认证唯一标识。'."\n" + .'该值需要调用InitAuthVerify-发起OCR请求获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'shsf57a4e0d9981c3bd66dc754f3d3cd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Result' => [ + 'description' => '结果', + 'type' => 'object', + 'properties' => [ + 'SubCode' => [ + 'description' => '结果描述。', + 'type' => 'string', + 'example' => '200', + ], + 'MaterialInfo' => [ + 'description' => '- OCR读取的卡证信息（ocrIdCardInfo）'."\n" + .'- 客户端编辑后的卡证信息照片（ocrIdEditInfo）'."\n" + .'- OCR照片的OSS存储位置及链接（ocrPictureFront）', + 'type' => 'string', + 'example' => '"ocrIdCardInfo": {'."\n" + .' "certName": "张先生",'."\n" + .' "sex": "男",'."\n" + .' "nationality": "汉",'."\n" + .' "birth": "20010213",'."\n" + .' "address": "XXX省XX市XXX区XX街道X号",'."\n" + .' "certNo": "4****************X",'."\n" + .' "authority": "XXX公安局XXX分局",'."\n" + .' "startDate": "20250523",'."\n" + .' "endDate": "20450523"'."\n" + .' },'."\n" + .'"ocrIdEditInfo": {'."\n" + .' "certName": "张先生",'."\n" + .' "sex": "男",'."\n" + .' "nationality": "汉",'."\n" + .' "birth": "20010213",'."\n" + .' "address": "XXX省XX市XXX区XX街道X号",'."\n" + .' "certNo": "4****************X",'."\n" + .' "authority": "XXX公安局XXX分局",'."\n" + .' "startDate": "20250523",'."\n" + .' "endDate": "20450523"'."\n" + .' },'."\n" + .' "ocrPictureFront": {'."\n" + .' "ossBucketName": "cn-shanghai-aliyun-cloudauth-12********",'."\n" + .' "ossIdFaceObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridface_b749.jpeg",'."\n" + .' "ossIdFaceUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridface_b749.jpeg?security-token=CAISjdfgeJ1q6F...",'."\n" + .' "ossIdNationalEmblemObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridnationalemblem_a3hf.jpeg",'."\n" + .' "ossIdNationalEmblemUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridnationalemblem_a3hf.jpeg?security-token=CAISjgJ1q6..."'."\n" + .' }', + ], + 'SpoofInfo' => [ + 'description' => '证件正面防伪检测结果，包括风险判定结果和风险类型：'."\n" + .'> - '."\n" + .'仅当Initialize接口中 IdSpoof = Y 才会开启卡证正面防伪检测。否则 spoofRiskResult 默认返回N，spoofType 为空。'."\n" + ."\n" + .'spoofRiskResult：'."\n" + .'- Y：存在风险'."\n" + .' - N：无风险'."\n" + ."\n" + .'spoofType：'."\n" + .'- SCREEN_REMARK：翻拍'."\n" + .'- PHOTO_COPY：复印件'."\n" + .'- TAMPER：PS篡改'."\n" + ."\n" + .'> - 算法预测结果，该字段可能无法返回，建议业务上避免设置必要依赖', + 'type' => 'string', + 'example' => 'spoofRiskResult：Y'."\n" + .'spoofType：SCREEN_REMARK', + ], + 'SpoofBackInfo' => [ + 'description' => '证件反面防伪检测结果，包括风险判定结果和风险类型：'."\n" + .'> - '."\n" + .'仅当Initialize接口中 IdSpoof = Y 才会开启卡证正面防伪检测。否则 spoofRiskResult 默认返回N，spoofType 为空。'."\n" + ."\n" + .'spoofRiskResult：'."\n" + .'- Y：存在风险'."\n" + .' - N：无风险'."\n" + ."\n" + .'spoofType：'."\n" + .'- SCREEN_REMARK：翻拍'."\n" + .'- PHOTO_COPY：复印件'."\n" + .'- TAMPER：PS篡改'."\n" + ."\n" + .'> - 算法预测结果，该字段可能无法返回，建议业务上避免设置必要依赖', + 'type' => 'string', + 'example' => 'spoofRiskResult：Y'."\n" + .'spoofType：SCREEN_REMARK', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Result\\": {\\n \\"SubCode\\": \\"200\\",\\n \\"MaterialInfo\\": \\"\\\\\\"ocrIdCardInfo\\\\\\": {\\\\n \\\\\\"certName\\\\\\": \\\\\\"张先生\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"nationality\\\\\\": \\\\\\"汉\\\\\\",\\\\n \\\\\\"birth\\\\\\": \\\\\\"20010213\\\\\\",\\\\n \\\\\\"address\\\\\\": \\\\\\"XXX省XX市XXX区XX街道X号\\\\\\",\\\\n \\\\\\"certNo\\\\\\": \\\\\\"4****************X\\\\\\",\\\\n \\\\\\"authority\\\\\\": \\\\\\"XXX公安局XXX分局\\\\\\",\\\\n \\\\\\"startDate\\\\\\": \\\\\\"20250523\\\\\\",\\\\n \\\\\\"endDate\\\\\\": \\\\\\"20450523\\\\\\"\\\\n },\\\\n\\\\\\"ocrIdEditInfo\\\\\\": {\\\\n \\\\\\"certName\\\\\\": \\\\\\"张先生\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"nationality\\\\\\": \\\\\\"汉\\\\\\",\\\\n \\\\\\"birth\\\\\\": \\\\\\"20010213\\\\\\",\\\\n \\\\\\"address\\\\\\": \\\\\\"XXX省XX市XXX区XX街道X号\\\\\\",\\\\n \\\\\\"certNo\\\\\\": \\\\\\"4****************X\\\\\\",\\\\n \\\\\\"authority\\\\\\": \\\\\\"XXX公安局XXX分局\\\\\\",\\\\n \\\\\\"startDate\\\\\\": \\\\\\"20250523\\\\\\",\\\\n \\\\\\"endDate\\\\\\": \\\\\\"20450523\\\\\\"\\\\n },\\\\n \\\\\\"ocrPictureFront\\\\\\": {\\\\n \\\\\\"ossBucketName\\\\\\": \\\\\\"cn-shanghai-aliyun-cloudauth-12********\\\\\\",\\\\n \\\\\\"ossIdFaceObjectName\\\\\\": \\\\\\"verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridface_b749.jpeg\\\\\\",\\\\n \\\\\\"ossIdFaceUrl\\\\\\": \\\\\\"http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridface_b749.jpeg?security-token=CAISjdfgeJ1q6F...\\\\\\",\\\\n \\\\\\"ossIdNationalEmblemObjectName\\\\\\": \\\\\\"verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridnationalemblem_a3hf.jpeg\\\\\\",\\\\n \\\\\\"ossIdNationalEmblemUrl\\\\\\": \\\\\\"http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridnationalemblem_a3hf.jpeg?security-token=CAISjgJ1q6...\\\\\\"\\\\n }\\",\\n \\"SpoofInfo\\": \\"spoofRiskResult：Y\\\\nspoofType：SCREEN_REMARK\\",\\n \\"SpoofBackInfo\\": \\"spoofRiskResult：Y\\\\nspoofType：SCREEN_REMARK\\"\\n }\\n}","type":"json"}]', + 'title' => '获取OCR结果', + ], + 'InitAuthVerify' => [ + 'summary' => '发起OCR请求。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcloudauthCW0JNH', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '认证场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000002996', + ], + ], + [ + 'name' => 'OuterOrderNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '您自定义的业务唯一标识，用于后续定位排查问题使用。'."\n" + ."\n" + .'支持使用英文字母（包含大小写）、数字，最长不超过32个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '要接入的产品方案。取值：ID_OCR。', + 'type' => 'string', + 'required' => true, + 'example' => 'ID_OCR', + ], + ], + [ + 'name' => 'MetaInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => 'MetaInfo环境参数，需要通过客户端SDK获取。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "zimVer": "3.0.0",'."\n" + .' "appVersion": "1",'."\n" + .' "bioMetaInfo": "4.1.0:1150****,0",'."\n" + .' "appName": "com.aliyun.antcloudauth",'."\n" + .' "deviceType": "ios",'."\n" + .' "osVersion": "iOS 10.3.2",'."\n" + .' "apdidToken": "",'."\n" + .' "deviceModel": "iPhone9,1"'."\n" + .'}', + ], + ], + [ + 'name' => 'CardType', + 'in' => 'formData', + 'schema' => [ + 'description' => '证件类型，取值：IDENTITY_CARD。', + 'type' => 'string', + 'required' => true, + 'example' => 'IDENTITY_CARD', + ], + ], + [ + 'name' => 'IdSpoof', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启证件防伪检测功能：'."\n" + .'- Y：开启'."\n" + .'- N：关闭（默认）', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OCR结果的回调通知地址，回调请求方式默认为GET，回调地址必须以https开头，完成OCR识别后会回调该地址，并自动添加certifyId和subcode字段。'."\n" + .'警告'."\n" + .'- 此值的传入会在调用接口前做可访问校验，如果传入的地址不能在公网访问，会返回400。'."\n" + .'- 回调会在OCR识别调用完成后立即执行，但可能会因为网络等原因延迟，建议您优先接收客户端侧的请求完成通知，再请求查询接口获取结果详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com?callbackToken=100000****&certifyId=shaxxxx&subCode=200', + ], + ], + [ + 'name' => 'CallbackToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '安全Token，由您自行生成，用于防重复、防篡改校验。'."\n" + .'如果设置了此值，将会在CallbackUrl回调时携带CallbackToken字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'NMjvQanQgplBSaEI0sL86WnQplB', + ], + ], + [ + 'name' => 'CardPageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SDK采集卡证页数：'."\n" + .'- “1”：采集正面'."\n" + .'- “2”：采集正反两面', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DocScanMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'OCR证件扫描模式：'."\n" + .'- shoot（默认）：拍照'."\n" + .'- scan：扫描'."\n" + .'- auto：拍照/扫描自动切换', + 'type' => 'string', + 'required' => false, + 'example' => 'shoot', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B506328A-D84B-4750-82C7-6A207C585CF1', + ], + 'Result' => [ + 'description' => '结果', + 'type' => 'object', + 'properties' => [ + 'CertifyId' => [ + 'description' => '核验请求ID，核验服务认证请求的唯一标识。'."\n" + .'查询认证结果时，必须传入认证请求ID。', + 'type' => 'string', + 'example' => 'shif9d1a185b8dde7cd07bf0943a448b', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"B506328A-D84B-4750-82C7-6A207C585CF1\\",\\n \\"Result\\": {\\n \\"CertifyId\\": \\"shif9d1a185b8dde7cd07bf0943a448b\\"\\n }\\n}","type":"json"}]', + 'title' => '发起OCR请求', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cloudauth.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cloudauth.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'cloudauth.aliyuncs.com', + ], + ], +]; |