<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'ROA',
        'product' => 'facebody',
        'version' => '2020-09-10',
    ],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => [
                'ExecuteServerSideVerification',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ExecuteServerSideVerification' => [
            'summary' => '本文介绍人脸核身服务端ExecuteServerSideVerification的语法及示例。',
            'path' => '/viapi/thirdparty/realperson/execServerSideVerification',
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => [
                'application/x-www-form-urlencoded',
            ],
            'produces' => [
                'application/json',
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'certificateName',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '真实姓名。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '张三',
                    ],
                ],
                [
                    'name' => 'certificateNumber',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '身份证号。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '1281739873298172981',
                    ],
                ],
                [
                    'name' => 'facialPictureData',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '与**facialPictureUrl**二选一。'."\n"
                            .'待比对的图像，Base64格式，只支持JPG格式图片。必须是"/9j/"开头，如非"/9j/"开头请检查是否为JPG格式图片。文件的Base64编码处理操作，请参见[文件Base64处理](~~468191~~)。',
                        'type' => 'string',
                        'required' => false,
                        'example' => '/9j/wwew...',
                    ],
                ],
                [
                    'name' => 'facialPictureUrl',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '与**facialPictureData**二选一。'."\n"
                            .'待比对的图像URL地址，只支持JPG格式图片。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见[文件URL处理](~~155645~~)。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'http://xxx.xxx.com/xxx.jpg',
                    ],
                ],
                [
                    'name' => 'sceneType',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '场景类型，默认为`server`。目前只支持`server`。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'server',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => '返回结构体。',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '请求ID。',
                                'type' => 'string',
                                'example' => 'CE2FFC8A-6669-4F02-B4DA-95888087FBDC',
                            ],
                            'Data' => [
                                'description' => '返回的结果数据内容。',
                                'type' => 'object',
                                'properties' => [
                                    'Pass' => [
                                        'description' => '验证是否成功。'."\n"
                                            ."\n"
                                            .'- true：验证成功。'."\n"
                                            .'- false：验证失败。',
                                        'type' => 'boolean',
                                        'example' => 'true',
                                    ],
                                    'VerificationToken' => [
                                        'description' => '验证Token，主要用于排查问题。',
                                        'type' => 'string',
                                        'example' => '6f1f730e732b232ccbdd85abc751****',
                                    ],
                                    'Reason' => [
                                        'description' => '认证结果原因。'."\n"
                                            ."\n"
                                            .'- 认证通过(Z8120)。'."\n"
                                            .'- 抱歉，没有认出您(Z1146)。',
                                        'type' => 'string',
                                        'example' => '认证通过(Z8120)',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => [],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"CE2FFC8A-6669-4F02-B4DA-95888087FBDC\\",\\n  \\"Data\\": {\\n    \\"Pass\\": true,\\n    \\"VerificationToken\\": \\"6f1f730e732b232ccbdd85abc751****\\",\\n    \\"Reason\\": \\"认证通过(Z8120)\\"\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>CE2FFC8A-6669-4F02-B4DA-95888087FBDC</RequestId>\\n<Data>\\n    <Pass>true</Pass>\\n    <VerificationToken>6f1f730e732b232ccbdd85abc751****</VerificationToken>\\n    <Reason>认证通过(Z8120)</Reason>\\n</Data>","errorExample":""}]',
            'title' => '人脸核身服务端',
            'description' => '## 功能描述'."\n"
                .'人脸核身服务端能力可以在服务端依据被验证的人名和身份证号码，请求身份验证的用户图像信息。'."\n"
                ."\n"
                .'> - 您可以进入[在线咨询](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2)获取在线人工帮助。'."\n"
                .'- 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。'."\n"
                ."\n"
                .'## 应用场景'."\n"
                .'- 金融机构网上开户：在金融行业手机App注册开户，通过实人认证，验证开户用户真实身份，降低运营成本，提升风控水平。'."\n"
                .'- 线上政务平台注册：疫情期间，政府在App中推出线上口罩预约功能，实施实人认证，可有效防止同一人当天重复领取口罩，导致分配不均。'."\n"
                .'- 修改密码或手机号码：在移动互联网App修改密码，或绑定手机号码时，通过实人认证进行用户真实身份确认。'."\n"
                .'- 网约车司机认证：网约车当前运营司机身份确认，防止冒用身份驾驶运营车辆。'."\n"
                .'- 金融风控：在支付、挂失、解冻、转账、取款、信贷、理财等各个环节进行用户身份验证，做好金融风险管控。'."\n"
                ."\n"
                .'## 特色优势'."\n"
                ."\n"
                .'- 金融级的指标：误识率低于1/100000，准确率高于99%。'."\n"
                .'- 成熟行业应用：服务超过2亿互联网金融用户，保障超过20亿次交易安全。'."\n"
                .'- 秒级活体检测：无需复杂交互动作，只需秒级即可完成活体检测，更高效，同时也具备更高级别私密性，更高安全性。'."\n"
                .'- 通过金融级防攻击测试：抵御各种真实发生的伪造攻击，权威数据源验证。'."\n"
                .'- 低成本落地方案：纯软件方案，支持普通摄像头，成本极低，适配室内外。'."\n"
                .'- 国内外权威认证：通过公安部认证、ISO 27001信息安全体系认证，ISO30107-3人脸活体防攻击认证（iBeta PAD Level1）， ISO/TC68。'."\n"
                ."\n"
                .'## 接入指引'."\n"
                .'1. 注册阿里云账号：打开[阿里云官网](https://www.aliyun.com)，在阿里云官网右上角，单击**立即注册**，按照操作提示完成账号注册。'."\n"
                .'2. 开通能力：请确保您已开通[人脸人体服务](https://vision.aliyun.com/facebody)，若未开通服务请[立即开通](https://common-buy.aliyun.com/?commodityCode=viapi_facebody_public_cn#/open)。'."\n"
                ."\n"
                .'><notice>'."\n"
                .'本能力支持企业或个人认证用户开通。更多实名认证操作信息，请参见[实名认证](https://help.aliyun.com/knowledge_list/37170.html)。'."\n"
                .'></notice>'."\n"
                ."\n"
                .'3. 创建AccessKey：请确保您已[创建AccessKey](~~175144~~)，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见[RAM授权](~~145025~~)。'."\n"
                .'4. 在线调试（可选）：您可以通过[OpenAPI Explorer](https://next.api.aliyun.com/api/facebody/2020-09-10/ExecuteServerSideVerification?lang=JAVA)在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。'."\n"
                .'5. 开发接入步骤：'."\n"
                .'- 在[SDK总览](~~145033~~)中选择您要接入使用的SDK语言。'."\n"
                .'- 在对应语言的SDK文档中找到AI类目为人脸人体（facebody）的SDK包进行安装。'."\n"
                .'- 参考文档中提供的示例代码进行适当修改后调用。'."\n"
                ."\n"
                .'6. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。'."\n"
                .'- [Web前端直接调用](~~467779~~)'."\n"
                .'- [小程序场景下直接调用](~~467780~~)'."\n"
                .'- [Android端直接调用](~~467781~~)'."\n"
                .'- [iOS端直接调用](~~467782~~)'."\n"
                ."\n"
                .'## 输入限制'."\n"
                .'- 图像格式：仅支持JPG格式。'."\n"
                .'- 图像大小：不超过1 MB。'."\n"
                .'- 图片分辨率：大于640×480像素，小于2048×2048像素，长宽比小于等于2。'."\n"
                .'- URL地址中不能包含中文字符。'."\n"
                .'- 建议图像中人脸五官区域轮廓完整，无明显遮挡，图片无旋转，图片无水印。'."\n"
                ."\n"
                .'> 当图像分辨率超过最大限制时，请先将图片进行缩放，调整图片大小，具体请参见[图片缩放](~~44688~~)。'."\n"
                ."\n"
                .'## 计费说明'."\n"
                .'关于人脸核身服务端的计费方式及报价，请参见[计费介绍](~~184049~~)。'."\n"
                ."\n"
                .'> 下方调试接口为付费接口。',
            'responseParamsDescription' => '## SDK参考'."\n"
                .'阿里云视觉AI能力支持使用SDK调用，具体可参见[服务端接入教程](~~201378~~)下载安装。',
            'extraInfo' => '## 错误码'."\n"
                .'关于人脸核身服务端的错误码如下表所示。'."\n"
                .'| 状态码 | 错误码            | 描述                                                         |'."\n"
                .'| ------ | ----------------- | ------------------------------------------------------------ |'."\n"
                .'| 200    | 无错误码          | 刷脸认证通过。                                               |'."\n"
                .'| 400    | INVALID_PARAMETER | 初始化时传入的参数不正确，请检查各个传参是否符合预期。（Z8121） |'."\n"
                .'| 200    | 无错误码   | 刷脸认证未通过。抱歉，没有认出您。（Z1146） |'."\n"
                .'| 500    | PROCESSING        | 刷脸认证未完成。请重试，如果一直不成功，联系接口提供方技术人员排查。 |'."\n"
                .'| 500    | PROCESSING        | 图片安全检测不通过，请确认图片是否为正常拍摄图片。 |'."\n"
                .'| 500    | PROCESSING        | 系统出错了，请您稍后再试，如果多次重试依然报错，请记录好RequestId联系阿里云技术支持工程师。（Z5137） |'."\n"
                .'| 400    | UNABLE_GET_IMAGE  | 抱歉，您暂时无法使用刷脸服务。（Z1104） |'."\n"
                .'| 400    | HIGH_RISK         | 刷脸频次过高或失败次数过多，请您稍后再试。 |'."\n"
                .'| 400    | PRODUCT_NOT_OPEN      | 当前租户未开通可信实人认证产品。 |'."\n"
                .'| 400    | INITIALIZE_INVALID_SCENEID      | 认证场景配置不存在，请先在控制台上创建认证场景。（Z8107）|'."\n"
                .'| 400    | INITIALIZE_INVALID_CERT_NAME      | 姓名无效，请填写正确的姓名。（Z8109）|'."\n"
                .'| 400    | INITIALIZE_INVALID_CERT_AGE      | 未满14周岁的用户无法使用本产品，建议人工审核。（Z8110）|'."\n"
                .'| 400    | INITIALIZE_INVALID_CERT_NO      | 用户身份证号码信息无效，请填写正确的身份号码信息。（Z8111）|'."\n"
                .'| 500    | INVALID_INPUT_IMAGE      | 图片尺寸不合要求。（Z8125）|'."\n"
                .'| 500    | EXTRACT_FACE_FAIL | 活体图提取特征失败。（Z1156） |'."\n"
                .'| 500    | SYSTEM_ERROR      | 初始化策略结果获取失败。（Z1146）|'."\n"
                ."\n"
                .'## 安全声明'."\n"
                .'- 请确保上传的图片或文件来源符合相应的法律法规。'."\n"
                .'- 通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。'."\n"
                .'- 平台不存储用户在使用服务过程中涉及的原始人脸图片或文件信息。',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'facebody.cn-shanghai.aliyuncs.com',
        ],
    ],
];