'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种。