'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Cloudauth-intl', 'version' => '2022-08-09', ], 'directories' => [ [ 'id' => 349786, 'title' => '通用', 'type' => 'directory', 'children' => [ 'Initialize', 'CheckResult', ], ], [ 'id' => 182315, 'title' => '实人认证', 'type' => 'directory', 'children' => [ 'EkycVerify', ], ], [ 'id' => 349787, 'title' => '人脸检测', 'type' => 'directory', 'children' => [ 'FaceLiveness', 'FaceDuplicationCheckIntl', 'DeepfakeDetectIntlStream', 'DeepfakeDetectIntl', 'FaceGuardRisk', 'FaceCompare', 'FaceCrossCompareIntl', ], ], [ 'id' => 207369, 'title' => '证件识别', 'type' => 'directory', 'children' => [ 'DocOcrMax', 'DocOcr', ], ], [ 'id' => 207370, 'title' => '信息核验', 'type' => 'directory', 'children' => [ 'Id2MetaVerifyIntl', 'Id2MetaPeriodVerifyIntl', 'BankMetaVerifyIntl', 'Mobile2MetaVerifyIntl', 'Mobile3MetaVerifyIntl', ], ], [ 'id' => 207371, 'title' => '凭证检测', 'type' => 'directory', 'children' => [ 'CredentialRecognitionIntl', 'CredentialSubmitIntl', 'CredentialGetResultIntl', 'CredentialVerifyIntl', ], ], [ 'id' => 236783, 'title' => '地址核验', 'type' => 'directory', 'children' => [ 'AddressVerifyV2Intl', 'AddressCompareIntl', ], ], [ 'id' => 187491, 'title' => '辅助接口', 'type' => 'directory', 'children' => [ 'KeepaliveIntl', 'DeleteVerifyResult', 'CheckVerifyLog', ], ], [ 'id' => 280922, 'title' => '控制台', 'type' => 'directory', 'children' => [ 'AddFaceRecord', 'DownloadVerifyRecordIntl', 'QueryFaceGroup', 'ModifyFaceGroup', 'DeleteFaceGroup', 'QueryFaceRecord', 'ModifyFaceRecord', 'DeleteFaceRecord', 'TempOssUrlIntl', 'TempAccessTokenIntl', ], ], [ 'id' => 349794, 'title' => '已废弃', 'type' => 'directory', 'children' => [ 'CardOcr', 'FraudResultCallBack', 'AddressVerifyIntl', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'Initialize' => [ 'summary' => '初始化。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149600', 'abilityTreeNodes' => [ 'FEATUREcloudauthCW0JNH', 'FEATUREcloudauth6RJHVQ', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '要接入的产品方案'."\n" .'>具体详见官方文档 ：https://www.alibabacloud.com/help/zh/ekyc/latest/product-introduction?spm=a2c63.p38356.0.i1', 'type' => 'string', 'required' => false, 'example' => 'eKYC', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一。', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', ], ], [ 'name' => 'MetaInfo', 'in' => 'query', 'schema' => [ 'description' => 'Metainfo环境参数，需要通过客户端SDK获取。', 'type' => 'string', 'required' => false, 'example' => '{\\"bioMetaInfo\\":\\"4.1.0:2916352,0\\",\\"deviceType\\":\\"web\\",\\"ua\\":\\"Mozilla/5.0 (Macintosh', ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '证件类型'."\n" .'>eKYC_PRO和ID_OCR_MAX方案,详见官方文档 https://www.alibabacloud.com/help/zh/ekyc/latest/certificate-code-table?spm=a2c63.p38356.help-menu-445633.d_2_8_2_0.279147abwKAWbr'."\n" ."\n" .'>ID_OCR,eKYC和eYKC_MIN方案,相见官方文档 证件类型列表 https://www.alibabacloud.com/help/zh/ekyc/latest/gnhekqy05ni51m4c?spm=a2c63.p38356.help-menu-445633.d_2_3_1_0_0_0.6243244777KoZ7', 'type' => 'string', 'required' => false, 'example' => '00000001'."\n", ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '您自定义的用户ID，或者其他可以识别特定用户的标识，例如手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。', 'type' => 'string', 'required' => false, 'example' => '1221****6543', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => '场景码。（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => '123****123', ], ], [ 'name' => 'Pages', 'in' => 'query', 'schema' => [ 'description' => '采集页配置，多页使用,连接。取值范围：'."\n" .'- **01**：证件人像面'."\n" ."\n" .'- **01,02**：证件人像面与背面'."\n" ."\n" .'> 此值传入01,02时，目前仅支持中国身份证和越南身份证。', 'type' => 'string', 'required' => false, 'example' => '01', ], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '照片Base64编码。如果您选择FacePictureBase64方式传入人脸照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'Base64', ], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人脸照片地址。公网可访问的HTTP、HTTPS链接', 'type' => 'string', 'required' => false, 'example' => '***', ], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => [ 'description' => '是否裁剪。（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => [ 'description' => '是否开启OCR。（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => [ 'description' => '人脸图片质量。（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'IdSpoof', 'in' => 'query', 'schema' => [ 'description' => '是否启用证书防伪检测。（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'ReturnUrl', 'in' => 'query', 'schema' => [ 'description' => '端侧回调地址。', 'type' => 'string', 'required' => false, 'example' => 'http*****', ], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => [ 'description' => '是否开启身份权威核验，目前仅适用于中国大陆二代身份证（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'Y', ], ], [ 'name' => 'DocScanMode', 'in' => 'query', 'schema' => [ 'description' => '证件采集拍照模式。'."\n" ."\n" .'- manual：手动拍照。'."\n" .'- auto：自动拍照（默认）', 'type' => 'string', 'required' => false, 'example' => 'manual', ], ], [ 'name' => 'ProductFlow', 'in' => 'query', 'schema' => [ 'description' => '支持卡证和人脸顺序编排：'."\n" ."\n" .'- DOC_FACE（默认）'."\n" .'- FACE_DOC'."\n" ."\n" .'注：只有当ProductCode为KYC_GLOBAL需传', 'type' => 'string', 'required' => false, 'example' => 'DOC_FACE', ], ], [ 'name' => 'CallbackUrl', 'in' => 'query', 'schema' => [ 'description' => '认证结果的回调通知地址，回调请求方式默认为GET，回调地址必须以https开头。平台在完成认证后会回调该地址，并自动添加transactionId、passed和subcode字段。', 'type' => 'string', 'required' => false, 'example' => 'https://www.aliyun.com?callbackToken=1000004826&transactionId=shaxxxx&passed=Y&subCode=200', ], ], [ 'name' => 'CallbackToken', 'in' => 'query', 'schema' => [ 'description' => '安全Token，用于防重复、防篡改校验。如果传入该参数会在回调地址显示CallbackToken字段。', 'type' => 'string', 'required' => false, 'example' => '7ca5c68d869344ea8eeb30cdfd544544-6358700', ], ], [ 'name' => 'LanguageConfig', 'in' => 'query', 'schema' => [ 'description' => '语言配置（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => 'en', ], ], [ 'name' => 'SecurityLevel', 'in' => 'query', 'schema' => [ 'description' => '代表认证流程不同安全水位的模式，可选值：'."\n" ."\n" .'01：普通模式（默认）。'."\n" .'02：安全模式，相对严格的模式，可用于高风险场景（IDV产品入参）', 'type' => 'string', 'required' => false, 'example' => '01', ], ], [ 'name' => 'StyleConfig', 'in' => 'query', 'schema' => [ 'description' => '自定义UI配置。根据配置模板，将您自定义的UI配置转换为JSON字符串后，通过该接口传入实现。更多信息，请参见[IDV UI样式自定义](https://www.alibabacloud.com/help/zh/ekyc/latest/idv-kyc-custom-skin?spm=a2c63.p38356.0.i60)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "guidepage:": {****}, '."\n" .' "ocrPage": {****},'."\n" .' "ocrResultPage": [****],'."\n" .' "facePage": {****},'."\n" .'}', ], ], [ 'name' => 'ExperienceCode', 'in' => 'query', 'schema' => [ 'description' => '体验码', 'type' => 'string', 'required' => false, 'example' => '9be7b7d0180041219e5ab03ac6dab5fb', ], ], [ 'name' => 'DocVideo', 'in' => 'query', 'schema' => [ 'description' => '是否需要存证视频。'."\n" ."\n" .'- N：不需要（默认）。'."\n" ."\n" .'- Y：认证过程中会同时采集用户的刷脸过程视频（1~2s视频文件），并通过查询接口返回。'."\n" ."\n" .'> 因为视频文件较大，当网络不稳定时系统会丢弃视频文件，优先保障认证必要图片传输。', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => [ 'description' => '要进行活体检测的类型：'."\n" ."\n" .'- **LIVENESS**（默认）：眨眼动作活体检测。'."\n" ."\n" .'- **PHOTINUS_LIVENESS**：眨眼动作活体+炫彩活体双重检测。'."\n" ."\n" .'> '."\n" .'> - 支持集成的SDK版本，请参见[SDK发布记录](https://www.alibabacloud.com/help/zh/ekyc/latest/sdk-publishing-record?spm=a2c63.p38356.0.i99)。'."\n" .'> - PC端不支持炫彩活体双重检测。', 'type' => 'string', 'required' => false, 'example' => 'PHOTINUS_LIVENESS', ], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => [ 'description' => '自定义OCR质量检测阈值模式：'."\n" .'- **0**：标准模式'."\n" .'- **1**：严格模式'."\n" .'- **2**：宽松模式'."\n" .'- **3**（默认）：关闭质量检测', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'ShowAlbumIcon', 'in' => 'query', 'schema' => [ 'description' => '证件OCR识别环节，是否展示相册上传入口：'."\n" ."\n" .'- **1**：展示（默认）'."\n" ."\n" .'- **0**：不展示', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ShowOcrResult', 'in' => 'query', 'schema' => [ 'description' => '证件OCR识别环节，是否展示识别结果页：'."\n" ."\n" .'- **1**：展示（默认）'."\n" ."\n" .'- **0**：不展示', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ShowGuidePage', 'in' => 'query', 'schema' => [ 'description' => '是否展示引导页面开关：'."\n" ."\n" .'- **1**：展示（默认）'."\n" ."\n" .'- **0**：不展示', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ProcedurePriority', 'in' => 'query', 'schema' => [ 'description' => '当移动端H5方式认证出现兼容性问题时，是否允许展示降级的处理方式。'."\n" ."\n" .'- **url（默认）**：支持降级。页面展示认证URL，用户可复制URL打开或者切换浏览器继续认证。'."\n" ."\n" .'- **keep**：不支持降级。直接返回错误原因，并结束认证流程。'."\n" ."\n\n" .'> '."\n" .'> - PC端不支持此开关。'."\n" .'> - 若业务应用场景为App内嵌网页完成认证，建议此参数设置为keep，不允许降级URL。', 'type' => 'string', 'required' => false, 'example' => 'url', ], ], [ 'name' => 'AppQualityCheck', 'in' => 'query', 'schema' => [ 'description' => '该功能**Web SDK**暂不支持，如需使用请参考App SDK接入。'."\n" ."\n" .'是否开启人脸严格质量检测：'."\n" .'- Y：开启（默认）'."\n" .'- N：不开启', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'DocPageConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '客户自定义传入是否要采集更多页面', 'type' => 'array', 'items' => [ 'description' => '采集面', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_BACK', ], 'required' => false, ], ], [ 'name' => 'MRTDInput', 'in' => 'query', 'schema' => [ 'description' => 'MRTD校验参数输入来源。NFC读取证件芯片信息时依赖该参数解密信息。'."\n" ."\n" .'- **0**：用户输入'."\n" ."\n" .'- **1**：ocr读取'."\n" ."\n" .'- **2**：接口传入', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'DocumentNumber', 'in' => 'query', 'schema' => [ 'description' => '证件号'."\n" ."\n" .'**MRTDInput = 2**时，必传。', 'type' => 'string', 'required' => false, 'example' => '-', ], ], [ 'name' => 'DateOfBirth', 'in' => 'query', 'schema' => [ 'description' => '证件上的出生日期'."\n" ."\n" .'**MRTDInput = 2**时，必传。', 'type' => 'string', 'required' => false, 'example' => '-', ], ], [ 'name' => 'DateOfExpiry', 'in' => 'query', 'schema' => [ 'description' => '证件上的过期时间'."\n" ."\n" .'**MRTDInput** = 2时，必传。', 'type' => 'string', 'required' => false, 'example' => '-', ], ], [ 'name' => 'UseNFC', 'in' => 'query', 'schema' => [ 'description' => '当**DocType**=01000000（全球护照）时，可选是否启用NFC验证。'."\n" .'- **Y**（启用）'."\n" .'- **N**（不启用）', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'ChameleonFrameEnable', 'in' => 'query', 'schema' => [ 'description' => '是否开启自适应变色窗口边框'."\n" .'- **Y**：开启'."\n" .'- **N**：不开启', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => [ 'description' => '用户的证件号码。', 'type' => 'string', 'required' => false, 'example' => '411xxxxxxxxxxx0001', ], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => [ 'description' => '用户的真实姓名。', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], [ 'name' => 'EditOcrResult', 'in' => 'query', 'schema' => [ 'description' => '证件OCR识别环节，识别结果页是否可编辑：'."\n" ."\n" .'- **0**：不可编辑'."\n" ."\n" .'- **1**（默认）：可编辑', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'VerifyModel', 'in' => 'query', 'schema' => [ 'title' => '验证的类型', 'description' => '验证的类型', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FaceGroupCodes', 'in' => 'query', 'schema' => [ 'title' => '需要比对的人脸库', 'description' => '需要比对的人脸库', 'type' => 'string', 'required' => false, 'example' => '0e0c34a77f', ], ], [ 'name' => 'TargetFacePicture', 'in' => 'query', 'schema' => [ 'title' => '人像照片Base64编码。', 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => [ 'title' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxxxx.com/1.jpg', ], ], [ 'name' => 'AutoRegistration', 'in' => 'query', 'schema' => [ 'title' => '是否开启自动注册', 'description' => '是否开启自动注册', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'query', 'schema' => [ 'title' => '注册人脸库。', 'description' => '注册人脸库。', 'type' => 'string', 'required' => false, 'example' => '0e0c34a77f', ], ], [ 'name' => 'SaveFacePicture', 'in' => 'query', 'schema' => [ 'title' => '是否保存人脸图片', 'description' => '是否保存人脸图片', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'query', 'schema' => [ 'title' => '人脸验证阈值', 'description' => '人脸验证阈值', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], [ 'name' => 'ReturnFaces', 'in' => 'query', 'schema' => [ 'title' => '返回重复人脸数量', 'description' => '返回重复人脸数量', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => [ 'type' => 'string', '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证ID', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', ], 'ClientCfg' => [ 'description' => '客户端配置', 'type' => 'string', 'example' => '***', ], 'TransactionUrl' => [ 'description' => 'Web认证Url', 'type' => 'string', 'example' => 'http****', ], 'Protocol' => [ 'description' => '认证标准加密协议。'."\n" ."\n" .'> H5网页接入，选择iframe内嵌集成时依赖该字段。', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d*********', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"ClientCfg\\": \\"***\\",\\n \\"TransactionUrl\\": \\"http****\\",\\n \\"Protocol\\": \\"hksb7ba1b28130d24e015d*********\\"\\n }\\n}","type":"json"}]', 'title' => '认证初始化', ], 'CheckResult' => [ 'summary' => '查询认证结果。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '149753', 'abilityTreeNodes' => [ 'FEATUREcloudauthCS0SDG', ], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一。', 'type' => 'string', 'required' => false, 'example' => 'djs20d***9-dsskc', ], ], [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => [ 'description' => '认证ID。', 'type' => 'string', 'required' => false, 'example' => '4ab0b***cbde97', ], ], [ 'name' => 'IsReturnImage', 'in' => 'query', 'schema' => [ 'description' => '是否返回图片。'."\n" .'- Y：返回'."\n" .'- N：不返回', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], [ 'name' => 'ExtraImageControlList', 'in' => 'query', 'schema' => [ 'description' => '返回附加信息。', 'type' => 'string', 'required' => false, 'example' => '***', ], ], [ 'name' => 'ReturnFiveCategorySpoofResult', 'in' => 'query', 'schema' => [ 'description' => '是否返回防伪检测结果。', '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'EkycResult' => [ 'description' => '认证结果。', 'type' => 'string', 'example' => '**', ], 'ExtBasicInfo' => [ 'description' => '扩展基础信息。', 'type' => 'string', 'example' => '**', ], 'ExtFaceInfo' => [ 'description' => '人脸信息。', 'type' => 'string', 'example' => '**', ], 'ExtIdInfo' => [ 'description' => 'ID信息。', 'type' => 'string', 'example' => '**', ], 'ExtRiskInfo' => [ 'description' => '风险信息。', 'type' => 'string', 'example' => '**', ], 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过。'."\n" .'- N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '子结果码。', 'type' => 'string', 'example' => '***', ], 'ExtInfo' => [ 'description' => '扩展信息，json字符串。', 'type' => 'string', 'example' => '{}', ], 'ExtSourceInfo' => [ 'type' => 'string', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"EkycResult\\": \\"**\\",\\n \\"ExtBasicInfo\\": \\"**\\",\\n \\"ExtFaceInfo\\": \\"**\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtRiskInfo\\": \\"**\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"***\\",\\n \\"ExtInfo\\": \\"{}\\",\\n \\"ExtSourceInfo\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '查询认证结果', ], 'EkycVerify' => [ 'summary' => 'ekyc方案纯服务端接口', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '190721', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code', 'type' => 'string', 'required' => false, 'example' => 'eKYC_MIN', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持长度为32位的字母和数字的组合，请确保唯一。', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '您自定义的用户ID，或者其他可以识别特定用户的标识，例如：手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '证件类型', 'type' => 'string', 'required' => false, 'example' => '00000001', ], ], [ 'name' => 'DocName', 'in' => 'query', 'schema' => [ 'description' => '用户的真实姓名。当Authorize=\'T\'且证件类型为大陆身份证时，证件关键信息（DocName、DocNo）与证件图片（IdOcrPictureBase64/URL)必须至少输入其中一组'."\n" .'注：支持长度为1个汉字以上的汉字组合，无特殊字符，少数民族的点【·】除外', 'type' => 'string', 'required' => false, 'example' => '张**', ], ], [ 'name' => 'DocNo', 'in' => 'query', 'schema' => [ 'description' => '用户的证件号。当Authorize=\'T\'且证件类型为大陆身份证时，证件关键信息（DocName、DocNo）与证件图片（IdOcrPictureBase64/URL)必须至少输入其中一组'."\n" .'注：支持长度为18位的字母和数字组合', 'type' => 'string', 'required' => false, 'example' => '410***************', ], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => [ 'description' => '证件正面图片URL', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", ], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '卡证图片Base64编码。'."\n" .'说明'."\n" .'- 如果您选择该方式传入证件图片，请检查照片大小，不要传入过大的照片。'."\n" .'- IdOcrPictureBase64和IdOcrPictureUrl二选一。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人脸照片地址', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', ], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '人像图片Base64编码。'."\n" ."\n" .'说明'."\n" .'- 如果您选择该方式传入证件图片，请检查照片大小，不要传入过大的照片。'."\n" .'- FacePictureBase64和FacePictureUrl二选一。', 'type' => 'string', 'required' => false, 'example' => 'Base64', ], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => [ 'description' => '是否允许裁剪，默认不允许，T/F'."\n" ."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], [ 'name' => 'Authorize', 'in' => 'query', 'schema' => [ 'description' => '是否开启身份权威核验，目前仅适用于中国大陆二代身份证', 'type' => 'string', 'required' => false, 'example' => 'T', ], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => [ 'description' => '自定义OCR质量检测阈值模式：'."\n" ."\n" .'- 0：系统默认'."\n" .'- 1：严格模式'."\n" .'- 2：宽松模式'."\n" .'- 3（默认）：关闭质量检测', 'type' => 'string', 'required' => false, 'example' => '0', ], ], ], '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' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'example' => '4ab0b***cbde97', ], 'SubCode' => [ 'description' => '子结果码', 'type' => 'string', 'example' => '205', ], 'Passed' => [ 'description' => '是否通过，通过为T，不通过为F。', 'type' => 'string', 'example' => 'Y', ], 'ExtFaceInfo' => [ 'description' => '人脸结果信息', 'type' => 'string', 'example' => '{'."\n" .'"faceAttack": "N",'."\n" .'"faceComparisonScore": 52.57,'."\n" .'"facePassed": "N",'."\n" .'"authorityComparisonScore": 80.39'."\n" .'}'."\n" ."\n", ], 'ExtIdInfo' => [ 'description' => '卡证识别结果 只有当接口响应成功时返回', 'type' => 'string', 'example' => '{'."\n" .' "ocrIdInfo": {'."\n" .' "firstName": "**龙",'."\n" .' "lastName": "**",'."\n" .' "countryCode": "CHN",'."\n" .' "docType": "01560001",'."\n" .' "dateOfBirth": "2002-08-04",'."\n" .' "idNumber": "410************19"'."\n" .' },'."\n" .' "ocrIdPassed": "N",'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' }'."\n" .'}'."\n" ."\n", ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"SubCode\\": \\"205\\",\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceAttack\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"faceComparisonScore\\\\\\": 52.57,\\\\n\\\\\\"facePassed\\\\\\": \\\\\\"N\\\\\\",\\\\n\\\\\\"authorityComparisonScore\\\\\\": 80.39\\\\n}\\\\n\\\\n\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"firstName\\\\\\": \\\\\\"**龙\\\\\\",\\\\n \\\\\\"lastName\\\\\\": \\\\\\"**\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"CHN\\\\\\",\\\\n \\\\\\"docType\\\\\\": \\\\\\"01560001\\\\\\",\\\\n \\\\\\"dateOfBirth\\\\\\": \\\\\\"2002-08-04\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"410************19\\\\\\"\\\\n },\\\\n \\\\\\"ocrIdPassed\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n }\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => '纯服务端实人认证（eKYC_MIN）', ], 'FaceLiveness' => [ 'summary' => '静默活体纯服务端能力Api', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '175619', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code', 'type' => 'string', 'required' => false, 'example' => 'FACE_LIVENESS_MIN', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '商户用户ID，或可用于识别特定用户的其他标识符，例如手机号码、电子邮件地址等。强烈建议对userId字段的值进行预脱敏处理，例如对该值进行hash处理', 'type' => 'string', 'required' => false, 'example' => '123456789', ], ], [ 'name' => 'FacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人脸照片地址', 'type' => 'string', 'required' => false, 'example' => 'https://digital-face-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg', ], ], [ 'name' => 'FacePictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '照片Base64编码。'."\n" ."\n" .'说明：'."\n" .'- 如果您选择FacePictureBase64（照片Base64编码）方式传入人脸照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'Base64', ], ], [ 'name' => 'FaceQuality', 'in' => 'query', 'schema' => [ 'description' => '是否输出人脸质量分，默认不允许，T/F'."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', 'type' => 'string', 'required' => false, 'example' => 'T', ], ], [ 'name' => 'Crop', 'in' => 'query', 'schema' => [ 'description' => '是否允许裁剪，默认不允许，T/F'."\n" ."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', 'type' => 'string', 'required' => false, 'example' => 'T', ], ], [ 'name' => 'Occlusion', 'in' => 'query', 'schema' => [ 'description' => '是否进行遮挡检测，默认不允许T/F'."\n" ."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', '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' => '阿里云为该请求生成的唯一标识符', 'type' => 'string', 'example' => '42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回结果的提示信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', ], 'Passed' => [ 'description' => '认证是否通过'."\n" ."\n" .'- Y：通过'."\n" .'- N：不通过', 'type' => 'string', 'example' => 'N', ], 'SubCode' => [ 'description' => '子结果码', 'type' => 'string', 'example' => '205', ], 'ExtFaceInfo' => [ 'description' => '人脸结果信息', 'type' => 'object', 'properties' => [ 'FaceQualityScore' => [ 'description' => '人脸质量分(0～100)，当且仅当入参质量分开关打开时返回', 'type' => 'number', 'format' => 'double', 'example' => '87.19', ], 'OcclusionResult' => [ 'description' => '遮挡检测结果,Y (遮挡) /N (无遮挡),当且仅当遮挡检测开关打开时返回', 'type' => 'string', 'example' => 'Y', ], 'FaceAttack' => [ 'description' => '活体检测结果，Y（攻击）/N（正常）', 'type' => 'string', 'example' => 'Y', ], 'FaceGender' => [ 'description' => '人脸图片预测的性别，可能存在预测失败无结果值的情况。'."\n" ."\n" .'- M：男'."\n" .'- F：女', 'type' => 'string', 'example' => 'M', ], 'FaceAge' => [ 'description' => '人脸预测的参考年龄，可能存在预测失败无结果值的情况。', 'type' => 'integer', 'format' => 'int32', 'example' => '18', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42EA58CA-5DF4-55D5-82C4-5E7A40DA62BA\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"N\\",\\n \\"SubCode\\": \\"205\\",\\n \\"ExtFaceInfo\\": {\\n \\"FaceQualityScore\\": 87.19,\\n \\"OcclusionResult\\": \\"Y\\",\\n \\"FaceAttack\\": \\"Y\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"FaceAge\\": 18\\n }\\n }\\n}","type":"json"}]', 'title' => '人脸静默活体（FACE_LIVENESS_MIN）', ], 'FaceDuplicationCheckIntl' => [ 'summary' => '人脸重复性检测（FaceDuplicationCheckIntl）适用于无法集成 SDK 的场景，通过 API 接口传入人脸图片，实现以下功能：验证用户是否为真人、与留存人脸进行比对验证身份、在人脸库中进行检索判断是否存在、支持验证通过后自动将人脸注册到指定人脸库中。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code', 'type' => 'string', 'required' => true, 'example' => 'FACE_IDU_MIN', ], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的认证场景ID。', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => [ 'description' => '自定义的业务唯一标识，用于后续定位排查问题使用。支持长度为32位的字母和数字的组合，请确保唯一。', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', ], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的用户ID，或者其他可以识别特定用户的标识，例如：手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。', 'type' => 'string', 'required' => true, 'example' => '1234567890', ], ], [ 'name' => 'VerifyModel', 'in' => 'formData', 'schema' => [ 'description' => '验证类型：'."\n" .'- 0：检索模式'."\n" .'> - 功能：传入人脸库和用户人脸图片（sourceFacePicture）系统自动检索人脸库中是否已经存该指定人脸图片（sourceFacePicture），且人脸图片（sourceFacePicture）支持开启静默活体检测。'."\n" .'> - 建议场景：真人注册账号且不允许重复注册场景。'."\n" ."\n" .'- 1（默认）：验证模式'."\n" .'> - 功能：传入指定人脸图片（sourceFacePicture）与留底人脸图片（TargetFacePicture），系统自动验证是否与人脸一致，且指定人脸图片（sourceFacePicture）支持开启静默活体检测。'."\n" .'> - 建议场景：修改登录、账号等信息时需验证是否为本人操作的场景。'."\n" ."\n" .'- 2：综合模式'."\n" .'> - 功能：同时传入人脸库、指定人脸图片（sourceFacePicture）与留底人脸图片（TargetFacePicture），系统自动检索人脸库中是否存在指定人脸图片（sourceFacePicture），是否与留底人脸一致，且指定人脸图片（sourceFacePicture）支持开启静默活体检测。'."\n" .'> - 建议场景：需要验证是新增用户且是本人操作场景。', 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'Liveness', 'in' => 'formData', 'schema' => [ 'description' => '是否开启静默活体检测'."\n" .'- 0：不开启'."\n" .'- 1：开启', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FaceGroupCodes', 'in' => 'formData', 'schema' => [ 'description' => '客户通过控制台创建的人脸库编码，最大支持同时查询10个人脸库。当传入多个人脸库编码时，以逗号区分。', 'type' => 'string', 'required' => false, 'example' => '1232344，23444', ], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', ], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg', ], ], [ 'name' => 'AutoRegistration', 'in' => 'formData', 'schema' => [ 'description' => '指检索未存在重复人脸，是否自动注册人脸到指定人脸库下。'."\n" .'- 0：自动注册'."\n" .'- 1：不注册（默认）', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'FaceRegisterGroupCode', 'in' => 'formData', 'schema' => [ 'description' => '注册人脸库。', 'type' => 'string', 'required' => false, 'example' => '0e0c34a77f', ], ], [ 'name' => 'SaveFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '保存人脸图片区分是'."\n" .'- 0：人脸（默认）'."\n" .'- 1：特征'."\n" .'>预留字段，暂无启用>', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'formData', 'schema' => [ 'description' => '人脸匹配阈值。>预留字段，暂无启用>', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], [ 'name' => 'ReturnFaces', 'in' => 'formData', 'schema' => [ 'description' => '指匹配阈值之上存在多个人脸时，可通过该参数自定义返回数量'."\n" .'- 默认返回1'."\n" .'- 最大支持5', 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], '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' => '5E63B760-0ECB-5C07-8503-A65C27876968', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'FacePassed' => [ 'description' => '认证最终结果，取值：'."\n" .'- Y：通过'."\n" .'- N：不通过', 'type' => 'string', 'example' => 'Y', ], 'FaceComparisonScore' => [ 'description' => '当验证模式为1或2时返回1：1验证的比对分'."\n" .'比对分取值范围0～100。', 'type' => 'string', 'example' => '98', ], 'DuplicateFace' => [ 'description' => '检测存在重复人脸时返回检索到的人脸库人脸ID和UserID。', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "faceGroupCode": "sg7****uzt",'."\n" .' "faceId": "f5a921*******9e792ec84c8f0ca592a",'."\n" .' "merchantUserId": "fa****01"'."\n" .' }'."\n" .']', ], 'FaceRegistrationResult' => [ 'description' => '人脸注册结果 '."\n" .'- 0 失败 '."\n" .'- 1成功', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FaceRegistrationId' => [ 'description' => '仅当客户设置自动注册，人脸注册成功时返回对应FACEID。', 'type' => 'string', 'example' => '9e792ec84c8f0ca592a', ], 'FaceAttack' => [ 'description' => '采集人脸是否涉及活体攻击，攻击为Y，否则为N。'."\n" .'当开启静默活体检测时返回', 'type' => 'string', 'example' => 'N', ], 'FaceAttackScore' => [ 'description' => '人脸静默活体检测攻击的概率。取值范围0～100。'."\n" .'当开启静默活体检测时返回', 'type' => 'string', 'example' => '99', ], 'FaceAge' => [ 'description' => '人脸预测的参考年龄，可能存在预测失败无法返回的情况。', 'type' => 'string', 'example' => '30', ], 'FaceGender' => [ 'description' => '人脸图片预测的性别，可能存在预测失败无法返回的情况。'."\n" .'- M：男'."\n" .'- F：女', 'type' => 'string', 'example' => 'M', ], 'SubCode' => [ 'description' => '认证结果描述。更多信息，请参ResultObject.SubCode错误码说明。', 'type' => 'string', 'example' => '200', ], 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => '4ab0b***cbde97', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": \\"98\\",\\n \\"DuplicateFace\\": \\"[\\\\n {\\\\n \\\\\\"faceGroupCode\\\\\\": \\\\\\"sg7****uzt\\\\\\",\\\\n \\\\\\"faceId\\\\\\": \\\\\\"f5a921*******9e792ec84c8f0ca592a\\\\\\",\\\\n \\\\\\"merchantUserId\\\\\\": \\\\\\"fa****01\\\\\\"\\\\n }\\\\n]\\",\\n \\"FaceRegistrationResult\\": 0,\\n \\"FaceRegistrationId\\": \\"9e792ec84c8f0ca592a\\",\\n \\"FaceAttack\\": \\"N\\",\\n \\"FaceAttackScore\\": \\"99\\",\\n \\"FaceAge\\": \\"30\\",\\n \\"FaceGender\\": \\"M\\",\\n \\"SubCode\\": \\"200\\",\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', 'title' => '纯服务端活体人脸防重注册（FACE_IDU_MIN）', ], 'DeepfakeDetectIntlStream' => [ 'summary' => 'ID Verification 提供了人脸Deepfake检测能力，可以通过接口的形式单独接入。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthNYJI62', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'description' => '要接入的产品方案。'."\n" .'取值：FACE_DEEPFAKE', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FACE_DEEPFAKE', ], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的认证场景ID，用于后续控制台输入此场景ID查询相关记录使用。'."\n" ."\n" .'支持长度为10位的字母、数字或下划线的组合。', 'type' => 'string', 'required' => false, 'example' => '123****123', ], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => [ 'description' => '商户请求的唯一标识，值为32位长度的字母数字组合。'."\n" ."\n" .'其中前几位字符由商户自定义的简称组成，中间部分可以包含一段时间，而后段可以采用随机或递增序列。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e0c34a***353888', ], ], [ 'name' => 'FaceInputType', 'in' => 'formData', 'schema' => [ 'description' => '人脸素材输入类型：'."\n" ."\n" .'- IMAGE（默认）：人脸图片'."\n" .'- VIDEO：人脸视频'."\n" ."\n" .'说明'."\n" .'视频处理时间较久，建议超时时间设置>3S。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'IMAGE' => 'IMAGE', 'VIDEO' => 'VIDEO', ], 'example' => 'IMAGE', ], ], [ 'name' => 'FaceUrl', 'in' => 'formData', 'schema' => [ 'description' => '传入人脸图片URL地址。', '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格式编码，视频格式建议通过流方式传入。', 'type' => 'string', 'required' => false, 'example' => '/9j/4AAQSkZJRgABAQAASxxxxxxx', ], ], [ 'name' => 'FaceFile', 'in' => 'formData', 'schema' => [ 'description' => '图片输入流。', '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], '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', ], 'RiskScore' => [ 'description' => '风险分值Map。', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => '{'."\n" .' "SuspectPSFace": "0.9796",'."\n" .' "SuspectRemake": "0.0000",'."\n" .' "SuspectDeepForgery": "0.9500",'."\n" .' "SuspectAIGCFace": "0.0001"'."\n" .' }', 'description' => '命中风险时返回对应标签分数', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"SuspectDeepForgery\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '人脸Deepfake检测(文件流）', 'description' => '传入人脸图片，通过算法检测是否存在深度伪造风险。包含AIGC生成人脸、深度伪造换脸、模板人脸、翻拍人脸等风险场景，输出风险标签与置信度。', ], 'DeepfakeDetectIntl' => [ 'summary' => '人脸Deepfake检测服务的API。', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthNYJI62', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '要接入的产品方案。取值：**FACE_DEEPFAKE**', 'type' => 'string', 'required' => true, 'example' => 'FACE_DEEPFAKE', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => '您自定义的认证场景ID，用于后续控制台输入此场景ID查询相关记录使用。支持长度为10位的字母、数字或下划线的组合。', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户请求的唯一标识，值为32位长度的字母数字组合。其中前几位字符由商户自定义的简称组成，中间部分可以包含一段时间，而后段可以采用随机或递增序列。', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', ], ], [ 'name' => 'FaceInputType', 'in' => 'query', 'schema' => [ 'description' => '传入**IMAGE**，表示人脸图像。', 'type' => 'string', 'required' => false, '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', ], ], ], '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" .'- **SuspectWarterMark** 疑似存在水印 '."\n" .'- **SuspectTemple** 疑似模板攻击 '."\n" .'- **SuspectAIGCFace** 疑似生成人脸 '."\n" .'- **SuspectRemake** 疑似翻拍人脸', 'type' => 'string', 'example' => 'SuspectDeepForgery,SuspectWarterMark', ], 'RiskScore' => [ 'description' => '风险分值Map。', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => '{'."\n" .' "SuspectPSFace": "0.9796",'."\n" .' "SuspectRemake": "0.0000",'."\n" .' "SuspectDeepForgery": "0.9500",'."\n" .' "SuspectAIGCFace": "0.0001",'."\n" .' "SuspectWaterMark": "0.0000"'."\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,SuspectWarterMark\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"SuspectPSFace\\\\\\": \\\\\\"0.9796\\\\\\",\\\\n \\\\\\"SuspectRemake\\\\\\": \\\\\\"0.0000\\\\\\",\\\\n \\\\\\"SuspectDeepForgery\\\\\\": \\\\\\"0.9500\\\\\\",\\\\n \\\\\\"SuspectAIGCFace\\\\\\": \\\\\\"0.0001\\\\\\",\\\\n \\\\\\"SuspectWaterMark\\\\\\": \\\\\\"0.0000\\\\\\"\\\\n }\\"\\n }\\n }\\n}","type":"json"}]', 'title' => '人脸Deepfake检测', 'description' => '传入人脸图片，通过算法检测是否存在深度伪造风险。包含AIGC生成人脸、深度伪造换脸、模板人脸、翻拍人脸等风险场景，输出风险标签与置信度。', ], 'FaceGuardRisk' => [ 'summary' => '国际人脸保镖纯服务端接口', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '253422', 'abilityTreeNodes' => [ 'FEATUREcloudauthCS0SDG', ], ], 'parameters' => [ [ 'name' => 'DeviceToken', 'in' => 'query', 'schema' => [ 'description' => '通过人脸保镖SDK获取deviceToken', 'type' => 'string', 'required' => false, 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一', 'type' => 'string', 'required' => false, 'example' => '0c83ce0101d34eff886b1f7d1cdef67f', ], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code(固定值：FACE_GUARD)', 'type' => 'string', 'required' => false, 'example' => 'FACE_GUARD', ], ], [ 'name' => 'BizId', 'in' => 'query', 'schema' => [ 'description' => '客户业务ID', 'type' => 'string', 'required' => false, 'example' => 'LMALL20******001', ], ], ], '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' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RiskTags' => [ 'description' => '设备风险标签。'."\n" ."\n" .'- 多个设备风险标签以半角逗号（,）分隔，如“ROOT,VPN,HOOK”，'."\n" ."\n" .'- 如需了解更多设备风险标签及其含义，请参见官方文档人脸保镖标签说明。', 'type' => 'string', 'example' => 'ROOT,VPN,HOOK', ], 'RiskExtends' => [ 'description' => '拓展信息，JSON格式。（按租户需求定制返回）', 'type' => 'string', 'example' => '默认为空', ], 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => 'hk573be80f944d95ac812e019e3655a8', ], 'GuardRiskScore' => [ 'description' => '人脸保镖算法预测的设备风险可能性，分数越高代表设备风险越高。'."\n" ."\n" .'分值取值：0~100。', 'type' => 'number', 'format' => 'double', 'example' => '0', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"RiskTags\\": \\"ROOT,VPN,HOOK\\",\\n \\"RiskExtends\\": \\"默认为空\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e019e3655a8\\",\\n \\"GuardRiskScore\\": 0\\n }\\n}","type":"json"}]', 'title' => '设备助手', ], 'FaceCompare' => [ 'summary' => '通过人脸识别技术，可以对传入的两张人脸图片进行比对验证，返回人脸对比结果和相似度分值。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '165986', 'abilityTreeNodes' => [ 'FEATUREcloudauth0KJCLK', ], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一。', 'type' => 'string', 'required' => false, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c353888', ], ], [ 'name' => 'SourceFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。'."\n" ."\n" .'说明'."\n" .'- 如果您选择该方式传入证件图片，请检查照片大小，不要传入过大的照片。'."\n" .'- SourceFacePicture与SourceFacePictureUrl二选一。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'SourceFacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人脸图片的HTTPS或HTTP地址。', 'type' => 'string', 'required' => false, 'example' => 'https://***face1.jpeg', ], ], [ 'name' => 'TargetFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '底库照片Base64编码。'."\n" ."\n" .'说明'."\n" .'- 如果您选择该方式传入证件图片，请检查照片大小，不要传入过大的照片。'."\n" .'- TargetFacePicture与TargetFacePictureUrl二选一。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'TargetFacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '底库人脸图片的HTTPS或HTTP地址。', 'type' => 'string', 'required' => false, 'example' => 'https://***face2.jpeg', ], ], [ 'name' => 'FacePictureQualityCheck', 'in' => 'query', 'schema' => [ 'title' => '是否开启传入人脸图片质量检测', 'description' => '是否开启传入人脸图片质量检测', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], ], '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' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', ], 'Code' => [ 'description' => '返回码。'."\n" ."\n" .'200：表示成功。'."\n" .'其它：表示错误码。错误码详情，请参见错误码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', ], 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过。'."\n" .'- N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'FaceComparisonScore' => [ 'description' => '认证过程中所提交的人脸照片和人脸留底图片上人脸的比对分，取值范围：**0**~**100**。', 'type' => 'number', 'format' => 'double', 'example' => '98', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"FaceComparisonScore\\": 98\\n }\\n}","type":"json"}]', 'title' => '人脸比对', ], 'FaceCrossCompareIntl' => [ 'summary' => '人脸交叉比对', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '要接入的产品方案。取值：'."\n" .'FACE_CROSS_COMPARE', 'type' => 'string', 'required' => true, 'example' => ' FACE_CROSS_COMPARE', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => '自定义业务场景ID', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '自定义的业务唯一标识，用于后续定位排查问题使用。支持长度为32位的字母和数字的组合，请确保唯一。', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', ], ], [ 'name' => 'CompareModel', 'in' => 'query', 'schema' => [ 'description' => '比对模式'."\n" .'- 0-链式比对（默认）：A：B且B：C'."\n" .'- 1-循环比对：A：B且B：C且C：A', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'SourceAFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'SourceAFacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', ], ], [ 'name' => 'SourceBFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", ], ], [ 'name' => 'SourceBFacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', ], ], [ 'name' => 'SourceCFacePicture', 'in' => 'formData', 'schema' => [ 'description' => '人像照片Base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64'."\n", ], ], [ 'name' => 'SourceCFacePictureUrl', 'in' => 'query', 'schema' => [ 'description' => '人像图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.com/1.jpg', ], ], [ 'name' => 'FaceVerifyThreshold', 'in' => 'query', 'schema' => [ 'description' => '人脸匹配阈值。此参数为系统预留参数，暂不支持自定义。', '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' => '130A2C10-B9EE-4D84-88E3-5384FF039795', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'FacePassed' => [ 'description' => '认证最终结果，取值：'."\n" .'- Y：通过'."\n" .'- N：不通过', 'type' => 'string', 'example' => 'Y', ], 'FaceComparisonScoreA2B' => [ 'description' => 'A比B 比对分取值范围0～1。', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', ], 'FaceComparisonScoreB2C' => [ 'description' => 'B比C 比对分取值范围0～1。', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', ], 'FaceComparisonScoreC2A' => [ 'description' => 'C比A 比对分取值范围0～1。', 'type' => 'number', 'format' => 'double', 'example' => '0.9999999999999999', ], 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => '4ab0b***cbde97', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"FacePassed\\": \\"Y\\",\\n \\"FaceComparisonScoreA2B\\": 0.9999999999999999,\\n \\"FaceComparisonScoreB2C\\": 0.9999999999999999,\\n \\"FaceComparisonScoreC2A\\": 0.9999999999999999,\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', 'title' => '人脸交叉比对', ], 'DocOcrMax' => [ 'summary' => '全球证件ocr识别接口', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'description' => '要接入的产品方案。'."\n" ."\n" .'取值ID_OCR_MAX', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ID_OCR_MAX', ], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的认证场景ID，用于后续控制台输入此场景ID查询相关记录。'."\n" ."\n" .'支持长度为10位的字母、数字和下划线的组合。', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的业务唯一标识，用于后续定位排查问题。'."\n" ."\n" .'支持长度为32位的字母和数字的组合，请确保唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c******', ], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的用户ID，或者其他可以识别特定用户的标识，例如：手机号码、邮箱地址等。'."\n" ."\n" .'强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。', 'type' => 'string', 'required' => false, 'example' => '123456789', ], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '卡证图片Base64编码。'."\n" ."\n" .'如果您选择IdOcrPictureBase64（照片Base64编码）方式传入证件照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '卡证图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://***********.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", ], ], [ 'name' => 'OcrModel', 'in' => 'formData', 'schema' => [ 'description' => 'OCR识别模式：'."\n" ."\n" .'- 0：通用证件识别模式（默认）'."\n" ."\n" .'- 1：证件自动分类模式'."\n" ."\n" .'- 2：证件自动分类+通用识别模式', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => [ 'description' => '证件类型。'."\n" .'- 格式：国家（地区）代码+证件类型缩写+页面（可选）'."\n" ."\n" .'说明'."\n" .'- OcrModel = 0：DocType必传，指定证件类型，现有逻辑不变'."\n" .'- OcrModel = 1或2：DocType需要为空。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CNSSC01', ], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => [ 'description' => '>该字段已废弃>', 'type' => 'string', 'required' => false, 'example' => '已废弃', ], ], [ 'name' => 'Spoof', 'in' => 'formData', 'schema' => [ 'description' => '该字段已废弃>', 'type' => 'string', 'required' => false, 'example' => '已废弃', ], ], [ 'name' => 'IdThreshold', 'in' => 'formData', 'schema' => [ 'description' => '自定义OCR质量检测阈值模式：'."\n" ."\n" .'- 0：系统默认'."\n" .'- 1：严格模式'."\n" .'- 2：宽松模式'."\n" .'- 3（默认）：关闭质量检测', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'IdSpoof', 'in' => 'formData', 'schema' => [ 'description' => '是否开启证件防伪功能：'."\n" ."\n" .'- T：开启'."\n" ."\n" .'- F（默认）：不开启', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], [ 'name' => 'DocPage', 'in' => 'formData', 'schema' => [ 'description' => '期望识别的页面'."\n" ."\n" .'- 01（默认）：证件人像面'."\n" ."\n" .'- 02：证件背面', 'type' => 'string', 'required' => false, 'example' => '01', ], ], [ 'name' => 'OcrValueStandard', 'in' => 'query', 'schema' => [ 'title' => 'OcrValueStandard是否需要开启OCR识别关键字段标准化； 0否(默认) 1是', 'description' => '是否需要开启OCR识别关键字段标准化'."\n" .'- 0：否 (默认) '."\n" .'- 1：是', 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0', ], ], [ 'name' => 'Authorize', 'in' => 'formData', 'schema' => [ 'description' => '是否启用权威数据源核验以增强证件防伪能力。'."\n" ."\n" .'- **T**：启用'."\n" ."\n" .'- **F**：不启用（默认值）'."\n" ."\n" .'> '."\n" .'> - **适用证件类型**：中国居民身份证（CHN01001）、中国内地驾驶证（CHN02001）。'."\n" .'> - **数据传输声明**：启用此参数，即表示同意将用户的姓名和证件号码传输至中国内地权威数据源进行一致性校验。'."\n" .'> - **性能影响**：启用后，接口响应时间将增加约 1-2 秒。建议调整超时时间设置。', 'type' => 'string', 'required' => false, 'example' => 'T'."\n", ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过。'."\n" .'- N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '子结果码。', 'type' => 'string', 'example' => '200', ], 'ExtIdInfo' => [ 'description' => '卡证识别结果 只有当接口响应成功时返回', 'type' => 'string', 'example' => '{'."\n" .' "docType": "PPTW01",'."\n" .' "ocrIdInfo": {'."\n" .' "passportNo": "36*******",'."\n" .' "expiryDate": "2032/02/10",'."\n" .' "placeOfBirth": "TAIWAN",'."\n" .' "surname": "CHEN",'."\n" .' "givenname": "LIN-CHUN",'."\n" .' "countryCode": "TWN",'."\n" .' "sex": "F",'."\n" .' "personalNo": "S22********",'."\n" .' "issueDate": "2022/02/10",'."\n" .' "birthDate": "1988/10/04"'."\n" .' }'."\n" .'}', ], 'TransactionId' => [ 'description' => '认证ID', 'type' => 'string', 'example' => 'hk573be80f944d95ac812e0*******a8', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"docType\\\\\\": \\\\\\"PPTW01\\\\\\",\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"passportNo\\\\\\": \\\\\\"36*******\\\\\\",\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2032/02/10\\\\\\",\\\\n \\\\\\"placeOfBirth\\\\\\": \\\\\\"TAIWAN\\\\\\",\\\\n \\\\\\"surname\\\\\\": \\\\\\"CHEN\\\\\\",\\\\n \\\\\\"givenname\\\\\\": \\\\\\"LIN-CHUN\\\\\\",\\\\n \\\\\\"countryCode\\\\\\": \\\\\\"TWN\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"F\\\\\\",\\\\n \\\\\\"personalNo\\\\\\": \\\\\\"S22********\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2022/02/10\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1988/10/04\\\\\\"\\\\n }\\\\n}\\",\\n \\"TransactionId\\": \\"hk573be80f944d95ac812e0*******a8\\"\\n }\\n}","type":"json"}]', 'title' => '全球卡证OCR识别', ], 'DocOcr' => [ 'summary' => '卡证OCR纯服务端能力Api', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '181950', 'abilityTreeNodes' => [ 'FEATUREcloudauthCW0JNH', ], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一', 'type' => 'string', 'required' => false, 'example' => 'dso9322***dsjsd22', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '业务中自定义的用户ID，请保持唯一', 'type' => 'string', 'required' => false, 'example' => '123456789', ], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '卡证图片Base64编码。'."\n" ."\n" .'如果您选择IdOcrPictureBase64（照片Base64编码）方式传入证件照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => [ 'description' => '证件正面图片URL', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '证件类型', 'type' => 'string', 'required' => false, 'example' => '00000006', ], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code', 'type' => 'string', 'required' => false, 'example' => '产品方案类型ID_OCR_MIN', ], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => [ 'description' => '是否进行证件OCR'."\n" .'- T：表示需要证件OCR'."\n" .'- F：表示不需要', 'type' => 'string', 'required' => false, 'example' => 'T', ], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => [ 'description' => '是否进行证脸质量检测'."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], [ 'name' => 'Spoof', 'in' => 'query', 'schema' => [ 'description' => '是否开启防伪检测'."\n" .'- T：表示开启防伪'."\n" .'- F：表示关闭', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], [ 'name' => 'IdThreshold', 'in' => 'query', 'schema' => [ 'description' => '自定义OCR质量检测阈值模式：'."\n" ."\n" .'- 0：系统默认'."\n" .'- 1：严格模式'."\n" .'- 2：宽松模式'."\n" .'- 3（默认）：关闭质量检测', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'CardSide', 'in' => 'query', 'schema' => [ 'description' => '区分证件国徽面和人像面 ，不传默认人像面 。'."\n" ."\n" .'- OCR_ID_FACE （默认）：人像面'."\n" ."\n" .'- OCR_ID_NATIONAL_EMBLEM ：国徽面', 'type' => 'string', 'required' => false, 'example' => 'OCR_ID_FACE', ], ], ], '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' => '86C40EC3-5940-5F47-995C-BFE90B70E540', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', ], 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过'."\n" .'- N：不通过', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '子结果码', 'type' => 'string', 'example' => '200', ], 'ExtIdInfo' => [ 'description' => '卡证识别结果 只有当接口响应成功时返回', 'type' => 'string', 'example' => '{'."\n" .' "idFaceQualityScore": 98.0'."\n" .' "ocrIdInfo": {'."\n" .' "expiryDate": "",'."\n" .' "originOfIssue": "公安部出入境管理局",'."\n" .' "englishName": "LI SI",'."\n" .' "sex": "男",'."\n" .' "name": "李四",'."\n" .' "idNumber": "H11111112",'."\n" .' "issueDate": "2013-01-02",'."\n" .' "birthDate": "1990-02-21"'."\n" .' },'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "Y",'."\n" .' "spoofType": ['."\n" .' "SCREEN_REMARK"'."\n" .' ]'."\n" .' }'."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.0\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"LI SI\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"李四\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"H11111112\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2013-01-02\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1990-02-21\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"Y\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '中国卡证OCR识别（ID_OCR_MIN）', ], 'Id2MetaVerifyIntl' => [ 'summary' => '传入姓名和身份证号，通过权威数据源验证其真实性和一致性。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '199203', 'abilityTreeNodes' => [ 'FEATUREcloudauthZN5W38', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '接入的产品方案，固定值：ID_2META', 'type' => 'string', 'required' => false, 'example' => 'ID_2META', ], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => [ 'description' => '参数类型：'."\n" ."\n" .'- normal：原始值（明文）'."\n" .'- 说明：由于权威数据源限制，身份二要素核验不支持Md5加密方式。', 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => [ 'description' => '身份证号(输入明文)', 'type' => 'string', 'required' => false, 'example' => '429001********8211'."\n", ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '姓名(输入明文)', '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', 'type' => 'string', 'example' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'BizCode' => [ 'description' => '核验结果码。'."\n" .'- 1：核验一致'."\n" .'- 2：核验不一致'."\n" .'- 3：未查得', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\"\\n }\\n}","type":"json"}]', 'title' => '身份二要素认证核验', ], 'Id2MetaPeriodVerifyIntl' => [ 'summary' => '身份二要素有效期核验', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '261144', 'abilityTreeNodes' => [ 'FEATUREcloudauthZN5W38', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'description' => '要接入的产品方案。'."\n" ."\n" .'取值eKYC_Date_MIN', 'type' => 'string', 'required' => true, 'example' => 'eKYC_Date_MIN', ], ], [ 'name' => 'SceneCode', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的认证场景ID，用于后续控制台输入此场景ID查询相关记录使用。支持长度为10位的字母、数字或下划线的组合。', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => [ 'description' => '自定义的业务唯一标识，用于后续定位排查问题使用。支持长度为32位的字母和数字的组合，请确保唯一。', 'type' => 'string', 'required' => true, 'example' => 'e0c34a77f5ac40a5aa5e6ed20c35****', ], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => [ 'description' => '您自定义的用户ID，或者其他可以识别特定用户的标识，例如手机号码、邮箱地址等。强烈建议对该字段的值进行预先脱敏，例如对值进行哈希处理。', 'type' => 'string', 'required' => false, 'example' => '1234567890', ], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => [ 'description' => '证件类型，以8位数字组合作为唯一标识。更多说明，请参见证件类型列表。'."\n" .'当前支持中国内地第二代居民身份证，请传入固定值：00000001', 'type' => 'string', 'required' => true, 'example' => '​00000001'."\n" ."\n", ], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => [ 'description' => '用户的姓名。', 'type' => 'string', 'required' => true, 'example' => '张三', ], ], [ 'name' => 'DocNo', 'in' => 'formData', 'schema' => [ 'description' => '用户的证件号码。', 'type' => 'string', 'required' => true, 'example' => '411xxxxxxxxxxx0001', ], ], [ 'name' => 'ValidityStartDate', 'in' => 'formData', 'schema' => [ 'description' => '有效期开始日期，格式：YYYYMMDD。如：20201001', 'type' => 'string', 'required' => true, 'example' => '20201001', ], ], [ 'name' => 'ValidityEndDate', 'in' => 'formData', 'schema' => [ 'description' => '身份证有效期到期日期，格式：YYYYMMDD。如：20301001', 'type' => 'string', 'required' => true, 'example' => '20301001', ], ], ], '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' => '7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9', ], 'Code' => [ 'description' => '返回码。关于返回码的具体信息，请参见返回Code和Message说明返回Code和Message说明。', 'type' => 'string', 'example' => 'success', ], 'Message' => [ 'description' => '请求消息的响应信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Passed' => [ 'description' => '认证最终结果。取值：'."\n" ."\n" .'* Y：通过。'."\n" ."\n" .'* N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '认证结果描述。更多信息，请参ResultObject.SubCode错误码说明。', 'type' => 'string', 'example' => '200', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B97D932-7FF5-517D-BF39-7CA1BEE3CDD9\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\"\\n }\\n}","type":"json"}]', 'title' => '身份证有效期核验', ], 'BankMetaVerifyIntl' => [ 'summary' => '银行卡要素（银行卡二要素、银行卡三要素和银行卡四要素）API接口。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauth883TGF', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '固定值：BANK_CARD_N_META', 'type' => 'string', 'required' => true, 'example' => 'BANK_CARD_N_META'."\n", ], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => [ 'description' => '加密方式：'."\n" .'- normal：不加密'."\n" .'- md5：md5加密'."\n" ."\n" .'重要:'."\n" ."\n" .'- 所有参数的密文均取32位小写MD5字符串形式。'."\n" .'- 不同MD5工具得出的密文可能不同，如果加密前接口可以调通但加密后不行，请尝试更换MD5工具。', 'type' => 'string', 'required' => true, 'example' => 'normal', ], ], [ 'name' => 'VerifyMode', 'in' => 'query', 'schema' => [ 'description' => 'VERIFY_BANK_CARD：银行卡认证模式。表示将传入的银行卡号和用户的真实姓名、身份证号，手机号是否匹配', 'type' => 'string', 'required' => true, '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' => true, 'example' => 'BANK_CARD_4_META', ], ], [ 'name' => 'BankCard', 'in' => 'query', 'schema' => [ 'description' => '银行卡号。'."\n" ."\n" .'- 当paramType取值normal时，输入银行卡号明文。'."\n" .'- 当paramType取值md5时，卡号除最后6位其他部分明文+最后6位md5值（32位小写）。', 'type' => 'string', 'required' => true, 'example' => '● 明文：12345678******'."\n" .'● 密文：'."\n" .'12345678f8ee21920e37807b43e7e912ab829b6e', ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '姓名。'."\n" ."\n" .'- 当paramType取值normal时，输入姓名明文。'."\n" .'- 当paramType取值md5时，姓名第一个字MD5加密（32位小写MD5）+ 姓名其他部分明文。', 'type' => 'string', 'required' => true, 'example' => '张*'."\n", ], ], [ 'name' => 'IdentityType', 'in' => 'query', 'schema' => [ 'description' => '证件类型（传空值默认为身份证，其他证件类型详见下表）。', 'type' => 'string', 'required' => false, 'example' => '01', ], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => [ 'description' => '证件号：'."\n" .'- paramType 传 normal 时：传入证件号明文。'."\n" .'- paramType 传 md5 时：'."\n" .' - 身份证号前6位（明文）+出生年月日（密文）+身份证号后4位（明文）。'."\n" .' - 其他证件最后两位MD5加密。'."\n" ."\n" .'重要'."\n" .'ProductType为以下取值时，此项必选。'."\n" .'- BANK_CARD_3_META'."\n" .'- BANK_CARD_4_META', 'type' => 'string', 'required' => false, 'example' => '● 明文：429001********8211'."\n" .'● 密文：'."\n" .'42900132fa7bcd874161bea8ec8fd98f390ec98211', ], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => [ 'description' => '手机号：'."\n" .'- paramType 传 normal 时：传入手机号明文。'."\n" .'- paramType 传 md5 时：传入手机号密文。'."\n" ."\n" .'重要'."\n" ."\n" .'- ProductType = BANK_CARD_4_META时，此项必选。', 'type' => 'string', 'required' => false, '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' => '4EB35****87EBA1', ], '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" .'- **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\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\"\\n }\\n}","type":"json"}]', 'title' => '银行卡要素核验', 'description' => '银行卡核验， 包含：银行卡二要素（姓名+银行卡号），银行卡三要素（姓名+身份证号码+银行卡号）四要素（姓名+身份证号码+手机号+银行卡号）的一致性核验。', ], 'Mobile2MetaVerifyIntl' => [ 'summary' => '手机号二要素核验API', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthPZCZ2I', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'description' => '产品code(固定值：MOBILE_2META)', 'type' => 'string', 'required' => true, 'example' => 'MOBILE_2META', ], ], [ 'name' => 'ParamType', 'in' => 'formData', 'schema' => [ 'description' => '参数类型：'."\n" ."\n" .'- normal：不加密'."\n" .'- md5：md5加密', 'type' => 'string', 'required' => true, 'example' => 'normal', ], ], [ 'name' => 'UserName', 'in' => 'formData', 'schema' => [ 'description' => '姓名：'."\n" ."\n" .'- paramType 传 normal 时：传入姓名明文。'."\n" .'- paramType 传 md5 时：传入姓名密文（输入32位小写md5字符串）。', 'type' => 'string', 'required' => true, 'example' => '张*', ], ], [ 'name' => 'Mobile', 'in' => 'formData', 'schema' => [ 'description' => '手机号码。'."\n" ."\n" .'- 当paramType取值normal时，输入明文'."\n" .'- 当paramType取值md5时，传入手机号码密文，输入32位小写md5字符串', 'type' => 'string', 'required' => true, 'example' => '186****1234', ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ '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\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', 'title' => '手机号二要素核验', 'description' => '传入手机号、姓名，通过权威数据源验证其真实性和一致性。请确保在使用该接口前，已充分了解手机二要素产品的收费方式和价格', ], 'Mobile3MetaVerifyIntl' => [ 'summary' => '传入手机号、姓名、身份证号，通过权威数据源验证其真实性和一致性，如果不一致，返回不一致的原因。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '199210', 'abilityTreeNodes' => [ 'FEATUREcloudauthPZCZ2I', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '接入的产品方案，固定值：MOBILE_3META', 'type' => 'string', 'required' => false, 'example' => 'MOBILE_3META', ], ], [ 'name' => 'ParamType', 'in' => 'query', 'schema' => [ 'description' => '参数类型：'."\n" ."\n" .'- normal：不加密'."\n" .'- md5：md5加密', 'type' => 'string', 'required' => false, 'example' => 'normal', ], ], [ 'name' => 'IdentifyNum', 'in' => 'query', 'schema' => [ 'description' => '身份证号'."\n" ."\n" .'- 当paramType取值normal时，输入明文'."\n" .'- 当paramType取值md5时，输入32位小写md5字符串', 'type' => 'string', 'required' => false, 'example' => '429001********8211'."\n", ], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => [ 'description' => '姓名'."\n" ."\n" .'- 当paramType取值normal时，输入明文'."\n" .'- 当paramType取值md5时，输入32位小写md5字符串', 'type' => 'string', 'required' => false, 'example' => '张*'."\n", ], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => [ 'description' => '手机号码。'."\n" ."\n" .'- 当paramType取值normal时，输入明文'."\n" .'- 当paramType取值md5时，输入32位小写md5字符串', 'type' => 'string', 'required' => false, 'example' => '186****1234', ], ], ], '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' => 'D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ '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\\": \\"D241532C-4EE9-5A2A-A5A5-C1FD98CE2EDD\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"BizCode\\": \\"1\\",\\n \\"SubCode\\": \\"101\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', 'title' => '手机号三要素核验', ], 'CredentialRecognitionIntl' => [ 'summary' => 'API接口，上传凭证图片，包括：水电煤、信用卡账单等，通过通义VL智能提取账单地址及姓名', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthNYJI62', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '要接入的产品方案。取值CREDENTIAL_RECOGNITION。', 'type' => 'string', 'required' => true, 'example' => 'CREDENTIAL_RECOGNITION', ], ], [ 'name' => 'CredentialOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '图片Base64编码。如果您选择IdOcrPictureBase64（照片Base64编码）方式传入照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'CredentialOcrPictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://***', ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '凭证类型。'."\n" .'- 交易凭据：01（包括：水、电、煤、信用卡等各类电子账单图片）', 'type' => 'string', 'required' => true, 'example' => '01', ], ], [ 'name' => 'OcrArea', 'in' => 'query', 'schema' => [ 'description' => '提取类型：'."\n" .'- 0101：电子账单地址&姓名模块（通过智能分析提取地址及姓名模块）', 'type' => 'string', 'required' => true, 'example' => '0101', ], ], [ 'name' => 'FraudCheck', 'in' => 'query', 'schema' => [ 'description' => '是否开启篡改检测'."\n" .'- true：开启'."\n" .'- false：关闭', 'type' => 'string', 'required' => true, 'example' => '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息的响应消息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '提取结果。取值：'."\n" .'- S：成功。'."\n" .'- F：失败。', 'type' => 'string', 'example' => 'S', ], 'SubCode' => [ 'description' => '认证结果描述', 'type' => 'string', 'example' => '200', ], 'ExtIdInfo' => [ 'description' => '识别的关键信息，JSON格式。', 'type' => 'string', 'example' => '{'."\n" .' "address": "",'."\n" .' "name":""'."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Success\\": \\"S\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '凭证识别', 'description' => '通过AI技术检测凭证（如水、电、煤、信用卡等电子账单）是否存在伪造，并对凭证进行关键信息提取。', ], 'CredentialSubmitIntl' => [ 'summary' => '凭证识别信息提交', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthS6WIN6', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '要接入的产品方案。取值CREDENTIAL_RECOGNITION。', 'type' => 'string', 'required' => true, 'example' => 'CREDENTIAL_RECOGNITION', ], ], [ 'name' => 'SceneCode', 'in' => 'query', 'schema' => [ 'description' => '您自定义的认证场景ID，用于后续控制台输入此场景ID查询相关记录使用。支持长度为10位的字母、数字或下划线的组合。', 'type' => 'string', 'required' => true, 'example' => '123****123', ], ], [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一。', 'type' => 'string', 'required' => true, 'example' => 'e0c34a***353888', ], ], [ 'name' => 'CredentialOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '图片Base64编码。如果您选择此方式传入照片，请注意检查照片大小，不要传入过大的照片。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'CredentialOcrPictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '图片地址，公网可访问的HTTP、HTTPS链接。', 'type' => 'string', 'required' => false, 'example' => 'https://***', ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '凭证类型：'."\n" .'- 02：车辆登记证明', 'type' => 'string', 'required' => true, 'example' => '02', ], ], [ 'name' => 'OcrArea', 'in' => 'query', 'schema' => [ 'description' => '提取类型：'."\n" ."\n" .'- 0201：泰国车辆登记证明', 'type' => 'string', 'required' => true, 'example' => '0201', ], ], [ 'name' => 'FraudCheck', 'in' => 'query', 'schema' => [ 'description' => '是否开启篡改检测'."\n" .'- true：开启'."\n" .'- false：关闭', 'type' => 'string', 'required' => true, 'example' => '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' => '5E63B760-0ECB-5C07-8503-A65C27876968', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => '4ab0b***cbde97', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\"\\n }\\n}","type":"json"}]', 'title' => '凭证识别任务提交（异步）', 'description' => '凭证识别OCR初始化接口，通过本接口获取transactionId。', ], 'CredentialGetResultIntl' => [ 'summary' => '凭证识别结果查询', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthS6WIN6', ], ], 'parameters' => [ [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'required' => true, 'example' => '4ab0b***abde97', ], ], ], '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' => '5E63B760-0ECB-5C07-8503-A65C27876968', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '任务状态：'."\n" .'- PROCESSING：执行中（请继续轮询）'."\n" .'- SUCCESS：执行成功'."\n" .'- FAILED：执行失败', 'type' => 'string', 'example' => 'SUCCESS', ], 'SubCode' => [ 'description' => '认证结果描述。更多信息，请参ResultObject.SubCode错误码说明。', 'type' => 'string', 'example' => '200', ], 'ExtIdInfo' => [ 'description' => '识别的关键信息，JSON格式。', 'type' => 'string', 'example' => '{'."\n" .' "address": "",'."\n" .' "name":""'."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"{\\\\n \\\\\\"address\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '凭证识别结果查询（异步）', 'description' => '当您获取到TransactionId之后，可以在服务端通过该接口获取相应的认证结果。', ], 'CredentialVerifyIntl' => [ 'summary' => '凭证核验服务的API接口。接口可以将传入的凭证图片通过大模型进行图片篡改及伪造检测、图片质量检测。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthNYJI62', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CredType', 'in' => 'query', 'schema' => [ 'description' => '凭证类型：'."\n" ."\n" .'- 03：企业资质类'."\n" .'- 04：交易凭据类', 'type' => 'string', 'required' => true, 'example' => '03', ], ], [ 'name' => 'CredName', 'in' => 'query', 'schema' => [ 'description' => '凭证名称（取数字代码）：'."\n" ."\n" .'- 03开头：企业资质类'."\n" .' - 0301：中国内地工商营业执照'."\n" .'- 04开头，交易凭据'."\n" .' - 0401：银行流水'."\n" .' - 0402：薪资条'."\n" .' - 0403：水电账单'."\n" .' - 0405：信用卡账单'."\n" .' - 0499：其他', 'type' => 'string', 'required' => true, 'example' => '0301', ], ], [ 'name' => 'ImageUrl', 'in' => 'query', 'schema' => [ 'description' => '图片的地址。'."\n" .'> ImageUrl和ImageFile任选其中一个。', 'type' => 'string', 'required' => false, 'example' => 'https://oss-bj01.avic.com/eavic-prod-commodity/pic/commodity/94677ee6-1067-4287-8ff4-6e030ef3a5a8.jpg', ], ], [ 'name' => 'ImageFile', 'in' => 'formData', 'schema' => [ 'description' => '图片输入流。'."\n" .'> ImageUrl和ImageFile任选其中一个。', 'type' => 'string', 'required' => false, 'example' => '无', 'isFileTransferUrl' => true, ], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '调用模式：'."\n" .'- ANTI_FAKE_CHECK：图片质量、篡改检测。', 'type' => 'string', 'required' => true, 'example' => '取值：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' => '风险结果：'."\n" ."\n" .'- **0**：低风险'."\n" .'- **1**：高风险'."\n" .'- **2**：可疑', 'type' => 'string', 'example' => '1', ], 'RiskTag' => [ 'description' => '风险标签，多个标签用半角逗号（,）隔开，包括：'."\n" ."\n" .'- PS：图片PS。'."\n" .'- SCREEN_PHOTO：屏幕翻拍。'."\n" .'- SCREENSHOT：屏幕截屏。'."\n" .'- ORIGINAL_PHOTO：非原始图。', 'type' => 'string', 'example' => 'PS', ], 'RiskScore' => [ 'description' => '风险分值Map', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'example' => '{'."\n" .'"PS": "0.0211",'."\n" .'"SCREEN_PHOTO": "0.0101",'."\n" .'"SCREENSHOT": "0.0521"'."\n" .'}', 'description' => '风险分值', ], ], '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', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"130A2C10-B9EE-4D84-88E3-5384FF039795\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"Result\\": \\"1\\",\\n \\"RiskTag\\": \\"PS\\",\\n \\"RiskScore\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"PS\\\\\\": \\\\\\"0.0211\\\\\\",\\\\n\\\\\\"SCREEN_PHOTO\\\\\\": \\\\\\"0.0101\\\\\\",\\\\n\\\\\\"SCREENSHOT\\\\\\": \\\\\\"0.0521\\\\\\"\\\\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' => '传入凭证图片信息，执行图片质量、篡改及伪造检测，返回检测结果', ], 'AddressVerifyV2Intl' => [ 'summary' => '地址核验', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthZN5W38', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code(固定值：ADD_VERIFY_PRO)', 'type' => 'string', 'required' => true, 'example' => 'ADD_VERIFY_PRO', ], ], [ 'name' => 'VerifyType', 'in' => 'query', 'schema' => [ 'description' => '地址核验方式：'."\n" ."\n" .'- HOME：家庭地址核验'."\n" .'- WORK：工作地址核验', 'type' => 'string', 'required' => false, 'example' => 'HOME', ], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => [ 'description' => '支持中国手机号码', 'type' => 'string', 'required' => false, 'example' => '1872334****', ], ], [ 'name' => 'RegCountry', 'in' => 'query', 'schema' => [ 'description' => '禁止国家列表', 'type' => 'string', 'required' => true, 'example' => '目前仅支持：USA', ], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => [ 'description' => '详细地址文本内容', 'type' => 'string', 'required' => false, 'example' => '江苏省常州市*******小区', ], ], [ 'name' => 'DeviceToken', 'in' => 'query', 'schema' => [ 'description' => '设备Token，用于风险识别。', 'type' => 'string', 'required' => true, 'example' => 'Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o', ], ], ], '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' => '7F971622-38C0-5F56-B2EC-315367979B4F', ], 'Code' => [ 'description' => '接口返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证ID', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d69********', ], 'BizCode' => [ 'description' => '验证结果：'."\n" .'- 1：通过'."\n" .'- 2：不通过(设备位于禁止区域) '."\n" .'- 3：无法判断', 'type' => 'string', 'example' => '1', ], 'Detail' => [ 'description' => '验证详情，包括：'."\n" ."\n" .'- distanceRange：位置区间 '."\n" .'- ispName: 运营商名称 '."\n" .'- phoneStatus：手机状态 0-非正常 1-正常 （未知）', 'type' => 'string', 'example' => '{'."\n" .' "distanceRange": "0-3000",'."\n" .' "ispName": "CTCC",'."\n" .' "phoneStatus": "1"'."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"BizCode\\": \\"1\\",\\n \\"Detail\\": \\"{\\\\n \\\\\\"distanceRange\\\\\\": \\\\\\"0-3000\\\\\\",\\\\n \\\\\\"ispName\\\\\\": \\\\\\"CTCC\\\\\\",\\\\n \\\\\\"phoneStatus\\\\\\": \\\\\\"1\\\\\\"\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '地址核验', ], 'AddressCompareIntl' => [ 'summary' => '地址相似比对', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthNOQ41U', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => 'ADD_VERIFY', 'type' => 'string', 'required' => true, 'example' => '固定值：ADD_VERIFY', ], ], [ 'name' => 'Text1', 'in' => 'query', 'schema' => [ 'description' => '地址1', 'type' => 'string', 'required' => true, 'example' => '杭州市阿里巴巴西溪园区', ], ], [ 'name' => 'Text2', 'in' => 'query', 'schema' => [ 'description' => '地址2', 'type' => 'string', 'required' => true, 'example' => '杭州市文一西路969号1号楼', ], ], [ 'name' => 'DefaultCountry', 'in' => 'query', 'schema' => [ 'description' => '国家名称'."\n" .'- 中国', 'type' => 'string', 'required' => true, 'example' => '固定值：中国', ], ], ], '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' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n", ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'sameLevel取值包括：'."\n" .'- all：完全相同'."\n" .'- prov：省级 '."\n" .'- city：市'."\n" .'- district: 区'."\n" .'- town：街道'."\n" .'- road：道路'."\n" .'- roadno：道路编号'."\n" .'- poi：小区'."\n" .'- roomno: 房号', 'type' => 'string', 'example' => '{'."\n" .' sameLevel: "city", '."\n" .' distance: 5997.34m, -- 地址相差距离'."\n" .' same_info: { -- 相同信息'."\n" .' prov: "浙江省",'."\n" .' city: "杭州市",'."\n" .' district: "西湖区"'."\n" .' } '."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Data\\": \\"{\\\\n sameLevel: \\\\\\"city\\\\\\", \\\\n distance: 5997.34m, -- 地址相差距离\\\\n same_info: { -- 相同信息\\\\n prov: \\\\\\"浙江省\\\\\\",\\\\n city: \\\\\\"杭州市\\\\\\",\\\\n district: \\\\\\"西湖区\\\\\\"\\\\n } \\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '地址相似比对', 'description' => 'API地址，两个地址，地址标准化比对地址一致性。', ], 'KeepaliveIntl' => [ 'summary' => '客户端连接保持', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthNOQ41U', ], ], 'parameters' => [], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => '返回结果', 'type' => 'string', 'example' => 'SUCCESS', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Result\\": \\"SUCCESS\\"\\n }\\n}","type":"json"}]', 'title' => '客户端连接保持', 'description' => '客户端连接保持', ], 'DeleteVerifyResult' => [ 'summary' => '删除用户认证记录相关数据', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'TransactionId', 'in' => 'query', 'schema' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'required' => false, 'example' => '4ab0b***cbde97', ], ], [ 'name' => 'DeleteAfterQuery', 'in' => 'query', 'schema' => [ 'description' => '删除数据时是否依赖查询接口', 'type' => 'string', 'required' => false, 'example' => 'Y / N', ], ], [ 'name' => 'DeleteType', 'in' => 'query', 'schema' => [ 'description' => '删除数据的类型', 'type' => 'string', 'required' => false, 'example' => 'Img / Text / All', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '本次请求的ID', 'type' => 'string', 'example' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'example' => '4ab0b***cbde97', ], 'DeleteResult' => [ 'description' => '删除的结果。其中Y表示删除成功，N表示删除失败', 'type' => 'string', 'example' => 'Y/N', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"4ab0b***cbde97\\",\\n \\"DeleteResult\\": \\"Y/N\\"\\n }\\n}","type":"json"}]', 'title' => '删除认证记录', ], 'CheckVerifyLog' => [ 'summary' => '认证日志查询接口', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266432', 'abilityTreeNodes' => [ 'FEATUREcloudauthCS0SDG', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'formData', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一。', 'type' => 'string', 'required' => false, 'example' => 'e0c34a***353888', ], ], [ 'name' => 'TransactionId', 'in' => 'formData', 'schema' => [ 'description' => '整个认证流程的唯一标识。该值需要调用Initialize获取。', 'type' => 'string', 'required' => false, 'example' => 'hksb7ba1b*********015d694361bee4', ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '后端错误码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过。'."\n" .'- N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '子结果码', 'type' => 'string', 'example' => '200', ], 'VerifyStatus' => [ 'description' => '认证状态，取值：'."\n" ."\n" .'- 0：finished认证完成'."\n" .'- 1：unfinished 认证中断'."\n" .'- 2: notstart 未开始认证', 'type' => 'string', 'example' => '1', ], 'InterruptPage' => [ 'description' => '记录认证中断最后停留页面'."\n" ."\n" .'- 页面未启动'."\n" .'- OCR引导页面'."\n" .'- OCR相机授权'."\n" .'- OCR拍摄证件页面'."\n" .'- OCR识别loading中'."\n" .'- OCR识别结果编辑页面'."\n" .'- OCR识别结果编辑loading中'."\n" .'- 活体检测引导页面'."\n" .'- 活体检测相机授权页面'."\n" .'- 活体检测页面'."\n" .'- 活体检测降级页面'."\n" .'- 活体检测重试'."\n" .'- 活体检测loading中', 'type' => 'string', 'example' => 'OCR拍摄证件页面', ], 'VerifyErrorCode' => [ 'description' => '认证中断错误码'."\n" ."\n" .'- 1000 用户完成了刷脸过程，认证建议结果为通过'."\n" .'- 1001 用户完成了刷脸过程，认证建议结果为未通过'."\n" .'- 1002 系统错误'."\n" .'- 1003 SDK初始化失败，请确认客户端时间是否正确'."\n" .'- 1004 相机权限错误'."\n" .'- 1005 网络错误'."\n" .'- 1006 用户退出'."\n" .'- 1007 TransactionId无效'."\n" .'- 1009 客户端时间戳错误'."\n" .'- 1011 提交证件类型错误'."\n" .'- 1012 识别出的证件关键信息缺失或格式校验失败'."\n" .'- 1013 图片质量不佳'."\n" .'- 1014 错误次数超出上限'."\n" .'- 1015 安卓系统版本过低'."\n" .'- 1016 未获取到相机权限'."\n" .'- 9999 疑似认证进程中断', 'type' => 'string', 'example' => '1001', ], 'LogInfo' => [ 'description' => 'SDK运行日志详情', 'type' => 'array', 'items' => [ 'description' => '运行日志', 'type' => 'string', 'example' => '['."\n" .' "2025-03-21 10:31:25 Loading阶段结束",'."\n" .' "2025-03-21 10:31:25 用户进入OCR页面",'."\n" .' "2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮",'."\n" .' "2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮",'."\n" .' "2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出",'."\n" .' "2025-03-21 10:31:43 OCR认证阶段中断重试",'."\n" .' "2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭",'."\n" .' "2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮",'."\n" .' "2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮",'."\n" .' "2025-03-21 10:32:02 OCR认证阶段结束",'."\n" .' "2025-03-21 10:32:02 用户进入OCR编辑页面",'."\n" .' "2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮",'."\n" .' "2025-03-21 10:32:04 OCR编辑阶段结束",'."\n" .' "2025-03-21 10:32:04 用户进入活体页面",'."\n" .' "2025-03-21 10:32:12 活体检测阶段结束"'."\n" .' ]', ], ], 'ExtInfo' => [ 'description' => '扩展信息', 'type' => 'string', 'example' => '{}', ], 'LogStatisticsInfo' => [ 'description' => 'SDK运行日志统计详情', 'type' => 'string', 'example' => '{'."\n" .' "faceOverTimes": 0,'."\n" .' "hasFaceOverTimes": false,'."\n" .' "hasFacePermissionRefuse": false,'."\n" .' "hasOcrEdit": true,'."\n" .' "hasOcrEditOverTimes": false,'."\n" .' "hasOcrOverTimes": true,'."\n" .' "hasOcrPermissionRefuse": false,'."\n" .' "ocrEditOverTimes": 0,'."\n" .' "ocrEditTimes": 1,'."\n" .' "ocrOverTimes": 1,'."\n" .' "pageStayTimeInfo": {'."\n" .' "LOADING": "1615",'."\n" .' "OCR_SCAN": "37446",'."\n" .' "OCR_RESULT": "1338",'."\n" .' "FACE": "8707"'."\n" .' }'."\n" .' }', ], 'LogInfoEn' => [ 'description' => 'SDK运行链路日志详情，英文取值。'."\n" .'此字段格式同**LogInfo**。', 'type' => 'array', 'items' => [ 'description' => '运行日志', 'type' => 'string', 'example' => '['."\n" .' "2025-03-21 10:31:25 LOADING_ENTER",'."\n" .' "2025-03-21 10:31:25 LOADING_EXIT",'."\n" .' "2025-03-21 10:31:39 GUIDE_PAGE_SHOW",'."\n" .' "2025-03-21 10:31:39 GUIDE_PAGE_LEAVE",'."\n" .' "2025-03-21 10:31:42 FACE_ENTER",'."\n" .' "2025-03-21 10:31:43 FACE_EXIT"'."\n" .']', ], ], 'InterruptPageEn' => [ 'description' => '认证中断最后停留页面，英文取值：'."\n" ."\n" .'当然，以下是将这些取值转换为无序列表的形式：'."\n" ."\n" .'- LOADING'."\n" ."\n" .'- GUIDE'."\n" ."\n" .'- FACE'."\n" ."\n" .'- OCR_SCAN'."\n" ."\n" .'- OCR_RESULT'."\n" ."\n" .'- NFC_INPUT'."\n" ."\n" .'- NFC_READ', 'type' => 'string', 'example' => 'LOADING', ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"VerifyStatus\\": \\"1\\",\\n \\"InterruptPage\\": \\"OCR拍摄证件页面\\",\\n \\"VerifyErrorCode\\": \\"1001\\",\\n \\"LogInfo\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 Loading阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 用户进入OCR页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 OCR认证阶段中断弹窗弹出\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断重试\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 OCR认证阶段中断弹窗关闭\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击相册选择按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:59 OCR认证阶段点击OCR提交按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 OCR认证阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:02 用户进入OCR编辑页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:03 OCR编辑阶段点击OCR结果确认无误按钮\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 OCR编辑阶段结束\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:04 用户进入活体页面\\\\\\",\\\\n \\\\\\"2025-03-21 10:32:12 活体检测阶段结束\\\\\\"\\\\n ]\\"\\n ],\\n \\"ExtInfo\\": \\"{}\\",\\n \\"LogStatisticsInfo\\": \\"{\\\\n \\\\\\"faceOverTimes\\\\\\": 0,\\\\n \\\\\\"hasFaceOverTimes\\\\\\": false,\\\\n \\\\\\"hasFacePermissionRefuse\\\\\\": false,\\\\n \\\\\\"hasOcrEdit\\\\\\": true,\\\\n \\\\\\"hasOcrEditOverTimes\\\\\\": false,\\\\n \\\\\\"hasOcrOverTimes\\\\\\": true,\\\\n \\\\\\"hasOcrPermissionRefuse\\\\\\": false,\\\\n \\\\\\"ocrEditOverTimes\\\\\\": 0,\\\\n \\\\\\"ocrEditTimes\\\\\\": 1,\\\\n \\\\\\"ocrOverTimes\\\\\\": 1,\\\\n \\\\\\"pageStayTimeInfo\\\\\\": {\\\\n \\\\\\"LOADING\\\\\\": \\\\\\"1615\\\\\\",\\\\n \\\\\\"OCR_SCAN\\\\\\": \\\\\\"37446\\\\\\",\\\\n \\\\\\"OCR_RESULT\\\\\\": \\\\\\"1338\\\\\\",\\\\n \\\\\\"FACE\\\\\\": \\\\\\"8707\\\\\\"\\\\n }\\\\n }\\",\\n \\"LogInfoEn\\": [\\n \\"[\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:25 LOADING_EXIT\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_SHOW\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:39 GUIDE_PAGE_LEAVE\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:42 FACE_ENTER\\\\\\",\\\\n \\\\\\"2025-03-21 10:31:43 FACE_EXIT\\\\\\"\\\\n]\\"\\n ],\\n \\"InterruptPageEn\\": \\"LOADING\\"\\n }\\n}","type":"json"}]', 'title' => '认证日志查询', ], 'AddFaceRecord' => [ 'summary' => '添加人脸图片到指定人脸库', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'FaceGroupCode', 'in' => 'formData', 'schema' => [ 'description' => '人脸库编码。', 'type' => 'string', 'required' => true, 'example' => 'sgl****7uc', ], ], [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => true, 'example' => 'FACE_ENROLL', ], ], [ 'name' => 'MerchantUserId', 'in' => 'formData', 'schema' => [ 'description' => '自定义的用户唯一ID，不能超过32位。'."\n" .'- 若客户传入优先以该MerchantUserId注册；'."\n" .'- 若未传入默认选图片名', 'type' => 'string', 'required' => false, 'example' => '130A2C10B9EE4D8488E35384FF03hst', ], ], [ 'name' => 'FacePicture', 'in' => 'formData', 'schema' => [ 'description' => '注册人脸图片base64', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'FacePictureUrl', 'in' => 'formData', 'schema' => [ 'description' => '注册人脸图片URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxxxx.com/test.jpg', ], ], [ 'name' => 'FacePictureFile', 'in' => 'formData', 'schema' => [ 'description' => '注册人脸图片文件流', 'type' => 'string', 'required' => false, 'example' => 'InputStream', 'isFileTransferUrl' => true, ], ], [ 'name' => 'FaceQualityCheck', 'in' => 'formData', 'schema' => [ 'description' => '是否检测人脸图片质量'."\n" .'- Y：开启'."\n" .'- N：关闭（默认）', 'type' => 'string', 'required' => false, 'example' => 'N', ], ], ], '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' => '7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'Passed' => [ 'description' => '认证是否通过'."\n" ."\n" .'- Y：通过'."\n" .'- N：不通过', 'type' => 'string', 'example' => 'Y', ], 'ExtFaceInfo' => [ 'description' => '人脸结果信息', 'type' => 'string', 'example' => '{'."\n" .'"faceQuality": "HIGH"'."\n" .'}'."\n" ."\n", ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A0D192A-CC0C-5DE5-A3B6-A14CF45508F2\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"Passed\\": \\"Y\\",\\n \\"ExtFaceInfo\\": \\"{\\\\n\\\\\\"faceQuality\\\\\\": \\\\\\"HIGH\\\\\\"\\\\n}\\\\n\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => '添加人脸记录', ], 'DownloadVerifyRecordIntl' => [ 'summary' => '核验任务下载。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225500', 'abilityTreeNodes' => [ 'FEATUREcloudauth6RJHVQ', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Code', 'in' => 'query', 'schema' => [ 'description' => '查询code。', 'type' => 'string', 'required' => false, 'example' => 'vrf_intl_verify_record_real_id_idv_invoke_statistics_query', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => '导出下载查询任务的相关参数。', 'type' => 'string', 'required' => false, 'example' => '{\\"productCode\\":\\"FACE_LIVENESS\\",\\"startDs\\":\\"20251121\\",\\"endDs\\":\\"20251128\\",\\"language\\":\\"en\\"}', ], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ 'description' => '产品Code。', 'type' => 'string', 'required' => false, 'example' => 'KYC', ], ], [ 'name' => 'DownloadMode', 'in' => 'query', 'schema' => [ 'description' => '下载模式：'."\n" ."\n" .'- **async**：异步'."\n" .'- **sync**：同步', 'type' => 'string', 'required' => false, 'example' => 'async', ], ], [ 'name' => 'BizType', 'in' => 'query', 'schema' => [ 'description' => '业务类型：'."\n" .'- INVOKE_STATISTICS'."\n" .'- INVOKE_RECORD', 'type' => 'string', 'required' => false, 'example' => 'INVOKE_RECORD', ], ], ], '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' => '86C40EC3-5940-5F47-995C-BFE90B70E540'."\n", ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回消息。', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'DownloadTaskId' => [ 'description' => '任务id，异步模式返回，后续使用QueryDownloadTaskIntl下载导出文件。', 'type' => 'string', 'example' => '202511284106866', ], 'Url' => [ 'description' => '导出文件下载链接。', 'type' => 'string', 'example' => 'https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\\\n\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"DownloadTaskId\\": \\"202511284106866\\",\\n \\"Url\\": \\"https://cn-shanghai-aliyun-cloudauth.oss-cn-shanghai.aliyuncs.com/console/xxxxxx/KYC_INVOKE_STATISTICS.xlxs\\"\\n }\\n}","type":"json"}]', 'title' => '下载认证记录', ], 'QueryFaceGroup' => [ 'summary' => '查询人脸库', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '人脸库名称。', 'type' => 'string', 'required' => false, 'example' => 'test008', ], ], [ 'name' => 'GroupCode', 'in' => 'query', 'schema' => [ 'description' => '人脸库编码。', 'type' => 'string', 'required' => false, 'example' => 'groupCode001', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '查询每页数目。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ 'description' => '每页的最大数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => 'WpY9RBGa5Vrzxi3+mp2Cdw==', ], ], ], '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' => '5E63B760-0ECB-5C07-8503-A65C27876968', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'TotalCount' => [ 'description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TotalPage' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CurrentPage' => [ 'description' => '当前查询页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '查询每页数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Items' => [ 'description' => '返回信息列表。', 'type' => 'array', 'items' => [ 'description' => '对象详情。', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '162261', ], 'Name' => [ 'description' => '人脸库名称。', 'type' => 'string', 'example' => 'test-888', ], 'Code' => [ 'description' => '人脸库编码。', 'type' => 'string', 'example' => 'faceGroup001', ], 'Description' => [ 'description' => '描述。', 'type' => 'string', 'example' => 'desc', ], ], ], ], 'MaxResults' => [ 'description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'NextToken' => [ 'description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'N/zmQeG/x9TDWmaB/pbfBQ==', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E63B760-0ECB-5C07-8503-A65C27876968\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 0,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 100,\\n \\"Items\\": [\\n {\\n \\"Id\\": 162261,\\n \\"Name\\": \\"test-888\\",\\n \\"Code\\": \\"faceGroup001\\",\\n \\"Description\\": \\"desc\\"\\n }\\n ],\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"N/zmQeG/x9TDWmaB/pbfBQ==\\"\\n}","type":"json"}]', 'title' => '查询人脸库', ], 'ModifyFaceGroup' => [ 'summary' => '修改人脸库', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => [ 'description' => '主键ID', 'type' => 'string', 'required' => false, 'example' => '65c030cd54b23283ceb27b4ade5da49d', ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'description' => '人脸库名称。', 'type' => 'string', 'required' => true, 'example' => 'test008', ], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => [ 'description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'description', ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '修改人脸库', ], 'DeleteFaceGroup' => [ 'summary' => '删除人脸库', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => [ 'description' => '主键ID', 'type' => 'string', 'required' => true, 'example' => '16681', ], ], ], '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' => '595E387B-3F0E-5C52-BD02-8EFE63D41FD5', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"595E387B-3F0E-5C52-BD02-8EFE63D41FD5\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '删除人脸库', ], 'QueryFaceRecord' => [ 'summary' => '查询人脸记录', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'FaceId', 'in' => 'query', 'schema' => [ 'description' => '⼈脸ID。', 'type' => 'string', 'required' => false, 'example' => '5006538', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '商户用户ID。', 'type' => 'string', 'required' => false, 'example' => 'CuN6hiD08qr', ], ], [ 'name' => 'RegistrationType', 'in' => 'query', 'schema' => [ 'description' => '注册类型。', 'type' => 'string', 'required' => false, 'example' => 'MANUAL', ], ], [ 'name' => 'FaceGroupCode', 'in' => 'query', 'schema' => [ 'description' => '人脸库编码。', 'type' => 'string', 'required' => true, 'example' => 'Cu****D08q', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '查询每页数目。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ 'description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => '用于请求下一页检索的结果。', 'type' => 'string', 'required' => false, 'example' => 'AAAAARbaCuN6hiD08qrLdwJ9Fh0OP1yH8z+7FV4KKGUw4X32', ], ], ], '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' => '7F971622-38C0-5F56-B2EC-315367979B4F', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'TotalCount' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '6', ], 'TotalPage' => [ 'description' => '页码总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CurrentPage' => [ 'description' => '当前查询页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'PageSize' => [ 'description' => '每页数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Items' => [ 'description' => '返回信息列表', 'type' => 'array', 'items' => [ 'description' => '返回对象详情。', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16112', ], 'FaceId' => [ 'description' => '⼈脸ID。', 'type' => 'string', 'example' => '230642938', ], 'GmtCreate' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-01-15T02:20:28Z', ], 'RegistrationType' => [ 'description' => '注册类型。', 'type' => 'string', 'example' => 'MANUAL', ], 'ImgOssUrl' => [ 'description' => '人脸图片地址。', 'type' => 'string', 'example' => 'http://www.xxxx.com/1.jpg', ], 'MerchantUserId' => [ 'description' => '商户用户ID。', 'type' => 'string', 'example' => 'CuN6hiD08qr', ], ], ], ], 'MaxResults' => [ 'description' => '每页的最大数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NextToken' => [ 'description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F971622-38C0-5F56-B2EC-315367979B4F\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"TotalCount\\": 6,\\n \\"TotalPage\\": 1,\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 10,\\n \\"Items\\": [\\n {\\n \\"Id\\": 16112,\\n \\"FaceId\\": \\"230642938\\",\\n \\"GmtCreate\\": \\"2025-01-15T02:20:28Z\\",\\n \\"RegistrationType\\": \\"MANUAL\\",\\n \\"ImgOssUrl\\": \\"http://www.xxxx.com/1.jpg\\",\\n \\"MerchantUserId\\": \\"CuN6hiD08qr\\"\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"AAAAARfZmVDe9NvRXloR5+8CK9nwqHyx44CQz3pa71+mmu0e\\"\\n}","type":"json"}]', 'title' => '查询人脸记录', ], 'ModifyFaceRecord' => [ 'summary' => '编辑人脸记录', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ImgOssInfos', 'in' => 'formData', 'schema' => [ 'description' => '图片oss信息。', 'type' => 'string', 'required' => true, 'example' => 'JSON', ], ], [ 'name' => 'FaceGroupCode', 'in' => 'formData', 'schema' => [ 'description' => '人脸库编码。', 'type' => 'string', 'required' => true, 'example' => '4EB35****87', ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '结果。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '编辑人脸记录', ], 'DeleteFaceRecord' => [ 'summary' => '删除人脸记录', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => [ 'description' => '主键ID', 'type' => 'string', 'required' => false, 'example' => '344537', ], ], ], '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' => '4EB35****87EBA1', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": 1\\n}","type":"json"}]', 'title' => '删除人脸记录', ], 'TempOssUrlIntl' => [ 'summary' => '获取文件临时地址', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthHJ4WQV', ], ], 'parameters' => [ [ 'name' => 'ObjectName', 'in' => 'formData', 'schema' => [ 'description' => '对象名。', 'type' => 'string', 'required' => true, 'example' => '20250512/pdf/579047.pdf', ], ], ], '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' => 'EFA11401-C961-5E89-A2D3-BF9883E5CC3D', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '结果。', 'type' => 'object', 'properties' => [ 'Url' => [ 'description' => '文件url', 'type' => 'string', 'example' => 'http://bzxh.cdn.weijin365.com/assets/index-55338127.png', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFA11401-C961-5E89-A2D3-BF9883E5CC3D\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://bzxh.cdn.weijin365.com/assets/index-55338127.png\\"\\n }\\n}","type":"json"}]', 'title' => '获取文件临时地址', ], 'TempAccessTokenIntl' => [ 'summary' => '获取临时token', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREcloudauthNYJI62', ], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'description' => '类型。', 'type' => 'string', 'required' => false, 'example' => 'none', ], ], ], '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' => '86C40EC3-5940-5F47-995C-BFE90B70E540', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'AccessKeyId' => [ 'description' => '文件上传临时凭证的AccessKeyId。', 'type' => 'string', 'example' => '***', ], 'AccessKeySecret' => [ 'description' => '临时授权secret。', 'type' => 'string', 'example' => '3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk', ], 'SecurityToken' => [ 'description' => '文件上传临时凭证的安全令牌。', 'type' => 'string', 'example' => '***', ], 'OssEndPoint' => [ 'description' => 'OssEndPoint。', 'type' => 'string', 'example' => ' ossEndPoint', ], 'BucketName' => [ 'description' => '存储空间名称。', 'type' => 'string', 'example' => 'liyi', ], 'FileNamePrefix' => [ 'description' => '文件前缀。', 'type' => 'string', 'example' => 'test001', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"***\\",\\n \\"AccessKeySecret\\": \\"3hxuRpEJ3Jv2Rtzyg4HooFCYqps762XcNtzhn19wQymk\\",\\n \\"SecurityToken\\": \\"***\\",\\n \\"OssEndPoint\\": \\" ossEndPoint\\",\\n \\"BucketName\\": \\"liyi\\",\\n \\"FileNamePrefix\\": \\"test001\\"\\n }\\n}","type":"json"}]', 'title' => '获取临时token', ], 'CardOcr' => [ 'summary' => '卡证Ocr纯服务端能力Api。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '178782', 'abilityTreeNodes' => [ 'FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H', ], ], 'parameters' => [ [ 'name' => 'MerchantBizId', 'in' => 'query', 'schema' => [ 'description' => '商户侧自定义的业务唯一标识，用于后续定位排查问题使用。支持字母和数字的组合，长度最长32位，请确保唯一', 'type' => 'string', 'required' => false, 'example' => 'dso9322***dsjsd22', ], ], [ 'name' => 'MerchantUserId', 'in' => 'query', 'schema' => [ 'description' => '商户用户ID，或可用于识别特定用户的其他标识符，例如手机号码、电子邮件地址等。强烈建议对userId字段的值进行预脱敏处理，例如对该值进行hash处理', 'type' => 'string', 'required' => false, 'example' => '123456789', ], ], [ 'name' => 'IdOcrPictureBase64', 'in' => 'formData', 'schema' => [ 'description' => '证件正面图片base64编码。', 'type' => 'string', 'required' => false, 'example' => 'base64', ], ], [ 'name' => 'IdOcrPictureUrl', 'in' => 'query', 'schema' => [ 'description' => '证件正面图片URL', 'type' => 'string', 'required' => false, 'example' => 'https://digital-cardocr-prod8.oss-cn-hangzhou.aliyuncs.com/1669520556530-expo/default/face/20221127114236530_w3kx2e6t.jpg'."\n", ], ], [ 'name' => 'DocType', 'in' => 'query', 'schema' => [ 'description' => '证件类型。', 'type' => 'string', 'required' => false, 'example' => '00000006', ], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '产品code', 'type' => 'string', 'required' => false, 'example' => 'ID_OCR_MIN', ], ], [ 'name' => 'Ocr', 'in' => 'query', 'schema' => [ 'description' => '是否进行证件OCR'."\n" .'- T：表示需要证件OCR（默认T）'."\n" .'- F：表示不需要', 'type' => 'string', 'required' => false, 'example' => 'T', ], ], [ 'name' => 'IdFaceQuality', 'in' => 'query', 'schema' => [ 'description' => '是否进行证脸质量检测'."\n" .'- T：表示需要检测'."\n" .'- F：表示需要检测（默认F）', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], [ 'name' => 'Spoof', 'in' => 'query', 'schema' => [ 'description' => '是否开启防伪检测'."\n" .'- T：表示开启防伪'."\n" .'- F：表示关闭（默认F）', 'type' => 'string', 'required' => false, 'example' => 'F', ], ], ], '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' => '4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], 'Result' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识', 'type' => 'string', 'example' => '08573be80f944d95ac812e019e3655a8', ], 'Passed' => [ 'description' => '认证是否通过。'."\n" ."\n" .'- Y：通过。'."\n" .'- N：不通过。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '子结果码。', 'type' => 'string', 'example' => '200', ], 'ExtIdInfo' => [ 'description' => '额外结果信息', 'type' => 'string', 'example' => '**', ], 'ExtCardInfo' => [ 'description' => '卡证识别结果', 'type' => 'string', 'example' => '{'."\n" .' "idFaceQualityScore": 98.90,'."\n" .' "ocrIdInfo": {'."\n" .' "expiryDate": "2024-04-20",'."\n" .' "placeOfIssue": "广东",'."\n" .' "englishName": "ZHENGJIAN,YANGBEN",'."\n" .' "originOfIssue": "公安部出入境管理局",'."\n" .' "sex": "女",'."\n" .' "name": "证件样本",'."\n" .' "idNumber": "C00000000",'."\n" .' "issueDate": "2014-04-21",'."\n" .' "birthDate": "1981-08-03"'."\n" .' },'."\n" .' "spoofInfo": {'."\n" .' "spoofResult": "N",'."\n" .' "spoofType": ['."\n" .' "SCREEN_REMARK"'."\n" .' ]'."\n" .' }'."\n" .'}', ], ], ], ], ], ], ], 'staticInfo' => [ 'substitutions' => [ 'Cloudauth-intl::2022-08-09::DocOcr', ], 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB356FE-BB6A-5DCC-B4C5-E8051787EBA1\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\",\\n \\"Result\\": {\\n \\"TransactionId\\": \\"08573be80f944d95ac812e019e3655a8\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"ExtIdInfo\\": \\"**\\",\\n \\"ExtCardInfo\\": \\"{\\\\n \\\\\\"idFaceQualityScore\\\\\\": 98.90,\\\\n \\\\\\"ocrIdInfo\\\\\\": {\\\\n \\\\\\"expiryDate\\\\\\": \\\\\\"2024-04-20\\\\\\",\\\\n \\\\\\"placeOfIssue\\\\\\": \\\\\\"广东\\\\\\",\\\\n \\\\\\"englishName\\\\\\": \\\\\\"ZHENGJIAN,YANGBEN\\\\\\",\\\\n \\\\\\"originOfIssue\\\\\\": \\\\\\"公安部出入境管理局\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"女\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"证件样本\\\\\\",\\\\n \\\\\\"idNumber\\\\\\": \\\\\\"C00000000\\\\\\",\\\\n \\\\\\"issueDate\\\\\\": \\\\\\"2014-04-21\\\\\\",\\\\n \\\\\\"birthDate\\\\\\": \\\\\\"1981-08-03\\\\\\"\\\\n },\\\\n \\\\\\"spoofInfo\\\\\\": {\\\\n \\\\\\"spoofResult\\\\\\": \\\\\\"N\\\\\\",\\\\n \\\\\\"spoofType\\\\\\": [\\\\n \\\\\\"SCREEN_REMARK\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => '卡证Ocr纯服务端能力Api', ], 'FraudResultCallBack' => [ 'summary' => 'ekyc-global防伪回调接口', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '184671', 'abilityTreeNodes' => [ 'FEATUREcloudauthCW0JNH', 'FEATUREcloudauthHOSIED', 'FEATUREcloudauthWSJE4H', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CertifyId', 'in' => 'query', 'schema' => [ 'description' => '实人认证唯一标识,对应蚂蚁的verifyId', 'type' => 'string', 'required' => false, 'example' => 'shs2b27333914876c01de4cb22f5841f', ], ], [ 'name' => 'ResultCode', 'in' => 'query', 'schema' => [ 'description' => '防伪是否通过'."\n" .'- PASS (通过)'."\n" .'- REJECT (不通过)', 'type' => 'string', 'required' => false, 'example' => 'PASS', ], ], [ 'name' => 'VerifyDeployEnv', 'in' => 'query', 'schema' => [ 'description' => '环境路由参数'."\n" .'- staging (预发环境)'."\n" .'- production (线上环境)', 'type' => 'string', 'required' => false, 'example' => 'production', ], ], [ 'name' => 'ExtParams', 'in' => 'query', 'schema' => [ 'description' => '扩展参数，json字符串。', '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', 'type' => 'string', 'example' => '4EB35****87EBA1', ], 'Success' => [ 'description' => '是否调用成功。'."\n" .'- **true**：调用成功。'."\n" .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'description' => '返回信息', 'type' => 'string', 'example' => 'success', ], ], ], ], ], 'staticInfo' => [ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EB35****87EBA1\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', 'title' => '防伪回调接口', ], 'AddressVerifyIntl' => [ 'summary' => '常用地址核验 API 基于运营商能力，通过手机号码、地址（或经纬度），验证传入地址是否属于该用户的常住地址。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREcloudauthZN5W38', ], ], 'parameters' => [ [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => [ 'description' => '固定值：ADD_VERIFY_PRO', 'type' => 'string', 'required' => true, 'example' => 'ADD_VERIFY_PRO', ], ], [ 'name' => 'VerifyType', 'in' => 'query', 'schema' => [ 'description' => '地址核验方式：'."\n" .'- HOME：家庭地址核验'."\n" .'- WORK：工作地址核验', 'type' => 'string', 'required' => true, 'example' => 'HOME', ], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => [ 'description' => '支持中国手机号码。', 'type' => 'string', 'required' => true, 'example' => '1872334****', ], ], [ 'name' => 'DefaultCountry', 'in' => 'query', 'schema' => [ 'description' => '国家名称，当前仅支持：中国', 'type' => 'string', 'required' => true, 'example' => '中国', ], ], [ 'name' => 'AddressType', 'in' => 'query', 'schema' => [ 'description' => '验证地址类型：'."\n" .'- “0”：文本地址'."\n" .'- “1”：经纬度', 'type' => 'string', 'required' => true, 'example' => '“0”', ], ], [ 'name' => 'Longitude', 'in' => 'query', 'schema' => [ 'description' => '经度。', 'type' => 'string', 'required' => false, 'example' => '“121.4737”', ], ], [ 'name' => 'Latitude', 'in' => 'query', 'schema' => [ 'description' => '纬度。', 'type' => 'string', 'required' => false, 'example' => '“31.2304”', ], ], [ 'name' => 'Text', 'in' => 'query', 'schema' => [ 'description' => '详细地址文本内容', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴西溪园区', ], ], [ 'name' => 'DefaultProvince', 'in' => 'query', 'schema' => [ 'description' => '默认省份', 'type' => 'string', 'required' => false, 'example' => '浙江省', ], ], [ 'name' => 'DefaultCity', 'in' => 'query', 'schema' => [ 'description' => '默认城市', 'type' => 'string', 'required' => false, 'example' => '杭州市', ], ], [ 'name' => 'DefaultDistrict', 'in' => 'query', 'schema' => [ 'description' => '默认行政区', '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。', 'type' => 'string', 'example' => '86C40EC3-5940-5F47-995C-BFE90B70E540', ], 'Code' => [ 'description' => '返回码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'success', ], 'ResultObject' => [ 'description' => '返回的结果信息。', 'type' => 'object', 'properties' => [ 'TransactionId' => [ 'description' => '认证请求的唯一标识。', 'type' => 'string', 'example' => 'hksb7ba1b28130d24e015d69********', ], 'Passed' => [ 'description' => '核验结果，取值：'."\n" .'- Y：是，验证地址距离小于等于10KM。'."\n" .'- N：否，验证地址距离大于10KM。', 'type' => 'string', 'example' => 'Y', ], 'SubCode' => [ 'description' => '认证结果描述。', 'type' => 'string', 'example' => '200', ], 'AddressInfo' => [ 'description' => '地址核验详情信息。', 'type' => 'string', 'example' => '0-3000', ], 'IspName' => [ 'description' => '运营商名称：'."\n" .'- CMCC：中国移动'."\n" .'- CTCC：中国电信'."\n" .'- CUCC：中国联通', 'type' => 'string', 'example' => 'CMCC', ], ], ], ], ], ], ], 'staticInfo' => [ 'substitutions' => [ 'Cloudauth-intl::2022-08-09::AddressVerifyV2Intl', ], 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86C40EC3-5940-5F47-995C-BFE90B70E540\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"ResultObject\\": {\\n \\"TransactionId\\": \\"hksb7ba1b28130d24e015d69********\\",\\n \\"Passed\\": \\"Y\\",\\n \\"SubCode\\": \\"200\\",\\n \\"AddressInfo\\": \\"0-3000\\",\\n \\"IspName\\": \\"CMCC\\"\\n }\\n}","type":"json"}]', 'title' => '地址核验', 'description' => '基于运营商能力，输入手机号码、地址（或经纬度），验证传入地址是否属于该用户的常住地址。', ], ], 'endpoints' => [ [ 'regionId' => 'cn-hongkong', 'endpoint' => 'cloudauth-intl.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'cloudauth-intl.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'cloudauth-intl.ap-southeast-5.aliyuncs.com', ], ], ];